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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#activity_stream_kinesis_stream_nameString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_kms_key_idString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_modeString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_statusString

The status of the database activity stream.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#allocated_storageInteger

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#associated_rolesArray<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:



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

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

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_restart_timeTime

The time when a stopped DB cluster is restarted automatically.

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_consumed_change_recordsInteger

The number of change records stored for Backtrack.

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_windowInteger

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_periodInteger

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

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#capacityInteger

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

For more information about Aurora Serverless v1, see [Using Amazon Aurora Serverless v1] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_nameString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#clone_group_idString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_timeTime

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

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#cross_account_cloneBoolean

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#custom_endpointsArray<String>

Identifies all custom endpoints associated with the cluster.

Returns:

  • (Array<String>)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_arnString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifierString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_instance_classString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_membersArray<Types::DBClusterMember>

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

Returns:



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_option_group_membershipsArray<Types::DBClusterOptionGroupStatus>

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



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_groupString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_resource_idString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_groupString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#db_system_idString

Reserved for future use.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#domain_membershipsArray<Types::DomainMembership>

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

Returns:



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#earliest_backtrack_timeTime

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

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#earliest_restorable_timeTime

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

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exportsArray<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.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html

Returns:

  • (Array<String>)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#endpointString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#engine_modeString

The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.

For more information, see [ CreateDBCluster].

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#global_write_forwarding_requestedBoolean

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#global_write_forwarding_statusString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_idString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#http_endpoint_enabledBoolean

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

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 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 v1] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabledBoolean

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#io_optimized_next_allowed_modification_timeTime

The next time you can modify the DB cluster to use the ‘aurora-iopt1` storage type.

This setting is only for Aurora DB clusters.

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

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

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

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#latest_restorable_timeTime

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

Returns:

  • (Time)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_secretTypes::MasterUserSecret

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see [Password management with Amazon Web Services Secrets Manager] in the *Amazon RDS User Guide* and

Password management with Amazon Web Services Secrets Manager][2

in

the *Amazon Aurora User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#master_usernameString

Contains the master username for the DB cluster.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_intervalInteger

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arnString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azBoolean

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

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

The network type of the DB instance.

Valid values:

  • ‘IPV4`

  • ‘DUAL`

The network type is determined by the ‘DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon Aurora User Guide.*

This setting is only for Aurora DB clusters.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_valuesTypes::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.



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progressString

Specifies the progress of the operation as a percentage.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_enabledBoolean

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_idString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_periodInteger

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7

  • month * 31, where month is a number of months from 1-23

  • 731

For example, the following values are valid:

  • 93 (3 months * 31)

  • 341 (11 months * 31)

  • 589 (19 months * 31)

  • 731

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

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

Specifies the port that the database engine is listening on.

Returns:

  • (Integer)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_windowString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_identifiersArray<String>

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

Returns:

  • (Array<String>)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#reader_endpointString

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)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#replication_source_identifierString

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

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration_infoTypes::ScalingConfigurationInfo

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

For more information, see [Using Amazon Aurora Serverless v1] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configurationTypes::ServerlessV2ScalingConfigurationInfo

Shows the scaling configuration for an Aurora Serverless v2 DB cluster.

For more information, see [Using Amazon Aurora Serverless v2] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Specifies the current state of this DB cluster.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryptedBoolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

The storage type associated with the DB cluster.

Returns:

  • (String)


6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#tag_listArray<Types::Tag>

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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



6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
# File 'lib/aws-sdk-rds/types.rb', line 6331

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,
  :serverless_v2_scaling_configuration,
  :network_type,
  :db_system_id,
  :master_user_secret,
  :io_optimized_next_allowed_modification_time)
  SENSITIVE = []
  include Aws::Structure
end