You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Contains the details of an Amazon RDS DB cluster.

This data type is used as a response element in the DescribeDBClusters action.

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Returns:

  • (Integer)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#associated_rolesArray<Types::DBClusterRole>

Provides a list of the AWS 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 AWS services on your behalf.

Returns:



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#backup_retention_periodInteger

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

Returns:

  • (Integer)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#character_set_nameString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#clone_group_idString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#cluster_create_timeTime

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

Returns:

  • (Time)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#db_cluster_arnString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#db_cluster_membersArray<Types::DBClusterMember>

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

Returns:



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#db_cluster_option_group_membershipsArray<Types::DBClusterOptionGroupStatus>

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



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#db_cluster_parameter_groupString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#db_cluster_resource_idString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#earliest_restorable_timeTime

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

Returns:

  • (Time)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#endpointString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#hosted_zone_idString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#iam_database_authentication_enabledBoolean

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (Boolean)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#master_usernameString

Contains the master username for the DB cluster.

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#multi_azBoolean

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

Returns:

  • (Boolean)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#percent_progressString

Specifies the progress of the operation as a percentage.

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#portInteger

Specifies the port that the database engine is listening on.

Returns:

  • (Integer)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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>)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  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)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#statusString

Specifies the current state of this DB cluster.

Returns:

  • (String)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#storage_encryptedBoolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean)


3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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



3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 3598

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,
  :percent_progress,
  :earliest_restorable_time,
  :endpoint,
  :reader_endpoint,
  :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)
  include Aws::Structure
end