---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_docdb_instance{% #aws_docdb_instance %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `auto_minor_version_upgrade`{% #auto_minor_version_upgrade %}

**Type**: `BOOLEAN`**Provider name**: `AutoMinorVersionUpgrade`**Description**: Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

## `availability_zone`{% #availability_zone %}

**Type**: `STRING`**Provider name**: `AvailabilityZone`**Description**: Specifies the name of the Availability Zone that the instance is located in.

## `backup_retention_period`{% #backup_retention_period %}

**Type**: `INT32`**Provider name**: `BackupRetentionPeriod`**Description**: Specifies the number of days for which automatic snapshots are retained.

## `ca_certificate_identifier`{% #ca_certificate_identifier %}

**Type**: `STRING`**Provider name**: `CACertificateIdentifier`**Description**: The identifier of the CA certificate for this DB instance.

## `certificate_details`{% #certificate_details %}

**Type**: `STRUCT`**Provider name**: `CertificateDetails`**Description**: The details of the DB instance's server certificate.

- `ca_identifier`**Type**: `STRING`**Provider name**: `CAIdentifier`**Description**: The CA identifier of the CA certificate used for the DB instance's server certificate.
- `valid_till`**Type**: `TIMESTAMP`**Provider name**: `ValidTill`**Description**: The expiration date of the DB instance's server certificate.

## `copy_tags_to_snapshot`{% #copy_tags_to_snapshot %}

**Type**: `BOOLEAN`**Provider name**: `CopyTagsToSnapshot`**Description**: A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

## `db_cluster_identifier`{% #db_cluster_identifier %}

**Type**: `STRING`**Provider name**: `DBClusterIdentifier`**Description**: Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

## `db_instance_arn`{% #db_instance_arn %}

**Type**: `STRING`**Provider name**: `DBInstanceArn`**Description**: The Amazon Resource Name (ARN) for the instance.

## `db_instance_class`{% #db_instance_class %}

**Type**: `STRING`**Provider name**: `DBInstanceClass`**Description**: Contains the name of the compute and memory capacity class of the instance.

## `db_instance_identifier`{% #db_instance_identifier %}

**Type**: `STRING`**Provider name**: `DBInstanceIdentifier`**Description**: Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

## `db_instance_status`{% #db_instance_status %}

**Type**: `STRING`**Provider name**: `DBInstanceStatus`**Description**: Specifies the current state of this database.

## `db_subnet_group`{% #db_subnet_group %}

**Type**: `STRUCT`**Provider name**: `DBSubnetGroup`**Description**: Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

- `db_subnet_group_arn`**Type**: `STRING`**Provider name**: `DBSubnetGroupArn`**Description**: The Amazon Resource Name (ARN) for the DB subnet group.
- `db_subnet_group_description`**Type**: `STRING`**Provider name**: `DBSubnetGroupDescription`**Description**: Provides the description of the subnet group.
- `db_subnet_group_name`**Type**: `STRING`**Provider name**: `DBSubnetGroupName`**Description**: The name of the subnet group.
- `subnet_group_status`**Type**: `STRING`**Provider name**: `SubnetGroupStatus`**Description**: Provides the status of the subnet group.
- `subnets`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Subnets`**Description**: Detailed information about one or more subnets within a subnet group.
  - `subnet_availability_zone`**Type**: `STRUCT`**Provider name**: `SubnetAvailabilityZone`**Description**: Specifies the Availability Zone for the subnet.
    - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the Availability Zone.
  - `subnet_identifier`**Type**: `STRING`**Provider name**: `SubnetIdentifier`**Description**: Specifies the identifier of the subnet.
  - `subnet_status`**Type**: `STRING`**Provider name**: `SubnetStatus`**Description**: Specifies the status of the subnet.
- `vpc_id`**Type**: `STRING`**Provider name**: `VpcId`**Description**: Provides the virtual private cloud (VPC) ID of the subnet group.

## `dbi_resource_id`{% #dbi_resource_id %}

**Type**: `STRING`**Provider name**: `DbiResourceId`**Description**: The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

## `enabled_cloudwatch_logs_exports`{% #enabled_cloudwatch_logs_exports %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `EnabledCloudwatchLogsExports`**Description**: A list of log types that this instance is configured to export to CloudWatch Logs.

## `endpoint`{% #endpoint %}

**Type**: `STRUCT`**Provider name**: `Endpoint`**Description**: Specifies the connection endpoint.

- `address`**Type**: `STRING`**Provider name**: `Address`**Description**: Specifies the DNS address of the instance.
- `hosted_zone_id`**Type**: `STRING`**Provider name**: `HostedZoneId`**Description**: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Specifies the port that the database engine is listening on.

## `engine`{% #engine %}

**Type**: `STRING`**Provider name**: `Engine`**Description**: Provides the name of the database engine to be used for this instance.

## `engine_version`{% #engine_version %}

**Type**: `STRING`**Provider name**: `EngineVersion`**Description**: Indicates the database engine version.

## `instance_create_time`{% #instance_create_time %}

**Type**: `TIMESTAMP`**Provider name**: `InstanceCreateTime`**Description**: Provides the date and time that the instance was created.

## `kms_key_id`{% #kms_key_id %}

**Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted instance.

## `latest_restorable_time`{% #latest_restorable_time %}

**Type**: `TIMESTAMP`**Provider name**: `LatestRestorableTime`**Description**: Specifies the latest time to which a database can be restored with point-in-time restore.

## `pending_modified_values`{% #pending_modified_values %}

**Type**: `STRUCT`**Provider name**: `PendingModifiedValues`**Description**: Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

- `allocated_storage`**Type**: `INT32`**Provider name**: `AllocatedStorage`**Description**: Contains the new `AllocatedStorage` size for then instance that will be applied or is currently being applied.
- `backup_retention_period`**Type**: `INT32`**Provider name**: `BackupRetentionPeriod`**Description**: Specifies the pending number of days for which automated backups are retained.
- `ca_certificate_identifier`**Type**: `STRING`**Provider name**: `CACertificateIdentifier`**Description**: Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
- `db_instance_class`**Type**: `STRING`**Provider name**: `DBInstanceClass`**Description**: Contains the new `DBInstanceClass` for the instance that will be applied or is currently being applied.
- `db_instance_identifier`**Type**: `STRING`**Provider name**: `DBInstanceIdentifier`**Description**: Contains the new `DBInstanceIdentifier` for the instance that will be applied or is currently being applied.
- `db_subnet_group_name`**Type**: `STRING`**Provider name**: `DBSubnetGroupName`**Description**: The new subnet group for the instance.
- `engine_version`**Type**: `STRING`**Provider name**: `EngineVersion`**Description**: Indicates the database engine version.
- `iops`**Type**: `INT32`**Provider name**: `Iops`**Description**: Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
- `license_model`**Type**: `STRING`**Provider name**: `LicenseModel`**Description**: The license model for the instance. Valid values: `license-included`, `bring-your-own-license`, `general-public-license`
- `master_user_password`**Type**: `STRING`**Provider name**: `MasterUserPassword`**Description**: Contains the pending or currently in-progress change of the master credentials for the instance.
- `multi_az`**Type**: `BOOLEAN`**Provider name**: `MultiAZ`**Description**: Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
- `pending_cloudwatch_logs_exports`**Type**: `STRUCT`**Provider name**: `PendingCloudwatchLogsExports`**Description**: A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
  - `log_types_to_disable`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `LogTypesToDisable`**Description**: Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
  - `log_types_to_enable`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `LogTypesToEnable`**Description**: Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
- `port`**Type**: `INT32`**Provider name**: `Port`**Description**: Specifies the pending port for the instance.
- `storage_type`**Type**: `STRING`**Provider name**: `StorageType`**Description**: Specifies the storage type to be associated with the instance.

## `performance_insights_enabled`{% #performance_insights_enabled %}

**Type**: `BOOLEAN`**Provider name**: `PerformanceInsightsEnabled`**Description**: Set to `true` if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise `false`.

## `performance_insights_kms_key_id`{% #performance_insights_kms_key_id %}

**Type**: `STRING`**Provider name**: `PerformanceInsightsKMSKeyId`**Description**: The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

## `preferred_backup_window`{% #preferred_backup_window %}

**Type**: `STRING`**Provider name**: `PreferredBackupWindow`**Description**: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.

## `preferred_maintenance_window`{% #preferred_maintenance_window %}

**Type**: `STRING`**Provider name**: `PreferredMaintenanceWindow`**Description**: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

## `promotion_tier`{% #promotion_tier %}

**Type**: `INT32`**Provider name**: `PromotionTier`**Description**: A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

## `publicly_accessible`{% #publicly_accessible %}

**Type**: `BOOLEAN`**Provider name**: `PubliclyAccessible`**Description**: Not supported. Amazon DocumentDB does not currently support public endpoints. The value of `PubliclyAccessible` is always `false`.

## `status_infos`{% #status_infos %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `StatusInfos`**Description**: The status of a read replica. If the instance is not a read replica, this is blank.

- `message`**Type**: `STRING`**Provider name**: `Message`**Description**: Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
- `normal`**Type**: `BOOLEAN`**Provider name**: `Normal`**Description**: A Boolean value that is `true` if the instance is operating normally, or `false` if the instance is in an error state.
- `status`**Type**: `STRING`**Provider name**: `Status`**Description**: Status of the instance. For a `StatusType` of read replica, the values can be `replicating`, error, `stopped`, or `terminated`.
- `status_type`**Type**: `STRING`**Provider name**: `StatusType`**Description**: This value is currently "`read replication`."

## `storage_encrypted`{% #storage_encrypted %}

**Type**: `BOOLEAN`**Provider name**: `StorageEncrypted`**Description**: Specifies whether or not the instance is encrypted.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `vpc_security_groups`{% #vpc_security_groups %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `VpcSecurityGroups`**Description**: Provides a list of VPC security group elements that the instance belongs to.

- `status`**Type**: `STRING`**Provider name**: `Status`**Description**: The status of the VPC security group.
- `vpc_security_group_id`**Type**: `STRING`**Provider name**: `VpcSecurityGroupId`**Description**: The name of the VPC security group.