class Aws::DocDB::Types::DBCluster

@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBCluster AWS API Documentation
@return [String]
Default value is ‘standard `
Valid values for storage type - `standard | iopt1`
Guide*.
Cluster storage configurations in the *Amazon DocumentDB Developer
For information on storage types for Amazon DocumentDB clusters, see
Storage type associated with your cluster
Storage type associated with your cluster
@!attribute [rw] storage_type
@return [Boolean]
deleted.
`DeletionProtection` protects clusters from being accidentally
unless it is modified and `DeletionProtection` is disabled.
`DeletionProtection` is enabled, the cluster cannot be deleted
Specifies whether this cluster can be deleted. If
@!attribute [rw] deletion_protection
@return [Array<String>]
Amazon CloudWatch Logs.
A list of log types that this cluster is configured to export to
@!attribute [rw] enabled_cloudwatch_logs_exports
@return [Time]
Coordinated Time (UTC).
Specifies the time when the cluster was created, in Universal
@!attribute [rw] cluster_create_time
@return [String]
Identifies the clone group to which the DB cluster is associated.
@!attribute [rw] clone_group_id
@return [Array<Types::DBClusterRole>]
other Amazon Web Services services on your behalf.
associated with a cluster grant permission for the cluster to access
that are associated with the cluster. (IAM) roles that are
Provides a list of the Identity and Access Management (IAM) roles
@!attribute [rw] associated_roles
@return [String]
The Amazon Resource Name (ARN) for the cluster.
@!attribute [rw] db_cluster_arn
@return [String]
the KMS key for the cluster is accessed.
cluster. This identifier is found in CloudTrail log entries whenever
The Amazon Web Services Region-unique, immutable identifier for the
@!attribute [rw] db_cluster_resource_id
@return [String]
encrypted cluster.
If `StorageEncrypted` is `true`, the KMS key identifier for the
@!attribute [rw] kms_key_id
@return [Boolean]
Specifies whether the cluster is encrypted.
@!attribute [rw] storage_encrypted
@return [String]
hosted zone.
Specifies the ID that Amazon Route 53 assigns when you create a
@!attribute [rw] hosted_zone_id
@return [Array<Types::VpcSecurityGroupMembership>]
the cluster belongs to.
Provides a list of virtual private cloud (VPC) security groups that
@!attribute [rw] vpc_security_groups
@return [Array<Types::DBClusterMember>]
Provides the list of instances that make up the cluster.
@!attribute [rw] db_cluster_members
@return [Array<String>]
associated with this cluster.
Contains one or more identifiers of the secondary clusters that are
@!attribute [rw] read_replica_identifiers
@return [String]
secondary cluster.
Contains the identifier of the source cluster if this cluster is a
@!attribute [rw] replication_source_identifier
@return [String]
occur, in Universal Coordinated Time (UTC).
Specifies the weekly time range during which system maintenance can
@!attribute [rw] preferred_maintenance_window
@return [String]
`BackupRetentionPeriod`.
created if automated backups are enabled, as determined by the
Specifies the daily time range during which automated backups are
@!attribute [rw] preferred_backup_window
@return [String]
Contains the master user name for the cluster.
@!attribute [rw] master_username
@return [Integer]
Specifies the port that the database engine is listening on.
@!attribute [rw] port
@return [Time]
point-in-time restore.
Specifies the latest time to which a database can be restored with
@!attribute [rw] latest_restorable_time
@return [String]
Indicates the database engine version.
@!attribute [rw] engine_version
@return [String]
cluster.
Provides the name of the database engine to be used for this
@!attribute [rw] engine
@return [Boolean]
Zones.
Specifies whether the cluster has instances in multiple Availability
@!attribute [rw] multi_az
@return [String]
reader endpoint.
DocumentDB replicas in the cluster, you can then reconnect to the
is dropped. To continue sending your read workload to other Amazon
connected to is promoted to be the primary instance, your connection
If a failover occurs, and the Amazon DocumentDB replica that you are
across multiple Amazon DocumentDB replicas in your cluster.
cluster. This functionality can help balance your read workload
the connection requests among the Amazon DocumentDB replicas in the
connections to the reader endpoint, Amazon DocumentDB distributes
replicas that are available in a cluster. As clients request new
cluster load balances connections across the Amazon DocumentDB
The reader endpoint for the cluster. The reader endpoint for a
@!attribute [rw] reader_endpoint
@return [String]
cluster.
Specifies the connection endpoint for the primary instance of the
@!attribute [rw] endpoint
@return [Time]
point-in-time restore.
The earliest time to which a database can be restored with
@!attribute [rw] earliest_restorable_time
@return [String]
Specifies the progress of the operation as a percentage.
@!attribute [rw] percent_progress
@return [String]
Specifies the current state of this cluster.
@!attribute [rw] status
@return [String]
subnet group.
the cluster, including the name, description, and subnets in the
Specifies information on the subnet group that is associated with
@!attribute [rw] db_subnet_group
@return [String]
Specifies the name of the cluster parameter group for the cluster.
@!attribute [rw] db_cluster_parameter_group
@return [String]
unique key that identifies a cluster.
Contains a user-supplied cluster identifier. This identifier is the
@!attribute [rw] db_cluster_identifier
@return [Integer]
retained.
Specifies the number of days for which automatic snapshots are
@!attribute [rw] backup_retention_period
@return [Array<String>]
the cluster can be created in.
Provides the list of Amazon EC2 Availability Zones that instances in
@!attribute [rw] availability_zones
Detailed information about a cluster.