Class: Aws::RDS::Types::DBCluster
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DBCluster
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
Contains the result of a successful invocation of the following actions:
-
CreateDBCluster
-
DeleteDBCluster
-
FailoverDBCluster
-
ModifyDBCluster
-
RestoreDBClusterFromSnapshot
-
RestoreDBClusterToPointInTime
This data type is used as a response element in the DescribeDBClusters action.
Instance Attribute Summary collapse
-
#allocated_storage ⇒ Integer
For all database engines except Amazon Aurora, ‘AllocatedStorage` specifies the allocated storage size in gigabytes (GB).
-
#associated_roles ⇒ Array<Types::DBClusterRole>
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
-
#availability_zones ⇒ Array<String>
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
-
#backup_retention_period ⇒ Integer
Specifies the number of days for which automatic DB snapshots are retained.
-
#character_set_name ⇒ String
If present, specifies the name of the character set that this cluster is associated with.
-
#clone_group_id ⇒ String
Identifies the clone group to which the DB cluster is associated.
-
#cluster_create_time ⇒ Time
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
#database_name ⇒ String
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created.
-
#db_cluster_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster.
-
#db_cluster_identifier ⇒ String
Contains a user-supplied DB cluster identifier.
-
#db_cluster_members ⇒ Array<Types::DBClusterMember>
Provides the list of instances that make up the DB cluster.
-
#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>
Provides the list of option group memberships for this DB cluster.
-
#db_cluster_parameter_group ⇒ String
Specifies the name of the DB cluster parameter group for the DB cluster.
-
#db_cluster_resource_id ⇒ String
The region-unique, immutable identifier for the DB cluster.
-
#db_subnet_group ⇒ String
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
-
#earliest_restorable_time ⇒ Time
Specifies the earliest time to which a database can be restored with point-in-time restore.
-
#endpoint ⇒ String
Specifies the connection endpoint for the primary instance of the DB cluster.
-
#engine ⇒ String
Provides the name of the database engine to be used for this DB cluster.
-
#engine_version ⇒ String
Indicates the database engine version.
-
#hosted_zone_id ⇒ String
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
-
#iam_database_authentication_enabled ⇒ Boolean
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
-
#kms_key_id ⇒ String
If ‘StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.
-
#latest_restorable_time ⇒ Time
Specifies the latest time to which a database can be restored with point-in-time restore.
-
#master_username ⇒ String
Contains the master username for the DB cluster.
-
#multi_az ⇒ Boolean
Specifies whether the DB cluster has instances in multiple Availability Zones.
-
#percent_progress ⇒ String
Specifies the progress of the operation as a percentage.
-
#port ⇒ Integer
Specifies the port that the database engine is listening on.
-
#preferred_backup_window ⇒ String
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
-
#preferred_maintenance_window ⇒ String
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
#read_replica_identifiers ⇒ Array<String>
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
-
#reader_endpoint ⇒ String
The reader endpoint for the DB cluster.
-
#replication_source_identifier ⇒ String
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
-
#status ⇒ String
Specifies the current state of this DB cluster.
-
#storage_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
-
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>
Provides a list of VPC security groups that the DB cluster belongs to.
Instance Attribute Details
#allocated_storage ⇒ Integer
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.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_roles ⇒ Array<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.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_zones ⇒ Array<String>
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_period ⇒ Integer
Specifies the number of days for which automatic DB snapshots are retained.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_name ⇒ String
If present, specifies the name of the character set that this cluster is associated with.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_id ⇒ String
Identifies the clone group to which the DB cluster is associated.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_time ⇒ Time
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_name ⇒ String
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_identifier ⇒ String
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_members ⇒ Array<Types::DBClusterMember>
Provides the list of instances that make up the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>
Provides the list of option group memberships for this DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_group ⇒ String
Specifies the name of the DB cluster parameter group for the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_id ⇒ String
The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_group ⇒ String
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_time ⇒ Time
Specifies the earliest time to which a database can be restored with point-in-time restore.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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 |
#endpoint ⇒ String
Specifies the connection endpoint for the primary instance of the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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 ⇒ String
Provides the name of the database engine to be used for this DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_version ⇒ String
Indicates the database engine version.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_id ⇒ String
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_enabled ⇒ Boolean
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_id ⇒ String
If ‘StorageEncrypted` is true, the KMS key identifier for the encrypted DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_time ⇒ Time
Specifies the latest time to which a database can be restored with point-in-time restore.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_username ⇒ String
Contains the master username for the DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_az ⇒ Boolean
Specifies whether the DB cluster has instances in multiple Availability Zones.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_progress ⇒ String
Specifies the progress of the operation as a percentage.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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 |
#port ⇒ Integer
Specifies the port that the database engine is listening on.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_window ⇒ String
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_window ⇒ String
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_identifiers ⇒ Array<String>
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_endpoint ⇒ String
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_identifier ⇒ String
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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 |
#status ⇒ String
Specifies the current state of this DB cluster.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_encrypted ⇒ Boolean
Specifies whether the DB cluster is encrypted.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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_groups ⇒ Array<Types::VpcSecurityGroupMembership>
Provides a list of VPC security groups that the DB cluster belongs to.
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 |
# File 'lib/aws-sdk-rds/types.rb', line 3584 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 |