aws_docdb_cluster

account_id

Type: STRING

associated_roles

Type: UNORDERED_LIST_STRUCT
Provider name: AssociatedRoles
Description: Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

• role_arn
  Type: STRING
  Provider name: RoleArn
  Description: The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
  
• status
  Type: STRING
  Provider name: Status
  Description: Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
  • PENDING - The IAMrole ARN is being associated with the cluster.
  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

availability_zones

Type: UNORDERED_LIST_STRING
Provider name: AvailabilityZones
Description: Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

backup_retention_period

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

clone_group_id

Type: STRING
Provider name: CloneGroupId
Description: Identifies the clone group to which the DB cluster is associated.

cluster_create_time

Type: TIMESTAMP
Provider name: ClusterCreateTime
Description: Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

db_cluster_arn

Type: STRING
Provider name: DBClusterArn
Description: The Amazon Resource Name (ARN) for the cluster.

db_cluster_identifier

Type: STRING
Provider name: DBClusterIdentifier
Description: Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

db_cluster_members

Type: UNORDERED_LIST_STRUCT
Provider name: DBClusterMembers
Description: Provides the list of instances that make up the cluster.

• db_cluster_parameter_group_status
  Type: STRING
  Provider name: DBClusterParameterGroupStatus
  Description: Specifies the status of the cluster parameter group for this member of the DB cluster.
  
• db_instance_identifier
  Type: STRING
  Provider name: DBInstanceIdentifier
  Description: Specifies the instance identifier for this member of the cluster.
  
• is_cluster_writer
  Type: BOOLEAN
  Provider name: IsClusterWriter
  Description: A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
  
• 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.
  

db_cluster_parameter_group

Type: STRING
Provider name: DBClusterParameterGroup
Description: Specifies the name of the cluster parameter group for the cluster.

db_cluster_resource_id

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

db_subnet_group

Type: STRING
Provider name: DBSubnetGroup
Description: Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

deletion_protection

Type: BOOLEAN
Provider name: DeletionProtection
Description: Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

earliest_restorable_time

Type: TIMESTAMP
Provider name: EarliestRestorableTime
Description: The earliest time to which a database can be restored with point-in-time restore.

enabled_cloudwatch_logs_exports

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

endpoint

Type: STRING
Provider name: Endpoint
Description: Specifies the connection endpoint for the primary instance of the cluster.

engine

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

engine_version

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

hosted_zone_id

Type: STRING
Provider name: HostedZoneId
Description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

kms_key_id

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

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.

master_username

Type: STRING
Provider name: MasterUsername
Description: Contains the master user name for the cluster.

multi_az

Type: BOOLEAN
Provider name: MultiAZ
Description: Specifies whether the cluster has instances in multiple Availability Zones.

percent_progress

Type: STRING
Provider name: PercentProgress
Description: Specifies the progress of the operation as a percentage.

port

Type: INT32
Provider name: Port
Description: Specifies the port that the database engine is listening on.

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

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

read_replica_identifiers

Type: UNORDERED_LIST_STRING
Provider name: ReadReplicaIdentifiers
Description: Contains one or more identifiers of the secondary clusters that are associated with this cluster.

reader_endpoint

Type: STRING
Provider name: ReaderEndpoint
Description: The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

replication_source_identifier

Type: STRING
Provider name: ReplicationSourceIdentifier
Description: Contains the identifier of the source cluster if this cluster is a secondary cluster.

status

Type: STRING
Provider name: Status
Description: Specifies the current state of this cluster.

storage_encrypted

Type: BOOLEAN
Provider name: StorageEncrypted
Description: Specifies whether the cluster is encrypted.

storage_type

Type: STRING
Provider name: StorageType
Description: Storage type associated with your cluster Storage type associated with your cluster For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide. Valid values for storage type - standard | iopt1 Default value is standard

tags

Type: UNORDERED_LIST_STRING

vpc_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: VpcSecurityGroups
Description: Provides a list of virtual private cloud (VPC) security groups that the cluster 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.