Class: AWSCDK::RDS::CfnDBClusterProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_cluster_props.rb

Overview

Properties for defining a CfnDBCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allocated_storage: nil, associated_roles: nil, auto_minor_version_upgrade: nil, availability_zones: nil, backtrack_window: nil, backup_retention_period: nil, cluster_scalability_type: nil, copy_tags_to_snapshot: nil, database_insights_mode: nil, database_name: nil, db_cluster_identifier: nil, db_cluster_instance_class: nil, db_cluster_parameter_group_name: nil, db_instance_parameter_group_name: nil, db_subnet_group_name: nil, db_system_id: nil, delete_automated_backups: nil, deletion_protection: nil, domain: nil, domain_iam_role_name: nil, enable_cloudwatch_logs_exports: nil, enable_global_write_forwarding: nil, enable_http_endpoint: nil, enable_iam_database_authentication: nil, enable_local_write_forwarding: nil, engine: nil, engine_lifecycle_support: nil, engine_mode: nil, engine_version: nil, global_cluster_identifier: nil, iops: nil, kms_key_id: nil, manage_master_user_password: nil, master_user_authentication_type: nil, master_username: nil, master_user_password: nil, master_user_secret: nil, monitoring_interval: nil, monitoring_role_arn: nil, network_type: nil, performance_insights_enabled: nil, performance_insights_kms_key_id: nil, performance_insights_retention_period: nil, port: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, publicly_accessible: nil, replication_source_identifier: nil, restore_to_time: nil, restore_type: nil, scaling_configuration: nil, serverless_v2_scaling_configuration: nil, snapshot_identifier: nil, source_db_cluster_identifier: nil, source_db_cluster_resource_id: nil, source_region: nil, storage_encrypted: nil, storage_type: nil, tags: nil, use_latest_restorable_time: nil, vpc_security_group_ids: nil) ⇒ CfnDBClusterProps

Returns a new instance of CfnDBClusterProps.

Parameters:

  • allocated_storage (Numeric, nil) (defaults to: nil) —

    The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

  • associated_roles (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::RDS::CfnDBCluster::DBClusterRoleProperty>, nil) (defaults to: nil) —

    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

  • auto_minor_version_upgrade (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

  • availability_zones (Array<String>, nil) (defaults to: nil) —

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

  • backtrack_window (Numeric, nil) (defaults to: nil) —

    The target backtrack window, in seconds. To disable backtracking, set this value to 0 .

  • backup_retention_period (Numeric, nil) (defaults to: nil) —

    The number of days for which automated backups are retained.

  • cluster_scalability_type (String, nil) (defaults to: nil) —

    Specifies the scalability mode of the Aurora DB cluster.

  • copy_tags_to_snapshot (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

  • database_insights_mode (String, nil) (defaults to: nil) —

    The mode of Database Insights to enable for the DB cluster.

  • database_name (String, nil) (defaults to: nil) —

    The name of your database.

  • db_cluster_identifier (String, nil) (defaults to: nil) —

    The DB cluster identifier. This parameter is stored as a lowercase string.

  • db_cluster_instance_class (String, nil) (defaults to: nil) —

    The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.

  • db_cluster_parameter_group_name (String, AWSCDK::Interfaces::AWSRDS::IDBClusterParameterGroupRef, nil) (defaults to: nil) —

    The name of the DB cluster parameter group to associate with this DB cluster.

  • db_instance_parameter_group_name (String, nil) (defaults to: nil) —

    The name of the DB parameter group to apply to all instances of the DB cluster.

  • db_subnet_group_name (String, AWSCDK::Interfaces::AWSRDS::IDBSubnetGroupRef, nil) (defaults to: nil) —

    A DB subnet group that you want to associate with this DB cluster.

  • db_system_id (String, nil) (defaults to: nil) —

    Reserved for future use.

  • delete_automated_backups (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to remove automated backups immediately after the DB cluster is deleted.

  • deletion_protection (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether the DB cluster has deletion protection enabled.

  • domain (String, nil) (defaults to: nil) —

    Indicates the directory ID of the Active Directory to create the DB cluster.

  • domain_iam_role_name (String, nil) (defaults to: nil) —

    Specifies the name of the IAM role to use when making API calls to the Directory Service.

  • enable_cloudwatch_logs_exports (Array<String>, nil) (defaults to: nil) —

    The list of log types that need to be enabled for exporting to CloudWatch Logs.

  • enable_global_write_forwarding (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

  • enable_http_endpoint (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

  • enable_iam_database_authentication (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

  • enable_local_write_forwarding (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

  • engine (String, nil) (defaults to: nil) —

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

  • engine_lifecycle_support (String, nil) (defaults to: nil) —

    The life cycle type for this DB cluster.

  • engine_mode (String, nil) (defaults to: nil) —

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

  • engine_version (String, nil) (defaults to: nil) —

    The version number of the database engine to use.

  • global_cluster_identifier (String, AWSCDK::Interfaces::AWSRDS::IGlobalClusterRef, nil) (defaults to: nil) —

    If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.

  • iops (Numeric, nil) (defaults to: nil) —

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

  • kms_key_id (String, AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

  • manage_master_user_password (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to manage the master user password with AWS Secrets Manager.

  • master_user_authentication_type (String, nil) (defaults to: nil) —

    Specifies the authentication type for the master user.

  • master_username (String, nil) (defaults to: nil) —

    The name of the master user for the DB cluster.

  • master_user_password (String, nil) (defaults to: nil) —

    The master password for the DB instance.

  • master_user_secret (AWSCDK::IResolvable, AWSCDK::RDS::CfnDBCluster::MasterUserSecretProperty, nil) (defaults to: nil) —

    The secret managed by RDS in AWS Secrets Manager for the master user password.

  • monitoring_interval (Numeric, nil) (defaults to: nil) —

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

  • monitoring_role_arn (String, nil) (defaults to: nil) —

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

  • network_type (String, nil) (defaults to: nil) —

    The network type of the DB cluster.

  • performance_insights_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether to turn on Performance Insights for the DB cluster.

  • performance_insights_kms_key_id (String, nil) (defaults to: nil) —

    The AWS KMS key identifier for encryption of Performance Insights data.

  • performance_insights_retention_period (Numeric, nil) (defaults to: nil) —

    The number of days to retain Performance Insights data.

  • port (Numeric, nil) (defaults to: nil) —

    The port number on which the DB instances in the DB cluster accept connections.

  • preferred_backup_window (String, nil) (defaults to: nil) —

    The daily time range during which automated backups are created.

  • preferred_maintenance_window (String, nil) (defaults to: nil) —

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

  • publicly_accessible (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the DB cluster is publicly accessible.

  • replication_source_identifier (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

  • restore_to_time (String, nil) (defaults to: nil) —

    The date and time to restore the DB cluster to.

  • restore_type (String, nil) (defaults to: nil) —

    The type of restore to be performed. You can specify one of the following values:.

  • scaling_configuration (AWSCDK::IResolvable, AWSCDK::RDS::CfnDBCluster::ScalingConfigurationProperty, nil) (defaults to: nil) —

    The scaling configuration of an Aurora Serverless v1 DB cluster.

  • serverless_v2_scaling_configuration (AWSCDK::IResolvable, AWSCDK::RDS::CfnDBCluster::ServerlessV2ScalingConfigurationProperty, nil) (defaults to: nil) —

    The scaling configuration of an Aurora Serverless V2 DB cluster.

  • snapshot_identifier (String, nil) (defaults to: nil) —

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

  • source_db_cluster_identifier (String, nil) (defaults to: nil) —

    When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

  • source_db_cluster_resource_id (String, nil) (defaults to: nil) —

    The resource ID of the source DB cluster from which to restore.

  • source_region (String, nil) (defaults to: nil) —

    The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .

  • storage_encrypted (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the DB cluster is encrypted.

  • storage_type (String, nil) (defaults to: nil) —

    The storage type to associate with the DB cluster.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the DB cluster.

  • use_latest_restorable_time (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    A value that indicates whether to restore the DB cluster to the latest restorable backup time.

  • vpc_security_group_ids (Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>, nil) (defaults to: nil) —

    A list of EC2 VPC security groups to associate with this DB cluster.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'rds/cfn_db_cluster_props.rb', line 70

def initialize(allocated_storage: nil, associated_roles: nil, auto_minor_version_upgrade: nil, availability_zones: nil, backtrack_window: nil, backup_retention_period: nil, cluster_scalability_type: nil, copy_tags_to_snapshot: nil, database_insights_mode: nil, database_name: nil, db_cluster_identifier: nil, db_cluster_instance_class: nil, db_cluster_parameter_group_name: nil, db_instance_parameter_group_name: nil, db_subnet_group_name: nil, db_system_id: nil, delete_automated_backups: nil, deletion_protection: nil, domain: nil, domain_iam_role_name: nil, enable_cloudwatch_logs_exports: nil, enable_global_write_forwarding: nil, enable_http_endpoint: nil, enable_iam_database_authentication: nil, enable_local_write_forwarding: nil, engine: nil, engine_lifecycle_support: nil, engine_mode: nil, engine_version: nil, global_cluster_identifier: nil, iops: nil, kms_key_id: nil, manage_master_user_password: nil, master_user_authentication_type: nil, master_username: nil, master_user_password: nil, master_user_secret: nil, monitoring_interval: nil, monitoring_role_arn: nil, network_type: nil, performance_insights_enabled: nil, performance_insights_kms_key_id: nil, performance_insights_retention_period: nil, port: nil, preferred_backup_window: nil, preferred_maintenance_window: nil, publicly_accessible: nil, replication_source_identifier: nil, restore_to_time: nil, restore_type: nil, scaling_configuration: nil, serverless_v2_scaling_configuration: nil, snapshot_identifier: nil, source_db_cluster_identifier: nil, source_db_cluster_resource_id: nil, source_region: nil, storage_encrypted: nil, storage_type: nil, tags: nil, use_latest_restorable_time: nil, vpc_security_group_ids: nil)
  @allocated_storage = allocated_storage
  Jsii::Type.check_type(@allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "allocatedStorage") unless @allocated_storage.nil?
  @associated_roles = associated_roles
  Jsii::Type.check_type(@associated_roles, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcmRzLkNmbkRCQ2x1c3Rlci5EQkNsdXN0ZXJSb2xlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "associatedRoles") unless @associated_roles.nil?
  @auto_minor_version_upgrade = auto_minor_version_upgrade
  Jsii::Type.check_type(@auto_minor_version_upgrade, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless @auto_minor_version_upgrade.nil?
  @availability_zones = availability_zones
  Jsii::Type.check_type(@availability_zones, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "availabilityZones") unless @availability_zones.nil?
  @backtrack_window = backtrack_window
  Jsii::Type.check_type(@backtrack_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backtrackWindow") unless @backtrack_window.nil?
  @backup_retention_period = backup_retention_period
  Jsii::Type.check_type(@backup_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "backupRetentionPeriod") unless @backup_retention_period.nil?
  @cluster_scalability_type = cluster_scalability_type
  Jsii::Type.check_type(@cluster_scalability_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterScalabilityType") unless @cluster_scalability_type.nil?
  @copy_tags_to_snapshot = copy_tags_to_snapshot
  Jsii::Type.check_type(@copy_tags_to_snapshot, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToSnapshot") unless @copy_tags_to_snapshot.nil?
  @database_insights_mode = database_insights_mode
  Jsii::Type.check_type(@database_insights_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseInsightsMode") unless @database_insights_mode.nil?
  @database_name = database_name
  Jsii::Type.check_type(@database_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseName") unless @database_name.nil?
  @db_cluster_identifier = db_cluster_identifier
  Jsii::Type.check_type(@db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterIdentifier") unless @db_cluster_identifier.nil?
  @db_cluster_instance_class = db_cluster_instance_class
  Jsii::Type.check_type(@db_cluster_instance_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbClusterInstanceClass") unless @db_cluster_instance_class.nil?
  @db_cluster_parameter_group_name = db_cluster_parameter_group_name
  Jsii::Type.check_type(@db_cluster_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCQ2x1c3RlclBhcmFtZXRlckdyb3VwUmVmIn1dfX0=")), "dbClusterParameterGroupName") unless @db_cluster_parameter_group_name.nil?
  @db_instance_parameter_group_name = db_instance_parameter_group_name
  Jsii::Type.check_type(@db_instance_parameter_group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceParameterGroupName") unless @db_instance_parameter_group_name.nil?
  @db_subnet_group_name = db_subnet_group_name
  Jsii::Type.check_type(@db_subnet_group_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSURCU3VibmV0R3JvdXBSZWYifV19fQ==")), "dbSubnetGroupName") unless @db_subnet_group_name.nil?
  @db_system_id = db_system_id
  Jsii::Type.check_type(@db_system_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbSystemId") unless @db_system_id.nil?
  @delete_automated_backups = delete_automated_backups
  Jsii::Type.check_type(@delete_automated_backups, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deleteAutomatedBackups") unless @delete_automated_backups.nil?
  @deletion_protection = deletion_protection
  Jsii::Type.check_type(@deletion_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless @deletion_protection.nil?
  @domain = domain
  Jsii::Type.check_type(@domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domain") unless @domain.nil?
  @domain_iam_role_name = domain_iam_role_name
  Jsii::Type.check_type(@domain_iam_role_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainIamRoleName") unless @domain_iam_role_name.nil?
  @enable_cloudwatch_logs_exports = enable_cloudwatch_logs_exports
  Jsii::Type.check_type(@enable_cloudwatch_logs_exports, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "enableCloudwatchLogsExports") unless @enable_cloudwatch_logs_exports.nil?
  @enable_global_write_forwarding = enable_global_write_forwarding
  Jsii::Type.check_type(@enable_global_write_forwarding, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableGlobalWriteForwarding") unless @enable_global_write_forwarding.nil?
  @enable_http_endpoint = enable_http_endpoint
  Jsii::Type.check_type(@enable_http_endpoint, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableHttpEndpoint") unless @enable_http_endpoint.nil?
  @enable_iam_database_authentication = enable_iam_database_authentication
  Jsii::Type.check_type(@enable_iam_database_authentication, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableIamDatabaseAuthentication") unless @enable_iam_database_authentication.nil?
  @enable_local_write_forwarding = enable_local_write_forwarding
  Jsii::Type.check_type(@enable_local_write_forwarding, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableLocalWriteForwarding") unless @enable_local_write_forwarding.nil?
  @engine = engine
  Jsii::Type.check_type(@engine, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless @engine.nil?
  @engine_lifecycle_support = engine_lifecycle_support
  Jsii::Type.check_type(@engine_lifecycle_support, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineLifecycleSupport") unless @engine_lifecycle_support.nil?
  @engine_mode = engine_mode
  Jsii::Type.check_type(@engine_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineMode") unless @engine_mode.nil?
  @engine_version = engine_version
  Jsii::Type.check_type(@engine_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless @engine_version.nil?
  @global_cluster_identifier = global_cluster_identifier
  Jsii::Type.check_type(@global_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yZHMuSUdsb2JhbENsdXN0ZXJSZWYifV19fQ==")), "globalClusterIdentifier") unless @global_cluster_identifier.nil?
  @iops = iops
  Jsii::Type.check_type(@iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops") unless @iops.nil?
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "kmsKeyId") unless @kms_key_id.nil?
  @manage_master_user_password = manage_master_user_password
  Jsii::Type.check_type(@manage_master_user_password, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "manageMasterUserPassword") unless @manage_master_user_password.nil?
  @master_user_authentication_type = master_user_authentication_type
  Jsii::Type.check_type(@master_user_authentication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserAuthenticationType") unless @master_user_authentication_type.nil?
  @master_username = master_username
  Jsii::Type.check_type(@master_username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUsername") unless @master_username.nil?
  @master_user_password = master_user_password
  Jsii::Type.check_type(@master_user_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserPassword") unless @master_user_password.nil?
  @master_user_secret = master_user_secret.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBCluster::MasterUserSecretProperty.new(**master_user_secret.transform_keys(&:to_sym)) : master_user_secret
  Jsii::Type.check_type(@master_user_secret, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJDbHVzdGVyLk1hc3RlclVzZXJTZWNyZXRQcm9wZXJ0eSJ9XX19")), "masterUserSecret") unless @master_user_secret.nil?
  @monitoring_interval = monitoring_interval
  Jsii::Type.check_type(@monitoring_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "monitoringInterval") unless @monitoring_interval.nil?
  @monitoring_role_arn = monitoring_role_arn
  Jsii::Type.check_type(@monitoring_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "monitoringRoleArn") unless @monitoring_role_arn.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @performance_insights_enabled = performance_insights_enabled
  Jsii::Type.check_type(@performance_insights_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "performanceInsightsEnabled") unless @performance_insights_enabled.nil?
  @performance_insights_kms_key_id = performance_insights_kms_key_id
  Jsii::Type.check_type(@performance_insights_kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "performanceInsightsKmsKeyId") unless @performance_insights_kms_key_id.nil?
  @performance_insights_retention_period = performance_insights_retention_period
  Jsii::Type.check_type(@performance_insights_retention_period, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "performanceInsightsRetentionPeriod") unless @performance_insights_retention_period.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @preferred_backup_window = preferred_backup_window
  Jsii::Type.check_type(@preferred_backup_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredBackupWindow") unless @preferred_backup_window.nil?
  @preferred_maintenance_window = preferred_maintenance_window
  Jsii::Type.check_type(@preferred_maintenance_window, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredMaintenanceWindow") unless @preferred_maintenance_window.nil?
  @publicly_accessible = publicly_accessible
  Jsii::Type.check_type(@publicly_accessible, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless @publicly_accessible.nil?
  @replication_source_identifier = replication_source_identifier
  Jsii::Type.check_type(@replication_source_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "replicationSourceIdentifier") unless @replication_source_identifier.nil?
  @restore_to_time = restore_to_time
  Jsii::Type.check_type(@restore_to_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreToTime") unless @restore_to_time.nil?
  @restore_type = restore_type
  Jsii::Type.check_type(@restore_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "restoreType") unless @restore_type.nil?
  @scaling_configuration = scaling_configuration.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBCluster::ScalingConfigurationProperty.new(**scaling_configuration.transform_keys(&:to_sym)) : scaling_configuration
  Jsii::Type.check_type(@scaling_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJDbHVzdGVyLlNjYWxpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "scalingConfiguration") unless @scaling_configuration.nil?
  @serverless_v2_scaling_configuration = serverless_v2_scaling_configuration.is_a?(Hash) ? ::AWSCDK::RDS::CfnDBCluster::ServerlessV2ScalingConfigurationProperty.new(**serverless_v2_scaling_configuration.transform_keys(&:to_sym)) : serverless_v2_scaling_configuration
  Jsii::Type.check_type(@serverless_v2_scaling_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yZHMuQ2ZuREJDbHVzdGVyLlNlcnZlcmxlc3NWMlNjYWxpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "serverlessV2ScalingConfiguration") unless @serverless_v2_scaling_configuration.nil?
  @snapshot_identifier = snapshot_identifier
  Jsii::Type.check_type(@snapshot_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotIdentifier") unless @snapshot_identifier.nil?
  @source_db_cluster_identifier = source_db_cluster_identifier
  Jsii::Type.check_type(@source_db_cluster_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbClusterIdentifier") unless @source_db_cluster_identifier.nil?
  @source_db_cluster_resource_id = source_db_cluster_resource_id
  Jsii::Type.check_type(@source_db_cluster_resource_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceDbClusterResourceId") unless @source_db_cluster_resource_id.nil?
  @source_region = source_region
  Jsii::Type.check_type(@source_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceRegion") unless @source_region.nil?
  @storage_encrypted = storage_encrypted
  Jsii::Type.check_type(@storage_encrypted, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "storageEncrypted") unless @storage_encrypted.nil?
  @storage_type = storage_type
  Jsii::Type.check_type(@storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "storageType") unless @storage_type.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @use_latest_restorable_time = use_latest_restorable_time
  Jsii::Type.check_type(@use_latest_restorable_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useLatestRestorableTime") unless @use_latest_restorable_time.nil?
  @vpc_security_group_ids = vpc_security_group_ids
  Jsii::Type.check_type(@vpc_security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2VjMi5JU2VjdXJpdHlHcm91cFJlZiJ9XX19LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless @vpc_security_group_ids.nil?
end

Instance Attribute Details

#allocated_storage ⇒ Numeric? (readonly)

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

This setting is required to create a Multi-AZ DB cluster.

Returns:

  • (Numeric, nil)

See Also:



203
204
205
 
# File 'rds/cfn_db_cluster_props.rb', line 203

def allocated_storage
  @allocated_storage
end

#associated_roles ⇒ AWSCDK::IResolvable, ... (readonly)

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 Amazon Web Services on your behalf.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



212
213
214
 
# File 'rds/cfn_db_cluster_props.rb', line 212

def associated_roles
  @associated_roles
end

#auto_minor_version_upgrade ⇒ Boolean, ... (readonly)

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

By default, minor engine upgrades are applied automatically.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.

For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version .

Returns:

See Also:



223
224
225
 
# File 'rds/cfn_db_cluster_props.rb', line 223

def auto_minor_version_upgrade
  @auto_minor_version_upgrade
end

#availability_zones ⇒ Array<String>? (readonly)

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

For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

Returns:

  • (Array<String>, nil)

See Also:



232
233
234
 
# File 'rds/cfn_db_cluster_props.rb', line 232

def availability_zones
  @availability_zones
end

#backtrack_window ⇒ Numeric? (readonly)

The target backtrack window, in seconds. To disable backtracking, set this value to 0 .

Valid for Cluster Type: Aurora MySQL DB clusters only

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Returns:

  • (Numeric, nil)

See Also:



245
246
247
 
# File 'rds/cfn_db_cluster_props.rb', line 245

def backtrack_window
  @backtrack_window
end

#backup_retention_period ⇒ Numeric? (readonly)

Note:

Default: - 1

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Numeric, nil)

See Also:



259
260
261
 
# File 'rds/cfn_db_cluster_props.rb', line 259

def backup_retention_period
  @backup_retention_period
end

#cluster_scalability_type ⇒ String? (readonly)

Specifies the scalability mode of the Aurora DB cluster.

When set to limitless , the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to standard (the default), the cluster uses normal DB instance creation.

Important: Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to limitless , you cannot set DeleteAutomatedBackups to false . To create a backup, use manual snapshots instead.

Returns:

  • (String, nil)

See Also:



268
269
270
 
# File 'rds/cfn_db_cluster_props.rb', line 268

def cluster_scalability_type
  @cluster_scalability_type
end

#copy_tags_to_snapshot ⇒ Boolean, ... (readonly)

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



277
278
279
 
# File 'rds/cfn_db_cluster_props.rb', line 277

def copy_tags_to_snapshot
  @copy_tags_to_snapshot
end

#database_insights_mode ⇒ String? (readonly)

The mode of Database Insights to enable for the DB cluster.

If you set this value to advanced , you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



286
287
288
 
# File 'rds/cfn_db_cluster_props.rb', line 286

def database_insights_mode
  @database_insights_mode
end

#database_name ⇒ String? (readonly)

The name of your database.

If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



295
296
297
 
# File 'rds/cfn_db_cluster_props.rb', line 295

def database_name
  @database_name
end

#db_cluster_identifier ⇒ String? (readonly)

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



310
311
312
 
# File 'rds/cfn_db_cluster_props.rb', line 310

def db_cluster_identifier
  @db_cluster_identifier
end

#db_cluster_instance_class ⇒ String? (readonly)

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

Returns:

  • (String, nil)

See Also:



321
322
323
 
# File 'rds/cfn_db_cluster_props.rb', line 321

def db_cluster_instance_class
  @db_cluster_instance_class
end

#db_cluster_parameter_group_name ⇒ String, ... (readonly)

The name of the DB cluster parameter group to associate with this DB cluster.

If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.

If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.

To list all of the available DB cluster parameter group names, use the following command:

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



336
337
338
 
# File 'rds/cfn_db_cluster_props.rb', line 336

def db_cluster_parameter_group_name
  @db_cluster_parameter_group_name
end

#db_instance_parameter_group_name ⇒ String? (readonly)

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

Valid for Cluster Type: Aurora DB clusters only

Default: The existing name setting

Constraints:

  • The DB parameter group must be in the same DB parameter group family as this DB cluster.
  • The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

Returns:

  • (String, nil)

See Also:



352
353
354
 
# File 'rds/cfn_db_cluster_props.rb', line 352

def db_instance_parameter_group_name
  @db_instance_parameter_group_name
end

#db_subnet_group_name ⇒ String, ... (readonly)

A DB subnet group that you want to associate with this DB cluster.

If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



361
362
363
 
# File 'rds/cfn_db_cluster_props.rb', line 361

def db_subnet_group_name
  @db_subnet_group_name
end

#db_system_id ⇒ String? (readonly)

Reserved for future use.

Returns:

  • (String, nil)

See Also:



366
367
368
 
# File 'rds/cfn_db_cluster_props.rb', line 366

def db_system_id
  @db_system_id
end

#delete_automated_backups ⇒ Boolean, ... (readonly)

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.

Returns:

See Also:



373
374
375
 
# File 'rds/cfn_db_cluster_props.rb', line 373

def delete_automated_backups
  @delete_automated_backups
end

#deletion_protection ⇒ Boolean, ... (readonly)

A value that indicates whether the DB cluster has deletion protection enabled.

The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



382
383
384
 
# File 'rds/cfn_db_cluster_props.rb', line 382

def deletion_protection
  @deletion_protection
end

#domain ⇒ String? (readonly)

Indicates the directory ID of the Active Directory to create the DB cluster.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



393
394
395
 
# File 'rds/cfn_db_cluster_props.rb', line 393

def domain
  @domain
end

#domain_iam_role_name ⇒ String? (readonly)

Specifies the name of the IAM role to use when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



400
401
402
 
# File 'rds/cfn_db_cluster_props.rb', line 400

def domain_iam_role_name
  @domain_iam_role_name
end

#enable_cloudwatch_logs_exports ⇒ Array<String>? (readonly)

The list of log types that need to be enabled for exporting to CloudWatch Logs.

The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .

Aurora MySQL

Valid values: audit , error , general , slowquery

Aurora PostgreSQL

Valid values: postgresql

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Array<String>, nil)

See Also:



417
418
419
 
# File 'rds/cfn_db_cluster_props.rb', line 417

def enable_cloudwatch_logs_exports
  @enable_cloudwatch_logs_exports
end

#enable_global_write_forwarding ⇒ Boolean, ... (readonly)

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.

Valid for Cluster Type: Aurora DB clusters only

Returns:

See Also:



428
429
430
 
# File 'rds/cfn_db_cluster_props.rb', line 428

def enable_global_write_forwarding
  @enable_global_write_forwarding
end

#enable_http_endpoint ⇒ Boolean, ... (readonly)

Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

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 .

Valid for Cluster Type: Aurora DB clusters only

Returns:

See Also:



439
440
441
 
# File 'rds/cfn_db_cluster_props.rb', line 439

def enable_http_endpoint
  @enable_http_endpoint
end

#enable_iam_database_authentication ⇒ Boolean, ... (readonly)

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Returns:

See Also:



450
451
452
 
# File 'rds/cfn_db_cluster_props.rb', line 450

def enable_iam_database_authentication
  @enable_iam_database_authentication
end

#enable_local_write_forwarding ⇒ Boolean, ... (readonly)

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

Returns:

See Also:



459
460
461
 
# File 'rds/cfn_db_cluster_props.rb', line 459

def enable_local_write_forwarding
  @enable_local_write_forwarding
end

#engine ⇒ String? (readonly)

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

Valid Values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



473
474
475
 
# File 'rds/cfn_db_cluster_props.rb', line 473

def engine
  @engine
end

#engine_lifecycle_support ⇒ String? (readonly)

The life cycle type for this DB cluster.

By default, this value is set to open-source-rds-extended-support , which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

Default: open-source-rds-extended-support

Returns:

  • (String, nil)

See Also:



491
492
493
 
# File 'rds/cfn_db_cluster_props.rb', line 491

def engine_lifecycle_support
  @engine_lifecycle_support
end

#engine_mode ⇒ String? (readonly)

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

The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.

For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :

Valid for Cluster Type: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



505
506
507
 
# File 'rds/cfn_db_cluster_props.rb', line 505

def engine_mode
  @engine_mode
end

#engine_version ⇒ String? (readonly)

The version number of the database engine to use.

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .

Aurora PostgreSQL

For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .

MySQL

For information, see Amazon RDS for MySQL in the Amazon RDS User Guide .

PostgreSQL

For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



546
547
548
 
# File 'rds/cfn_db_cluster_props.rb', line 546

def engine_version
  @engine_version
end

#global_cluster_identifier ⇒ String, ... (readonly)

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.

To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property.

For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .

Valid for: Aurora DB clusters only

Returns:

See Also:



561
562
563
 
# File 'rds/cfn_db_cluster_props.rb', line 561

def global_cluster_identifier
  @global_cluster_identifier
end

#iops ⇒ Numeric? (readonly)

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide .

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

Constraints:

  • Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

Returns:

  • (Numeric, nil)

See Also:



576
577
578
 
# File 'rds/cfn_db_cluster_props.rb', line 576

def iops
  @iops
end

#kms_key_id ⇒ String, ... (readonly)

The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .

If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.

If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



589
590
591
 
# File 'rds/cfn_db_cluster_props.rb', line 589

def kms_key_id
  @kms_key_id
end

#manage_master_user_password ⇒ Boolean, ... (readonly)

Specifies whether to manage the master user password with AWS Secrets Manager.

For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

Returns:

See Also:



602
603
604
 
# File 'rds/cfn_db_cluster_props.rb', line 602

def manage_master_user_password
  @manage_master_user_password
end

#master_user_authentication_type ⇒ String? (readonly)

Specifies the authentication type for the master user.

With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.

You can specify one of the following values:

  • password - Use standard database authentication with a password.
  • iam-db-auth - Use IAM database authentication for the master user.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

This option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.

Returns:

  • (String, nil)

See Also:



618
619
620
 
# File 'rds/cfn_db_cluster_props.rb', line 618

def master_user_authentication_type
  @master_user_authentication_type
end

#master_user_password ⇒ String? (readonly)

The master password for the DB instance.

If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



636
637
638
 
# File 'rds/cfn_db_cluster_props.rb', line 636

def master_user_password
  @master_user_password
end

#master_user_secret ⇒ AWSCDK::IResolvable, ... (readonly)

The secret managed by RDS in AWS Secrets Manager for the master user password.

When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the SecretArn property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.

For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.

Returns:

See Also:



645
646
647
 
# File 'rds/cfn_db_cluster_props.rb', line 645

def master_user_secret
  @master_user_secret
end

#master_username ⇒ String? (readonly)

The name of the master user for the DB cluster.

If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



627
628
629
 
# File 'rds/cfn_db_cluster_props.rb', line 627

def master_username
  @master_username
end

#monitoring_interval ⇒ Numeric? (readonly)

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

To turn off collecting Enhanced Monitoring metrics, specify 0 .

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

Returns:

  • (Numeric, nil)

See Also:



660
661
662
 
# File 'rds/cfn_db_cluster_props.rb', line 660

def monitoring_interval
  @monitoring_interval
end

#monitoring_role_arn ⇒ String? (readonly)

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

An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .

If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



671
672
673
 
# File 'rds/cfn_db_cluster_props.rb', line 671

def monitoring_role_arn
  @monitoring_role_arn
end

#network_type ⇒ String? (readonly)

The network type of the DB cluster.

Valid values:

  • IPV4
  • DUAL

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

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

Valid for: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



687
688
689
 
# File 'rds/cfn_db_cluster_props.rb', line 687

def network_type
  @network_type
end

#performance_insights_enabled ⇒ Boolean, ... (readonly)

Specifies whether to turn on Performance Insights for the DB cluster.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



696
697
698
 
# File 'rds/cfn_db_cluster_props.rb', line 696

def performance_insights_enabled
  @performance_insights_enabled
end

#performance_insights_kms_key_id ⇒ String? (readonly)

The AWS KMS key identifier for encryption of Performance Insights data.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



707
708
709
 
# File 'rds/cfn_db_cluster_props.rb', line 707

def performance_insights_kms_key_id
  @performance_insights_kms_key_id
end

#performance_insights_retention_period ⇒ Numeric? (readonly)

The number of days to retain Performance Insights data.

When creating a DB cluster without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod .

Valid for Cluster Type: 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

If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.

Returns:

  • (Numeric, nil)

See Also:



726
727
728
 
# File 'rds/cfn_db_cluster_props.rb', line 726

def performance_insights_retention_period
  @performance_insights_retention_period
end

#port ⇒ Numeric? (readonly)

The port number on which the DB instances in the DB cluster accept connections.

Default:

  • When EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)
  • When EngineMode is serverless :
  • 3306 when Engine is aurora or aurora-mysql
  • 5432 when Engine is aurora-postgresql

The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Numeric, nil)

See Also:



742
743
744
 
# File 'rds/cfn_db_cluster_props.rb', line 742

def port
  @port
end

#preferred_backup_window ⇒ String? (readonly)

The daily time range during which automated backups are created.

For more information, see Backup Window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi .
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



758
759
760
 
# File 'rds/cfn_db_cluster_props.rb', line 758

def preferred_backup_window
  @preferred_backup_window
end

#preferred_maintenance_window ⇒ String? (readonly)

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



773
774
775
 
# File 'rds/cfn_db_cluster_props.rb', line 773

def preferred_maintenance_window
  @preferred_maintenance_window
end

#publicly_accessible ⇒ Boolean, ... (readonly)

Specifies whether the DB cluster is publicly accessible.

Valid for Cluster Type: Multi-AZ DB clusters only

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 controlled by its security group settings.

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.

The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.

If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true .

If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default , in which case PubliclyAccessible defaults to true .

If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.

Returns:

See Also:



792
793
794
 
# File 'rds/cfn_db_cluster_props.rb', line 792

def publicly_accessible
  @publicly_accessible
end

#replication_source_identifier ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Valid for: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



799
800
801
 
# File 'rds/cfn_db_cluster_props.rb', line 799

def replication_source_identifier
  @replication_source_identifier
end

#restore_to_time ⇒ String? (readonly)

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance
  • Must be specified if UseLatestRestorableTime parameter isn't provided
  • Can't be specified if the UseLatestRestorableTime parameter is enabled
  • Can't be specified if the RestoreType parameter is copy-on-write

This property must be used with SourceDBClusterIdentifier property. The resulting cluster will have the identifier that matches the value of the DBclusterIdentifier property.

Example: 2015-03-07T23:45:00Z

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



819
820
821
 
# File 'rds/cfn_db_cluster_props.rb', line 819

def restore_to_time
  @restore_to_time
end

#restore_type ⇒ String? (readonly)

The type of restore to be performed. You can specify one of the following values:.

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



831
832
833
 
# File 'rds/cfn_db_cluster_props.rb', line 831

def restore_type
  @restore_type
end

#scaling_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The scaling configuration of an Aurora Serverless v1 DB cluster.

This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.

Valid for: Aurora Serverless v1 DB clusters only

Returns:

See Also:



840
841
842
 
# File 'rds/cfn_db_cluster_props.rb', line 840

def scaling_configuration
  @scaling_configuration
end

#serverless_v2_scaling_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The scaling configuration of an Aurora Serverless V2 DB cluster.

This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.

Valid for: Aurora Serverless v2 DB clusters only

Returns:

See Also:



849
850
851
 
# File 'rds/cfn_db_cluster_props.rb', line 849

def serverless_v2_scaling_configuration
  @serverless_v2_scaling_configuration
end

#snapshot_identifier ⇒ String? (readonly)

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.

If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:

  • GlobalClusterIdentifier
  • MasterUsername
  • MasterUserPassword
  • ReplicationSourceIdentifier
  • RestoreType
  • SourceDBClusterIdentifier
  • SourceRegion
  • StorageEncrypted (for an encrypted snapshot)
  • UseLatestRestorableTime

Constraints:

  • Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



876
877
878
 
# File 'rds/cfn_db_cluster_props.rb', line 876

def snapshot_identifier
  @snapshot_identifier
end

#source_db_cluster_identifier ⇒ String? (readonly)

When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.
  • Cannot be specified if SourceDbClusterResourceId is specified. You must specify either SourceDBClusterIdentifier or SourceDbClusterResourceId , but not both.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String, nil)

See Also:



888
889
890
 
# File 'rds/cfn_db_cluster_props.rb', line 888

def source_db_cluster_identifier
  @source_db_cluster_identifier
end

#source_db_cluster_resource_id ⇒ String? (readonly)

The resource ID of the source DB cluster from which to restore.

Returns:

  • (String, nil)

See Also:



893
894
895
 
# File 'rds/cfn_db_cluster_props.rb', line 893

def source_db_cluster_resource_id
  @source_db_cluster_resource_id
end

#source_region ⇒ String? (readonly)

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .

Valid for: Aurora DB clusters only

Returns:

  • (String, nil)

See Also:



900
901
902
 
# File 'rds/cfn_db_cluster_props.rb', line 900

def source_region
  @source_region
end

#storage_encrypted ⇒ Boolean, ... (readonly)

Indicates whether the DB cluster is encrypted.

If you specify the KmsKeyId property, then you must enable encryption.

If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.

If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.

If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .

If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



917
918
919
 
# File 'rds/cfn_db_cluster_props.rb', line 917

def storage_encrypted
  @storage_encrypted
end

#storage_type ⇒ String? (readonly)

The storage type to associate with the DB cluster.

For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .

This setting is required to create a Multi-AZ DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

  • Aurora DB clusters - aurora | aurora-iopt1
  • Multi-AZ DB clusters - io1 | io2 | gp3

Default:

  • Aurora DB clusters - aurora
  • Multi-AZ DB clusters - io1

When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to aurora .

Returns:

  • (String, nil)

See Also:



942
943
944
 
# File 'rds/cfn_db_cluster_props.rb', line 942

def storage_type
  @storage_type
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to assign to the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



949
950
951
 
# File 'rds/cfn_db_cluster_props.rb', line 949

def tags
  @tags
end

#use_latest_restorable_time ⇒ Boolean, ... (readonly)

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

By default, the DB cluster is not restored to the latest restorable backup time.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



958
959
960
 
# File 'rds/cfn_db_cluster_props.rb', line 958

def use_latest_restorable_time
  @use_latest_restorable_time
end

#vpc_security_group_ids ⇒ Array<String, AWSCDK::Interfaces::AWSEC2::ISecurityGroupRef>? (readonly)

A list of EC2 VPC security groups to associate with this DB cluster.

If you plan to update the resource, don't specify VPC security groups in a shared VPC.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

See Also:



967
968
969
 
# File 'rds/cfn_db_cluster_props.rb', line 967

def vpc_security_group_ids
  @vpc_security_group_ids
end

Class Method Details

.jsii_properties ⇒ Object 



969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'rds/cfn_db_cluster_props.rb', line 969

def self.jsii_properties
  {
    :allocated_storage => "allocatedStorage",
    :associated_roles => "associatedRoles",
    :auto_minor_version_upgrade => "autoMinorVersionUpgrade",
    :availability_zones => "availabilityZones",
    :backtrack_window => "backtrackWindow",
    :backup_retention_period => "backupRetentionPeriod",
    :cluster_scalability_type => "clusterScalabilityType",
    :copy_tags_to_snapshot => "copyTagsToSnapshot",
    :database_insights_mode => "databaseInsightsMode",
    :database_name => "databaseName",
    :db_cluster_identifier => "dbClusterIdentifier",
    :db_cluster_instance_class => "dbClusterInstanceClass",
    :db_cluster_parameter_group_name => "dbClusterParameterGroupName",
    :db_instance_parameter_group_name => "dbInstanceParameterGroupName",
    :db_subnet_group_name => "dbSubnetGroupName",
    :db_system_id => "dbSystemId",
    :delete_automated_backups => "deleteAutomatedBackups",
    :deletion_protection => "deletionProtection",
    :domain => "domain",
    :domain_iam_role_name => "domainIamRoleName",
    :enable_cloudwatch_logs_exports => "enableCloudwatchLogsExports",
    :enable_global_write_forwarding => "enableGlobalWriteForwarding",
    :enable_http_endpoint => "enableHttpEndpoint",
    :enable_iam_database_authentication => "enableIamDatabaseAuthentication",
    :enable_local_write_forwarding => "enableLocalWriteForwarding",
    :engine => "engine",
    :engine_lifecycle_support => "engineLifecycleSupport",
    :engine_mode => "engineMode",
    :engine_version => "engineVersion",
    :global_cluster_identifier => "globalClusterIdentifier",
    :iops => "iops",
    :kms_key_id => "kmsKeyId",
    :manage_master_user_password => "manageMasterUserPassword",
    :master_user_authentication_type => "masterUserAuthenticationType",
    :master_username => "masterUsername",
    :master_user_password => "masterUserPassword",
    :master_user_secret => "masterUserSecret",
    :monitoring_interval => "monitoringInterval",
    :monitoring_role_arn => "monitoringRoleArn",
    :network_type => "networkType",
    :performance_insights_enabled => "performanceInsightsEnabled",
    :performance_insights_kms_key_id => "performanceInsightsKmsKeyId",
    :performance_insights_retention_period => "performanceInsightsRetentionPeriod",
    :port => "port",
    :preferred_backup_window => "preferredBackupWindow",
    :preferred_maintenance_window => "preferredMaintenanceWindow",
    :publicly_accessible => "publiclyAccessible",
    :replication_source_identifier => "replicationSourceIdentifier",
    :restore_to_time => "restoreToTime",
    :restore_type => "restoreType",
    :scaling_configuration => "scalingConfiguration",
    :serverless_v2_scaling_configuration => "serverlessV2ScalingConfiguration",
    :snapshot_identifier => "snapshotIdentifier",
    :source_db_cluster_identifier => "sourceDbClusterIdentifier",
    :source_db_cluster_resource_id => "sourceDbClusterResourceId",
    :source_region => "sourceRegion",
    :storage_encrypted => "storageEncrypted",
    :storage_type => "storageType",
    :tags => "tags",
    :use_latest_restorable_time => "useLatestRestorableTime",
    :vpc_security_group_ids => "vpcSecurityGroupIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'rds/cfn_db_cluster_props.rb', line 1035

def to_jsii
  result = {}
  result.merge!({
    "allocatedStorage" => @allocated_storage,
    "associatedRoles" => @associated_roles,
    "autoMinorVersionUpgrade" => @auto_minor_version_upgrade,
    "availabilityZones" => @availability_zones,
    "backtrackWindow" => @backtrack_window,
    "backupRetentionPeriod" => @backup_retention_period,
    "clusterScalabilityType" => @cluster_scalability_type,
    "copyTagsToSnapshot" => @copy_tags_to_snapshot,
    "databaseInsightsMode" => @database_insights_mode,
    "databaseName" => @database_name,
    "dbClusterIdentifier" => @db_cluster_identifier,
    "dbClusterInstanceClass" => @db_cluster_instance_class,
    "dbClusterParameterGroupName" => @db_cluster_parameter_group_name,
    "dbInstanceParameterGroupName" => @db_instance_parameter_group_name,
    "dbSubnetGroupName" => @db_subnet_group_name,
    "dbSystemId" => @db_system_id,
    "deleteAutomatedBackups" => @delete_automated_backups,
    "deletionProtection" => @deletion_protection,
    "domain" => @domain,
    "domainIamRoleName" => @domain_iam_role_name,
    "enableCloudwatchLogsExports" => @enable_cloudwatch_logs_exports,
    "enableGlobalWriteForwarding" => @enable_global_write_forwarding,
    "enableHttpEndpoint" => @enable_http_endpoint,
    "enableIamDatabaseAuthentication" => @enable_iam_database_authentication,
    "enableLocalWriteForwarding" => @enable_local_write_forwarding,
    "engine" => @engine,
    "engineLifecycleSupport" => @engine_lifecycle_support,
    "engineMode" => @engine_mode,
    "engineVersion" => @engine_version,
    "globalClusterIdentifier" => @global_cluster_identifier,
    "iops" => @iops,
    "kmsKeyId" => @kms_key_id,
    "manageMasterUserPassword" => @manage_master_user_password,
    "masterUserAuthenticationType" => @master_user_authentication_type,
    "masterUsername" => @master_username,
    "masterUserPassword" => @master_user_password,
    "masterUserSecret" => @master_user_secret,
    "monitoringInterval" => @monitoring_interval,
    "monitoringRoleArn" => @monitoring_role_arn,
    "networkType" => @network_type,
    "performanceInsightsEnabled" => @performance_insights_enabled,
    "performanceInsightsKmsKeyId" => @performance_insights_kms_key_id,
    "performanceInsightsRetentionPeriod" => @performance_insights_retention_period,
    "port" => @port,
    "preferredBackupWindow" => @preferred_backup_window,
    "preferredMaintenanceWindow" => @preferred_maintenance_window,
    "publiclyAccessible" => @publicly_accessible,
    "replicationSourceIdentifier" => @replication_source_identifier,
    "restoreToTime" => @restore_to_time,
    "restoreType" => @restore_type,
    "scalingConfiguration" => @scaling_configuration,
    "serverlessV2ScalingConfiguration" => @serverless_v2_scaling_configuration,
    "snapshotIdentifier" => @snapshot_identifier,
    "sourceDbClusterIdentifier" => @source_db_cluster_identifier,
    "sourceDbClusterResourceId" => @source_db_cluster_resource_id,
    "sourceRegion" => @source_region,
    "storageEncrypted" => @storage_encrypted,
    "storageType" => @storage_type,
    "tags" => @tags,
    "useLatestRestorableTime" => @use_latest_restorable_time,
    "vpcSecurityGroupIds" => @vpc_security_group_ids,
  })
  result.compact
end