Class: Aws::RDS::DBCluster
- Inherits:
-
Object
- Object
- Aws::RDS::DBCluster
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_cluster.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#activity_stream_kinesis_stream_name ⇒ String
The name of the Amazon Kinesis data stream used for the database activity stream.
-
#activity_stream_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
-
#activity_stream_mode ⇒ String
The mode of the database activity stream.
-
#activity_stream_status ⇒ String
The status of the database activity stream.
-
#allocated_storage ⇒ Integer
‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB).
-
#associated_roles ⇒ Array<Types::DBClusterRole>
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.
-
#auto_minor_version_upgrade ⇒ Boolean
Indicates whether minor version patches are applied automatically.
-
#automatic_restart_time ⇒ Time
The time when a stopped DB cluster is restarted automatically.
-
#availability_zones ⇒ Array<String>
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
-
#aws_backup_recovery_point_arn ⇒ String
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
-
#backtrack_consumed_change_records ⇒ Integer
The number of change records stored for Backtrack.
-
#backtrack_window ⇒ Integer
The target backtrack window, in seconds.
-
#backup_retention_period ⇒ Integer
The number of days for which automatic DB snapshots are retained.
-
#capacity ⇒ Integer
The current capacity of an Aurora Serverless v1 DB cluster.
-
#certificate_details ⇒ Types::CertificateDetails
The details of the DB instance’s server certificate.
-
#character_set_name ⇒ String
If present, specifies the name of the character set that this cluster is associated with.
-
#clone_group_id ⇒ String
The ID of the clone group with which the DB cluster is associated.
-
#cluster_create_time ⇒ Time
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
-
#cluster_scalability_type ⇒ String
The scalability mode of the Aurora DB cluster.
-
#copy_tags_to_snapshot ⇒ Boolean
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
-
#cross_account_clone ⇒ Boolean
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
-
#custom_endpoints ⇒ Array<String>
The custom endpoints associated with the DB cluster.
-
#database_insights_mode ⇒ String
The mode of Database Insights that is enabled for the DB cluster.
-
#database_name ⇒ String
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
-
#db_cluster_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster.
-
#db_cluster_instance_class ⇒ String
The name of the compute and memory capacity class of the DB instance.
-
#db_cluster_members ⇒ Array<Types::DBClusterMember>
The list of DB instances that make up the DB cluster.
-
#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>
The list of option group memberships for this DB cluster.
-
#db_cluster_parameter_group ⇒ String
The name of the DB cluster parameter group for the DB cluster.
-
#db_cluster_resource_id ⇒ String
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
-
#db_subnet_group ⇒ String
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
-
#db_system_id ⇒ String
Reserved for future use.
-
#deletion_protection ⇒ Boolean
Indicates whether the DB cluster has deletion protection enabled.
-
#domain_memberships ⇒ Array<Types::DomainMembership>
The Active Directory Domain membership records associated with the DB cluster.
-
#earliest_backtrack_time ⇒ Time
The earliest time to which a DB cluster can be backtracked.
-
#earliest_restorable_time ⇒ Time
The earliest time to which a database can be restored with point-in-time restore.
-
#enabled_cloudwatch_logs_exports ⇒ Array<String>
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
-
#endpoint ⇒ String
The connection endpoint for the primary instance of the DB cluster.
-
#engine ⇒ String
The database engine used for this DB cluster.
-
#engine_lifecycle_support ⇒ String
The life cycle type for the DB cluster.
-
#engine_mode ⇒ String
The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.
-
#engine_version ⇒ String
The version of the database engine.
-
#global_write_forwarding_requested ⇒ Boolean
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
-
#global_write_forwarding_status ⇒ String
The status of write forwarding for a secondary cluster in an Aurora global database.
-
#hosted_zone_id ⇒ String
The ID that Amazon Route 53 assigns when you create a hosted zone.
-
#http_endpoint_enabled ⇒ Boolean
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
-
#iam_database_authentication_enabled ⇒ Boolean
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
- #id ⇒ String (also: #db_cluster_identifier)
-
#io_optimized_next_allowed_modification_time ⇒ Time
The next time you can modify the DB cluster to use the ‘aurora-iopt1` storage type.
-
#iops ⇒ Integer
The Provisioned IOPS (I/O operations per second) value.
-
#kms_key_id ⇒ String
If ‘StorageEncrypted` is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
-
#latest_restorable_time ⇒ Time
The latest time to which a database can be restored with point-in-time restore.
-
#limitless_database ⇒ Types::LimitlessDatabase
The details for Aurora Limitless Database.
-
#local_write_forwarding_status ⇒ String
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
-
#master_user_secret ⇒ Types::MasterUserSecret
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
-
#master_username ⇒ String
The master username for the DB cluster.
-
#monitoring_interval ⇒ Integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
-
#monitoring_role_arn ⇒ String
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
-
#multi_az ⇒ Boolean
Indicates whether the DB cluster has instances in multiple Availability Zones.
-
#network_type ⇒ String
The network type of the DB instance.
-
#pending_modified_values ⇒ Types::ClusterPendingModifiedValues
Information about pending changes to the DB cluster.
-
#percent_progress ⇒ String
The progress of the operation as a percentage.
-
#performance_insights_enabled ⇒ Boolean
Indicates whether Performance Insights is enabled for the DB cluster.
-
#performance_insights_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
-
#performance_insights_retention_period ⇒ Integer
The number of days to retain Performance Insights data.
-
#port ⇒ Integer
The port that the database engine is listening on.
-
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
-
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
-
#publicly_accessible ⇒ Boolean
Indicates whether the DB cluster is publicly accessible.
-
#rds_custom_cluster_configuration ⇒ Types::RdsCustomClusterConfiguration
Reserved for future use.
-
#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
The identifier of the source DB cluster if this DB cluster is a read replica.
-
#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo
The scaling configuration for an Aurora DB cluster in ‘serverless` DB engine mode.
-
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfigurationInfo
The scaling configuration for an Aurora Serverless v2 DB cluster.
-
#status ⇒ String
The current state of this DB cluster.
-
#status_infos ⇒ Array<Types::DBClusterStatusInfo>
Reserved for future use.
-
#storage_encrypted ⇒ Boolean
Indicates whether the DB cluster is encrypted.
-
#storage_throughput ⇒ Integer
The storage throughput for the DB cluster.
-
#storage_type ⇒ String
The storage type associated with the DB cluster.
-
#tag_list ⇒ Array<Types::Tag>
A list of tags.
-
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>
The list of VPC security groups that the DB cluster belongs to.
Actions collapse
- #create(options = {}) ⇒ DBCluster
- #create_snapshot(options = {}) ⇒ DBClusterSnapshot
- #delete(options = {}) ⇒ DBCluster
- #failover(options = {}) ⇒ DBCluster
- #modify(options = {}) ⇒ DBCluster
- #restore(options = {}) ⇒ DBCluster
Associations collapse
- #events(options = {}) ⇒ Event::Collection
- #identifiers ⇒ Object deprecated private Deprecated.
- #members ⇒ DBInstance::Collection
- #option_groups ⇒ OptionGroup::Collection
- #parameter_group ⇒ DBClusterParameterGroup?
- #snapshots(options = {}) ⇒ DBClusterSnapshot::Collection
- #subnet_group ⇒ DBSubnetGroup?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBCluster
Returns the data for this DBCluster.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBCluster
constructor
A new instance of DBCluster.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ DBCluster #initialize(options = {}) ⇒ DBCluster
Returns a new instance of DBCluster.
22 23 24 25 26 27 28 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#activity_stream_kinesis_stream_name ⇒ String
The name of the Amazon Kinesis data stream used for the database activity stream.
443 444 445 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 443 def activity_stream_kinesis_stream_name data[:activity_stream_kinesis_stream_name] end |
#activity_stream_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
436 437 438 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 436 def activity_stream_kms_key_id data[:activity_stream_kms_key_id] end |
#activity_stream_mode ⇒ String
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
420 421 422 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 420 def activity_stream_mode data[:activity_stream_mode] end |
#activity_stream_status ⇒ String
The status of the database activity stream.
426 427 428 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 426 def activity_stream_status data[:activity_stream_status] end |
#allocated_storage ⇒ Integer
‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB). For Aurora, `AllocatedStorage` can vary because Aurora DB cluster storage size adjusts as needed.
42 43 44 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 42 def allocated_storage data[:allocated_storage] end |
#associated_roles ⇒ Array<Types::DBClusterRole>
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.
272 273 274 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 272 def associated_roles data[:associated_roles] end |
#auto_minor_version_upgrade ⇒ Boolean
Indicates whether minor version patches are applied automatically.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
556 557 558 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 556 def auto_minor_version_upgrade data[:auto_minor_version_upgrade] end |
#automatic_restart_time ⇒ Time
The time when a stopped DB cluster is restarted automatically.
95 96 97 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 95 def automatic_restart_time data[:automatic_restart_time] end |
#availability_zones ⇒ Array<String>
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
49 50 51 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 49 def availability_zones data[:availability_zones] end |
#aws_backup_recovery_point_arn ⇒ String
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
700 701 702 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 700 def aws_backup_recovery_point_arn data[:aws_backup_recovery_point_arn] end |
#backtrack_consumed_change_records ⇒ Integer
The number of change records stored for Backtrack.
323 324 325 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 323 def backtrack_consumed_change_records data[:backtrack_consumed_change_records] end |
#backtrack_window ⇒ Integer
The target backtrack window, in seconds. If this value is set to ‘0`, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
317 318 319 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 317 def backtrack_window data[:backtrack_window] end |
#backup_retention_period ⇒ Integer
The number of days for which automatic DB snapshots are retained.
55 56 57 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 55 def backup_retention_period data[:backup_retention_period] end |
#capacity ⇒ Integer
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
352 353 354 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 352 def capacity data[:capacity] end |
#certificate_details ⇒ Types::CertificateDetails
The details of the DB instance’s server certificate.
For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the *Amazon RDS User Guide* and [ Using SSL/TLS to encrypt a connection to a DB cluster] in the *Amazon Aurora User Guide*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
741 742 743 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 741 def certificate_details data[:certificate_details] end |
#character_set_name ⇒ String
If present, specifies the name of the character set that this cluster is associated with.
62 63 64 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 62 def character_set_name data[:character_set_name] end |
#client ⇒ Client
756 757 758 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 756 def client @client end |
#clone_group_id ⇒ String
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn’t inherited from the source cluster.
296 297 298 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 296 def clone_group_id data[:clone_group_id] end |
#cluster_create_time ⇒ Time
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
303 304 305 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 303 def cluster_create_time data[:cluster_create_time] end |
#cluster_scalability_type ⇒ String
The scalability mode of the Aurora DB cluster. When set to ‘limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation.
725 726 727 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 725 def cluster_scalability_type data[:cluster_scalability_type] end |
#copy_tags_to_snapshot ⇒ Boolean
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
450 451 452 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 450 def data[:copy_tags_to_snapshot] end |
#create(options = {}) ⇒ DBCluster
1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1814 def create( = {}) = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_db_cluster() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#create_snapshot(options = {}) ⇒ DBClusterSnapshot
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1854 def create_snapshot( = {}) = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.create_db_cluster_snapshot() end DBClusterSnapshot.new( cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier, snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier, data: resp.data.db_cluster_snapshot, client: @client ) end |
#cross_account_clone ⇒ Boolean
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
457 458 459 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 457 def cross_account_clone data[:cross_account_clone] end |
#custom_endpoints ⇒ Array<String>
The custom endpoints associated with the DB cluster.
136 137 138 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 136 def custom_endpoints data[:custom_endpoints] end |
#data ⇒ Types::DBCluster
Returns the data for this Aws::RDS::DBCluster. Calls Client#describe_db_clusters if #data_loaded? is ‘false`.
778 779 780 781 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 778 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
786 787 788 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 786 def data_loaded? !!@data end |
#database_insights_mode ⇒ String
The mode of Database Insights that is enabled for the DB cluster.
580 581 582 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 580 def database_insights_mode data[:database_insights_mode] end |
#database_name ⇒ String
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
70 71 72 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 70 def database_name data[:database_name] end |
#db_cluster_arn ⇒ String
The Amazon Resource Name (ARN) for the DB cluster.
263 264 265 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 263 def db_cluster_arn data[:db_cluster_arn] end |
#db_cluster_instance_class ⇒ String
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
512 513 514 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 512 def db_cluster_instance_class data[:db_cluster_instance_class] end |
#db_cluster_members ⇒ Array<Types::DBClusterMember>
The list of DB instances that make up the DB cluster.
221 222 223 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 221 def db_cluster_members data[:db_cluster_members] end |
#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>
The list of option group memberships for this DB cluster.
180 181 182 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 180 def db_cluster_option_group_memberships data[:db_cluster_option_group_memberships] end |
#db_cluster_parameter_group ⇒ String
The name of the DB cluster parameter group for the DB cluster.
76 77 78 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 76 def db_cluster_parameter_group data[:db_cluster_parameter_group] end |
#db_cluster_resource_id ⇒ String
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
257 258 259 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 257 def db_cluster_resource_id data[:db_cluster_resource_id] end |
#db_subnet_group ⇒ String
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
83 84 85 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 83 def db_subnet_group data[:db_subnet_group] end |
#db_system_id ⇒ String
Reserved for future use.
660 661 662 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 660 def db_system_id data[:db_system_id] end |
#delete(options = {}) ⇒ DBCluster
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1911 def delete( = {}) = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.delete_db_cluster() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#deletion_protection ⇒ Boolean
Indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.
392 393 394 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 392 def deletion_protection data[:deletion_protection] end |
#domain_memberships ⇒ Array<Types::DomainMembership>
The Active Directory Domain membership records associated with the DB cluster.
464 465 466 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 464 def domain_memberships data[:domain_memberships] end |
#earliest_backtrack_time ⇒ Time
The earliest time to which a DB cluster can be backtracked.
309 310 311 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 309 def earliest_backtrack_time data[:earliest_backtrack_time] end |
#earliest_restorable_time ⇒ Time
The earliest time to which a database can be restored with point-in-time restore.
108 109 110 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 108 def earliest_restorable_time data[:earliest_restorable_time] end |
#enabled_cloudwatch_logs_exports ⇒ Array<String>
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see [Amazon RDS Database Log Files] in the *Amazon Aurora User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html
338 339 340 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 338 def enabled_cloudwatch_logs_exports data[:enabled_cloudwatch_logs_exports] end |
#endpoint ⇒ String
The connection endpoint for the primary instance of the DB cluster.
114 115 116 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 114 def endpoint data[:endpoint] end |
#engine ⇒ String
The database engine used for this DB cluster.
149 150 151 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 149 def engine data[:engine] end |
#engine_lifecycle_support ⇒ String
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
749 750 751 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 749 def engine_lifecycle_support data[:engine_lifecycle_support] end |
#engine_mode ⇒ String
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
365 366 367 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 365 def engine_mode data[:engine_mode] end |
#engine_version ⇒ String
The version of the database engine.
155 156 157 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 155 def engine_version data[:engine_version] end |
#events(options = {}) ⇒ Event::Collection
3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3253 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-cluster", source_identifier: @id ) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_events() end resp.each_page do |page| batch = [] page.data.events.each do |e| batch << Event.new( source_id: e.source_identifier, date: e.date, data: e, client: @client ) end y.yield(batch) end end Event::Collection.new(batches) end |
#failover(options = {}) ⇒ DBCluster
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 1938 def failover( = {}) = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.failover_db_cluster() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#global_write_forwarding_requested ⇒ Boolean
Indicates whether write forwarding is enabled 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.
496 497 498 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 496 def global_write_forwarding_requested data[:global_write_forwarding_requested] end |
#global_write_forwarding_status ⇒ String
The status of write forwarding for a secondary cluster in an Aurora global database.
486 487 488 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 486 def global_write_forwarding_status data[:global_write_forwarding_status] end |
#hosted_zone_id ⇒ String
The ID that Amazon Route 53 assigns when you create a hosted zone.
233 234 235 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 233 def hosted_zone_id data[:hosted_zone_id] end |
#http_endpoint_enabled ⇒ Boolean
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see [Using RDS Data API] in the *Amazon Aurora User Guide*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
411 412 413 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 411 def http_endpoint_enabled data[:http_endpoint_enabled] end |
#iam_database_authentication_enabled ⇒ Boolean
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
279 280 281 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 279 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end |
#id ⇒ String Also known as: db_cluster_identifier
33 34 35 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 33 def id @id end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3440 3441 3442 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3440 def identifiers { id: @id } end |
#io_optimized_next_allowed_modification_time ⇒ Time
The next time you can modify the DB cluster to use the ‘aurora-iopt1` storage type.
This setting is only for Aurora DB clusters.
686 687 688 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 686 def io_optimized_next_allowed_modification_time data[:io_optimized_next_allowed_modification_time] end |
#iops ⇒ Integer
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
526 527 528 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 526 def iops data[:iops] end |
#kms_key_id ⇒ String
If ‘StorageEncrypted` is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
249 250 251 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 249 def kms_key_id data[:kms_key_id] end |
#latest_restorable_time ⇒ Time
The latest time to which a database can be restored with point-in-time restore.
162 163 164 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 162 def latest_restorable_time data[:latest_restorable_time] end |
#limitless_database ⇒ Types::LimitlessDatabase
The details for Aurora Limitless Database.
706 707 708 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 706 def limitless_database data[:limitless_database] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBCluster. Returns ‘self` making it possible to chain methods.
db_cluster.reload.data
766 767 768 769 770 771 772 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 766 def load resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_db_clusters(db_cluster_identifier: @id) end @data = resp.db_clusters[0] self end |
#local_write_forwarding_status ⇒ String
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
693 694 695 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 693 def local_write_forwarding_status data[:local_write_forwarding_status] end |
#master_user_secret ⇒ Types::MasterUserSecret
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
677 678 679 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 677 def master_user_secret data[:master_user_secret] end |
#master_username ⇒ String
The master username for the DB cluster.
174 175 176 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 174 def master_username data[:master_username] end |
#members ⇒ DBInstance::Collection
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3279 def members batch = [] data[:db_cluster_members].each do |d| batch << DBInstance.new( id: d[:db_instance_identifier], data: d, client: @client ) end DBInstance::Collection.new([batch], size: batch.size) end |
#modify(options = {}) ⇒ DBCluster
2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 2673 def modify( = {}) = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.modify_db_cluster() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#monitoring_interval ⇒ Integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
565 566 567 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 565 def monitoring_interval data[:monitoring_interval] end |
#monitoring_role_arn ⇒ String
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
574 575 576 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 574 def monitoring_role_arn data[:monitoring_role_arn] end |
#multi_az ⇒ Boolean
Indicates whether the DB cluster has instances in multiple Availability Zones.
143 144 145 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 143 def multi_az data[:multi_az] end |
#network_type ⇒ String
The network type of the DB instance.
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.
Valid Values: ‘IPV4 | DUAL`
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
654 655 656 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 654 def network_type data[:network_type] end |
#option_groups ⇒ OptionGroup::Collection
3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3292 def option_groups batch = [] data[:db_cluster_option_group_memberships].each do |d| batch << OptionGroup.new( name: d[:db_cluster_option_group_name], data: d, client: @client ) end OptionGroup::Collection.new([batch], size: batch.size) end |
#parameter_group ⇒ DBClusterParameterGroup?
3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3305 def parameter_group if data[:db_cluster_parameter_group] DBClusterParameterGroup.new( name: data[:db_cluster_parameter_group], client: @client ) else nil end end |
#pending_modified_values ⇒ Types::ClusterPendingModifiedValues
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
504 505 506 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 504 def pending_modified_values data[:pending_modified_values] end |
#percent_progress ⇒ String
The progress of the operation as a percentage.
101 102 103 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 101 def percent_progress data[:percent_progress] end |
#performance_insights_enabled ⇒ Boolean
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
588 589 590 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 588 def performance_insights_enabled data[:performance_insights_enabled] end |
#performance_insights_kms_key_id ⇒ String
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
600 601 602 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 600 def performance_insights_kms_key_id data[:performance_insights_kms_key_id] end |
#performance_insights_retention_period ⇒ Integer
The number of days to retain Performance Insights data.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
Valid Values:
-
‘7`
-
month * 31, where month is a number of months from 1-23. Examples: ‘93` (3 months * 31), `341` (11 months * 31), `589` (19 months * 31)
-
‘731`
Default: ‘7` days
620 621 622 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 620 def performance_insights_retention_period data[:performance_insights_retention_period] end |
#port ⇒ Integer
The port that the database engine is listening on.
168 169 170 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 168 def port data[:port] end |
#preferred_backup_window ⇒ String
The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
188 189 190 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 188 def preferred_backup_window data[:preferred_backup_window] end |
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
195 196 197 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 195 def preferred_maintenance_window data[:preferred_maintenance_window] end |
#publicly_accessible ⇒ Boolean
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.
When the DB cluster isn’t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
548 549 550 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 548 def publicly_accessible data[:publicly_accessible] end |
#rds_custom_cluster_configuration ⇒ Types::RdsCustomClusterConfiguration
Reserved for future use.
385 386 387 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 385 def rds_custom_cluster_configuration data[:rds_custom_cluster_configuration] end |
#read_replica_identifiers ⇒ Array<String>
Contains one or more identifiers of the read replicas associated with this DB cluster.
209 210 211 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 209 def read_replica_identifiers data[:read_replica_identifiers] end |
#reader_endpoint ⇒ String
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
130 131 132 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 130 def reader_endpoint data[:reader_endpoint] end |
#replication_source_identifier ⇒ String
The identifier of the source DB cluster if this DB cluster is a read replica.
202 203 204 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 202 def replication_source_identifier data[:replication_source_identifier] end |
#restore(options = {}) ⇒ DBCluster
3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3194 def restore( = {}) = .merge(source_db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.restore_db_cluster_to_point_in_time() end DBCluster.new( id: resp.data.db_cluster.db_cluster_identifier, data: resp.data.db_cluster, client: @client ) end |
#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo
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
379 380 381 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 379 def scaling_configuration_info data[:scaling_configuration_info] end |
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfigurationInfo
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
633 634 635 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 633 def serverless_v2_scaling_configuration data[:serverless_v2_scaling_configuration] end |
#snapshots(options = {}) ⇒ DBClusterSnapshot::Collection
3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3404 def snapshots( = {}) batches = Enumerator.new do |y| = .merge(db_cluster_identifier: @id) resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do @client.describe_db_cluster_snapshots() end resp.each_page do |page| batch = [] page.data.db_cluster_snapshots.each do |d| batch << DBClusterSnapshot.new( cluster_id: @id, snapshot_id: d.db_cluster_snapshot_identifier, data: d, client: @client ) end y.yield(batch) end end DBClusterSnapshot::Collection.new(batches) end |
#status ⇒ String
The current state of this DB cluster.
89 90 91 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 89 def status data[:status] end |
#status_infos ⇒ Array<Types::DBClusterStatusInfo>
Reserved for future use.
215 216 217 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 215 def status_infos data[:status_infos] end |
#storage_encrypted ⇒ Boolean
Indicates whether the DB cluster is encrypted.
239 240 241 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 239 def storage_encrypted data[:storage_encrypted] end |
#storage_throughput ⇒ Integer
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
716 717 718 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 716 def storage_throughput data[:storage_throughput] end |
#storage_type ⇒ String
The storage type associated with the DB cluster.
518 519 520 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 518 def storage_type data[:storage_type] end |
#subnet_group ⇒ DBSubnetGroup?
3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 3427 def subnet_group if data[:db_subnet_group] DBSubnetGroup.new( name: data[:db_subnet_group], client: @client ) else nil end end |
#tag_list ⇒ Array<Types::Tag>
A list of tags.
For more information, see [Tagging Amazon RDS resources] in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
479 480 481 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 479 def tag_list data[:tag_list] end |
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>
The list of VPC security groups that the DB cluster belongs to.
227 228 229 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 227 def vpc_security_groups data[:vpc_security_groups] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
# File 'lib/aws-sdk-rds/db_cluster.rb', line 870 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do Aws::Waiters::Waiter.new().wait({}) end end |