Class: Aws::RDS::Types::DBCluster

Inherits:

Struct

Object
Struct
Aws::RDS::Types::DBCluster

show all

Defined in:: gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

The Multi-AZ DB clusters feature is in preview and is subject to change.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#activity_stream_kinesis_stream_name ⇒ String
The name of the Amazon Kinesis data stream used for the database activity stream.
#activity_stream_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
#activity_stream_mode ⇒ String
The mode of the database activity stream.
#activity_stream_status ⇒ String
The status of the database activity stream.
#allocated_storage ⇒ Integer
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB).
#associated_roles ⇒ Array<Types::DBClusterRole>
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.
#auto_minor_version_upgrade ⇒ Boolean
A value that indicates that minor version patches are applied automatically.
#automatic_restart_time ⇒ Time
The time when a stopped DB cluster is restarted automatically.
#availability_zones ⇒ Array<String>
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
#backtrack_consumed_change_records ⇒ Integer
The number of change records stored for Backtrack.
#backtrack_window ⇒ Integer
The target backtrack window, in seconds.
#backup_retention_period ⇒ Integer
Specifies the number of days for which automatic DB snapshots are retained.
#capacity ⇒ Integer
The current capacity of an Aurora Serverless DB cluster.
#character_set_name ⇒ String
If present, specifies the name of the character set that this cluster is associated with.
#clone_group_id ⇒ String
Identifies the clone group to which the DB cluster is associated.
#cluster_create_time ⇒ Time
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
#copy_tags_to_snapshot ⇒ Boolean
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
#cross_account_clone ⇒ Boolean
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
#custom_endpoints ⇒ Array<String>
Identifies all custom endpoints associated with the cluster.
#database_name ⇒ String
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.
#db_cluster_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster.
#db_cluster_identifier ⇒ String
Contains a user-supplied DB cluster identifier.
#db_cluster_instance_class ⇒ String
The name of the compute and memory capacity class of the DB instance.
#db_cluster_members ⇒ Array<Types::DBClusterMember>
Provides the list of instances that make up the DB cluster.
#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>
Provides the list of option group memberships for this DB cluster.
#db_cluster_parameter_group ⇒ String
Specifies the name of the DB cluster parameter group for the DB cluster.
#db_cluster_resource_id ⇒ String
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
#db_subnet_group ⇒ String
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
#deletion_protection ⇒ Boolean
Indicates if the DB cluster has deletion protection enabled.
#domain_memberships ⇒ Array<Types::DomainMembership>
The Active Directory Domain membership records associated with the DB cluster.
#earliest_backtrack_time ⇒ Time
The earliest time to which a DB cluster can be backtracked.
#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 DB cluster is configured to export to CloudWatch Logs.
#endpoint ⇒ String
Specifies the connection endpoint for the primary instance of the DB cluster.
#engine ⇒ String
The name of the database engine to be used for this DB cluster.
#engine_mode ⇒ String
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
#engine_version ⇒ String
Indicates the database engine version.
#global_write_forwarding_requested ⇒ Boolean
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database.
#global_write_forwarding_status ⇒ String
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
#hosted_zone_id ⇒ String
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
#http_endpoint_enabled ⇒ Boolean
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
#iam_database_authentication_enabled ⇒ Boolean
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
#iops ⇒ Integer
The Provisioned IOPS (I/O operations per second) value.
#kms_key_id ⇒ String
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB 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 username for the DB cluster.
#monitoring_interval ⇒ Integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
#monitoring_role_arn ⇒ String
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
#multi_az ⇒ Boolean
Specifies whether the DB cluster has instances in multiple Availability Zones.
#pending_modified_values ⇒ Types::ClusterPendingModifiedValues
A value that specifies that changes to the DB cluster are pending.
#percent_progress ⇒ String
Specifies the progress of the operation as a percentage.
#performance_insights_enabled ⇒ Boolean
True if Performance Insights is enabled for the DB cluster, and otherwise false.
#performance_insights_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
#performance_insights_retention_period ⇒ Integer
The amount of time, in days, to retain Performance Insights data.
#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).
#publicly_accessible ⇒ Boolean
Specifies the accessibility options for the DB instance.
#read_replica_identifiers ⇒ Array<String>
Contains one or more identifiers of the read replicas associated with this DB cluster.
#reader_endpoint ⇒ String
The reader endpoint for the DB cluster.
#replication_source_identifier ⇒ String
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
#status ⇒ String
Specifies the current state of this DB cluster.
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
#storage_type ⇒ String
The storage type associated with DB instance.
#tag_list ⇒ Array<Types::Tag>
A list of tags.
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>
Provides a list of VPC security groups that the DB cluster belongs to.

Instance Attribute Details

#activity_stream_kinesis_stream_name ⇒ `String`

The name of the Amazon Kinesis data stream used for the database activity stream.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_mode ⇒ `String`

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_status ⇒ `String`

The status of the database activity stream.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#allocated_storage ⇒ `Integer`

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

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

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Returns:

(Array<Types::DBClusterRole>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

A value that indicates that minor version patches are applied automatically.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_restart_time ⇒ `Time`

The time when a stopped DB cluster is restarted automatically.

Returns:

(Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zones ⇒ `Array<String>`

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_consumed_change_records ⇒ `Integer`

The number of change records stored for Backtrack.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_window ⇒ `Integer`

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

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

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#capacity ⇒ `Integer`

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_name ⇒ `String`

If present, specifies the name of the character set that this cluster is associated with.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#clone_group_id ⇒ `String`

Identifies the clone group to which the DB cluster is associated.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_time ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#cross_account_clone ⇒ `Boolean`

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#custom_endpoints ⇒ `Array<String>`

Identifies all custom endpoints associated with the cluster.

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ `String`

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_arn ⇒ `String`

The Amazon Resource Name (ARN) for the DB cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_instance_class ⇒ `String`

The name of the compute and memory capacity class of the DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

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

Provides the list of instances that make up the DB cluster.

Returns:

(Array<Types::DBClusterMember>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_option_group_memberships ⇒ `Array<Types::DBClusterOptionGroupStatus>`

Provides the list of option group memberships for this DB cluster.

Returns:

(Array<Types::DBClusterOptionGroupStatus>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_id ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#domain_memberships ⇒ `Array<Types::DomainMembership>`

The Active Directory Domain membership records associated with the DB cluster.

Returns:

(Array<Types::DomainMembership>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#earliest_backtrack_time ⇒ `Time`

The earliest time to which a DB cluster can be backtracked.

Returns:

(Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

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

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ `String`

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

Indicates the database engine version.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#global_write_forwarding_requested ⇒ `Boolean`

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#global_write_forwarding_status ⇒ `String`

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#http_endpoint_enabled ⇒ `Boolean`

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ `Boolean`

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ `Integer`

The Provisioned IOPS (I/O operations per second) value.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

Contains the master username for the DB cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_interval ⇒ `Integer`

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arn ⇒ `String`

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Specifies whether the DB cluster has instances in multiple Availability Zones.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_values ⇒ `Types::ClusterPendingModifiedValues`

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns:

(Types::ClusterPendingModifiedValues)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ `String`

Specifies the progress of the operation as a percentage.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_enabled ⇒ `Boolean`

True if Performance Insights is enabled for the DB cluster, and otherwise false.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_period ⇒ `Integer`

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

Specifies the port that the database engine is listening on.

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  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 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_identifiers ⇒ `Array<String>`

Contains one or more identifiers of the read replicas associated with this DB cluster.

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpoint ⇒ `String`

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#replication_source_identifier ⇒ `String`

Contains the identifier of the source DB cluster if this DB cluster is a read replica.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration_info ⇒ `Types::ScalingConfigurationInfo`

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Returns:

(Types::ScalingConfigurationInfo)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

Specifies the current state of this DB cluster.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the DB cluster is encrypted.

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type associated with DB instance.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

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

Provides a list of VPC security groups that the DB cluster belongs to.

Returns:

(Array<Types::VpcSecurityGroupMembership>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6176

class DBCluster < Struct.new(
  :allocated_storage,
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group,
  :db_subnet_group,
  :status,
  :automatic_restart_time,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :custom_endpoints,
  :multi_az,
  :engine,
  :engine_version,
  :latest_restorable_time,
  :port,
  :master_username,
  :db_cluster_option_group_memberships,
  :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,
  :iam_database_authentication_enabled,
  :clone_group_id,
  :cluster_create_time,
  :earliest_backtrack_time,
  :backtrack_window,
  :backtrack_consumed_change_records,
  :enabled_cloudwatch_logs_exports,
  :capacity,
  :engine_mode,
  :scaling_configuration_info,
  :deletion_protection,
  :http_endpoint_enabled,
  :activity_stream_mode,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :copy_tags_to_snapshot,
  :cross_account_clone,
  :domain_memberships,
  :tag_list,
  :global_write_forwarding_status,
  :global_write_forwarding_requested,
  :pending_modified_values,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :monitoring_interval,
  :monitoring_role_arn,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::DBCluster

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#activity_stream_kinesis_stream_name ⇒ String

#activity_stream_kms_key_id ⇒ String

#activity_stream_mode ⇒ String

#activity_stream_status ⇒ String

#allocated_storage ⇒ Integer

#associated_roles ⇒ Array<Types::DBClusterRole>

#auto_minor_version_upgrade ⇒ Boolean

#automatic_restart_time ⇒ Time

#availability_zones ⇒ Array<String>

#backtrack_consumed_change_records ⇒ Integer

#backtrack_window ⇒ Integer

#backup_retention_period ⇒ Integer

#capacity ⇒ Integer

#character_set_name ⇒ String

#clone_group_id ⇒ String

#cluster_create_time ⇒ Time

#copy_tags_to_snapshot ⇒ Boolean

#cross_account_clone ⇒ Boolean

#custom_endpoints ⇒ Array<String>

#database_name ⇒ String

#db_cluster_arn ⇒ String

#db_cluster_identifier ⇒ String

#db_cluster_instance_class ⇒ String

#db_cluster_members ⇒ Array<Types::DBClusterMember>

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

#db_cluster_parameter_group ⇒ String

#db_cluster_resource_id ⇒ String

#db_subnet_group ⇒ String

#deletion_protection ⇒ Boolean

#domain_memberships ⇒ Array<Types::DomainMembership>

#earliest_backtrack_time ⇒ Time

#earliest_restorable_time ⇒ Time

#enabled_cloudwatch_logs_exports ⇒ Array<String>

#endpoint ⇒ String

#engine ⇒ String

#engine_mode ⇒ String

#engine_version ⇒ String

#global_write_forwarding_requested ⇒ Boolean

#global_write_forwarding_status ⇒ String

#hosted_zone_id ⇒ String

#http_endpoint_enabled ⇒ Boolean

#iam_database_authentication_enabled ⇒ Boolean

#iops ⇒ Integer

#kms_key_id ⇒ String

#latest_restorable_time ⇒ Time

#master_username ⇒ String

#monitoring_interval ⇒ Integer

#monitoring_role_arn ⇒ String

#multi_az ⇒ Boolean

#pending_modified_values ⇒ Types::ClusterPendingModifiedValues

#percent_progress ⇒ String

#performance_insights_enabled ⇒ Boolean

#performance_insights_kms_key_id ⇒ String

#performance_insights_retention_period ⇒ Integer

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#publicly_accessible ⇒ Boolean

#read_replica_identifiers ⇒ Array<String>

#reader_endpoint ⇒ String

#replication_source_identifier ⇒ String

#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo

#status ⇒ String

#storage_encrypted ⇒ Boolean

#storage_type ⇒ String

#tag_list ⇒ Array<Types::Tag>

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

#activity_stream_kinesis_stream_name ⇒ `String`

#activity_stream_kms_key_id ⇒ `String`

#activity_stream_mode ⇒ `String`

#activity_stream_status ⇒ `String`

#allocated_storage ⇒ `Integer`

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

#auto_minor_version_upgrade ⇒ `Boolean`

#automatic_restart_time ⇒ `Time`

#availability_zones ⇒ `Array<String>`

#backtrack_consumed_change_records ⇒ `Integer`

#backtrack_window ⇒ `Integer`

#backup_retention_period ⇒ `Integer`

#capacity ⇒ `Integer`

#character_set_name ⇒ `String`

#clone_group_id ⇒ `String`

#cluster_create_time ⇒ `Time`

#copy_tags_to_snapshot ⇒ `Boolean`

#cross_account_clone ⇒ `Boolean`

#custom_endpoints ⇒ `Array<String>`

#database_name ⇒ `String`

#db_cluster_arn ⇒ `String`

#db_cluster_identifier ⇒ `String`

#db_cluster_instance_class ⇒ `String`

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

#db_cluster_option_group_memberships ⇒ `Array<Types::DBClusterOptionGroupStatus>`

#db_cluster_parameter_group ⇒ `String`

#db_cluster_resource_id ⇒ `String`

#db_subnet_group ⇒ `String`

#deletion_protection ⇒ `Boolean`

#domain_memberships ⇒ `Array<Types::DomainMembership>`

#earliest_backtrack_time ⇒ `Time`

#earliest_restorable_time ⇒ `Time`

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

#endpoint ⇒ `String`

#engine ⇒ `String`

#engine_mode ⇒ `String`

#engine_version ⇒ `String`

#global_write_forwarding_requested ⇒ `Boolean`

#global_write_forwarding_status ⇒ `String`

#hosted_zone_id ⇒ `String`

#http_endpoint_enabled ⇒ `Boolean`

#iam_database_authentication_enabled ⇒ `Boolean`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#latest_restorable_time ⇒ `Time`

#master_username ⇒ `String`

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#multi_az ⇒ `Boolean`

#pending_modified_values ⇒ `Types::ClusterPendingModifiedValues`

#percent_progress ⇒ `String`

#performance_insights_enabled ⇒ `Boolean`

#performance_insights_kms_key_id ⇒ `String`

#performance_insights_retention_period ⇒ `Integer`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#publicly_accessible ⇒ `Boolean`

#read_replica_identifiers ⇒ `Array<String>`

#reader_endpoint ⇒ `String`

#replication_source_identifier ⇒ `String`

#scaling_configuration_info ⇒ `Types::ScalingConfigurationInfo`

#status ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#storage_type ⇒ `String`

#tag_list ⇒ `Array<Types::Tag>`

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