Class: Aws::DocDB::Types::DBCluster

Inherits:

Struct

Object
Struct
Aws::DocDB::Types::DBCluster

show all

Includes:: Structure

Defined in:: lib/aws-sdk-docdb/types.rb

Overview

Detailed information about a cluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#associated_roles ⇒ Array<Types::DBClusterRole>

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
#availability_zones ⇒ Array<String>

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
#backup_retention_period ⇒ Integer

Specifies the number of days for which automatic snapshots are retained.
#cluster_create_time ⇒ Time

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
#db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the cluster.
#db_cluster_identifier ⇒ String

Contains a user-supplied cluster identifier.
#db_cluster_members ⇒ Array<Types::DBClusterMember>

Provides the list of instances that make up the cluster.
#db_cluster_parameter_group ⇒ String

Specifies the name of the cluster parameter group for the cluster.
#db_cluster_resource_id ⇒ String

The Region-unique, immutable identifier for the cluster.
#db_subnet_group ⇒ String

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
#deletion_protection ⇒ Boolean

Specifies whether this cluster can be deleted.
#earliest_restorable_time ⇒ Time

The earliest time to which a database can be restored with point-in-time restore.
#enabled_cloudwatch_logs_exports ⇒ Array<String>

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
#endpoint ⇒ String

Specifies the connection endpoint for the primary instance of the cluster.
#engine ⇒ String

Provides the name of the database engine to be used for this cluster.
#engine_version ⇒ String

Indicates the database engine version.
#hosted_zone_id ⇒ String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
#kms_key_id ⇒ String

If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted cluster.
#latest_restorable_time ⇒ Time

Specifies the latest time to which a database can be restored with point-in-time restore.
#master_username ⇒ String

Contains the master user name for the cluster.
#multi_az ⇒ Boolean

Specifies whether the cluster has instances in multiple Availability Zones.
#percent_progress ⇒ String

Specifies the progress of the operation as a percentage.
#port ⇒ Integer

Specifies the port that the database engine is listening on.
#preferred_backup_window ⇒ String

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
#preferred_maintenance_window ⇒ String

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
#read_replica_identifiers ⇒ Array<String>

Contains one or more identifiers of the secondary clusters that are associated with this cluster.
#reader_endpoint ⇒ String

The reader endpoint for the cluster.
#replication_source_identifier ⇒ String

Contains the identifier of the source cluster if this cluster is a secondary cluster.
#status ⇒ String

Specifies the current state of this cluster.
#storage_encrypted ⇒ Boolean

Specifies whether the cluster is encrypted.
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Instance Attribute Details

#associated_roles ⇒ `Array<Types::DBClusterRole>`

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.

Returns:

(Array<Types::DBClusterRole>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ `Array<String>`

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

Specifies the number of days for which automatic snapshots are retained.

Returns:

(Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ `Time`

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

Returns:

(Time)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_arn ⇒ `String`

The Amazon Resource Name (ARN) for the cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_members ⇒ `Array<Types::DBClusterMember>`

Provides the list of instances that make up the cluster.

Returns:

(Array<Types::DBClusterMember>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group ⇒ `String`

Specifies the name of the cluster parameter group for the cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ `String`

The Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group ⇒ `String`

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#earliest_restorable_time ⇒ `Time`

The earliest time to which a database can be restored with point-in-time restore.

Returns:

(Time)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ `String`

Specifies the connection endpoint for the primary instance of the cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

Provides the name of the database engine to be used for this cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

Indicates the database engine version.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_id ⇒ `String`

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#latest_restorable_time ⇒ `Time`

Specifies the latest time to which a database can be restored with point-in-time restore.

Returns:

(Time)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

Contains the master user name for the cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Specifies whether the cluster has instances in multiple Availability Zones.

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ `String`

Specifies the progress of the operation as a percentage.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

Specifies the port that the database engine is listening on.

Returns:

(Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ `String`

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_identifiers ⇒ `Array<String>`

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpoint ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#replication_source_identifier ⇒ `String`

Contains the identifier of the source cluster if this cluster is a secondary cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

Specifies the current state of this cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the cluster is encrypted.

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groups ⇒ `Array<Types::VpcSecurityGroupMembership>`

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Returns:

(Array<Types::VpcSecurityGroupMembership>)

# File 'lib/aws-sdk-docdb/types.rb', line 1455

class DBCluster < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :replication_source_identifier,
  :read_replica_identifiers,
  :db_cluster_members,
  :vpc_security_groups,
  :hosted_zone_id,
  :storage_encrypted,
  :kms_key_id,
  :db_cluster_resource_id,
  :db_cluster_arn,
  :associated_roles,
  :cluster_create_time,
  :enabled_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DocDB::Types::DBCluster

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#associated_roles ⇒ Array<Types::DBClusterRole>

#availability_zones ⇒ Array<String>

#backup_retention_period ⇒ Integer

#cluster_create_time ⇒ Time

#db_cluster_arn ⇒ String

#db_cluster_identifier ⇒ String

#db_cluster_members ⇒ Array<Types::DBClusterMember>

#db_cluster_parameter_group ⇒ String

#db_cluster_resource_id ⇒ String

#db_subnet_group ⇒ String

#deletion_protection ⇒ Boolean

#earliest_restorable_time ⇒ Time

#enabled_cloudwatch_logs_exports ⇒ Array<String>

#endpoint ⇒ String

#engine ⇒ String

#engine_version ⇒ String

#hosted_zone_id ⇒ String

#kms_key_id ⇒ String

#latest_restorable_time ⇒ Time

#master_username ⇒ String

#multi_az ⇒ Boolean

#percent_progress ⇒ String

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#read_replica_identifiers ⇒ Array<String>

#reader_endpoint ⇒ String

#replication_source_identifier ⇒ String

#status ⇒ String

#storage_encrypted ⇒ Boolean

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

#associated_roles ⇒ `Array<Types::DBClusterRole>`

#availability_zones ⇒ `Array<String>`

#backup_retention_period ⇒ `Integer`

#cluster_create_time ⇒ `Time`

#db_cluster_arn ⇒ `String`

#db_cluster_identifier ⇒ `String`

#db_cluster_members ⇒ `Array<Types::DBClusterMember>`

#db_cluster_parameter_group ⇒ `String`

#db_cluster_resource_id ⇒ `String`

#db_subnet_group ⇒ `String`

#deletion_protection ⇒ `Boolean`

#earliest_restorable_time ⇒ `Time`

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

#endpoint ⇒ `String`

#engine ⇒ `String`

#engine_version ⇒ `String`

#hosted_zone_id ⇒ `String`

#kms_key_id ⇒ `String`

#latest_restorable_time ⇒ `Time`

#master_username ⇒ `String`

#multi_az ⇒ `Boolean`

#percent_progress ⇒ `String`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#read_replica_identifiers ⇒ `Array<String>`

#reader_endpoint ⇒ `String`

#replication_source_identifier ⇒ `String`

#status ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#vpc_security_groups ⇒ `Array<Types::VpcSecurityGroupMembership>`