Class: MintPress::Aws::RDS::DbCluster

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb

Properties (Read/Write)

  • #availability_zones ⇒ Array of ⇒ [String]
    '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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'availability_zones'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

32
33
34
35
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 32

property :availability_zones, create_db_cluster_prop: 'availability_zones', type: [String], array: true, read_only: false, source: "create_db_cluster", description: '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.'
  • #backup_retention_period ⇒ [Integer]
    'The number of days for which automated backups are retained. Default: 1 Constraints: Must be a value from 1 to 35 ^'
    Property Attributes
    • create_db_cluster_prop ⇒ 'backup_retention_period'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'backup_retention_period'
    

36
37
38
39
40
41
42
43
44
45
46
47
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 36

property :backup_retention_period, create_db_cluster_prop: 'backup_retention_period', type: [Integer], read_only: false, source: "create_db_cluster", description: 'The number of days for which automated backups are retained.

Default: 1

Constraints:


Must be a value from 1 to 35



^', modify_db_cluster_prop: 'backup_retention_period'
  • #character_set_name ⇒ [String]
    'A value that indicates that the DB cluster should be associated with the specified CharacterSet.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'character_set_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 48

property :character_set_name, create_db_cluster_prop: 'character_set_name', type: [String], read_only: false, source: "create_db_cluster", description: 'A value that indicates that the DB cluster should be associated with
the specified CharacterSet.'
  • #database_name ⇒ [String]
    'The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn"t create a database in the DB cluster you are creating.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'database_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 50

property :database_name, create_db_cluster_prop: 'database_name', type: [String], read_only: false, source: "create_db_cluster", description: 'The name for your database of up to 64 alphanumeric characters. If you
do not provide a name, Amazon RDS doesn"t create a database in the DB
cluster you are creating.'
  • #db_cluster_identifier ⇒ [String]
    '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'
    Property Attributes
    • create_db_cluster_prop ⇒ 'db_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • delete_db_cluster_prop ⇒ 'db_cluster_identifier'
    • describe_db_clusters_prop ⇒ 'db_cluster_identifier'
    • modify_db_cluster_prop ⇒ 'db_cluster_identifier'
    • start_db_cluster_prop ⇒ 'db_cluster_identifier'
    • stop_db_cluster_prop ⇒ 'db_cluster_identifier'
    

53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 53

property :db_cluster_identifier, create_db_cluster_prop: 'db_cluster_identifier', type: [String], read_only: false, source: "create_db_cluster", description: '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', delete_db_cluster_prop: 'db_cluster_identifier', describe_db_clusters_prop: 'db_cluster_identifier', modify_db_cluster_prop: 'db_cluster_identifier', start_db_cluster_prop: 'db_cluster_identifier', stop_db_cluster_prop: 'db_cluster_identifier'
  • #db_cluster_parameter_group_name ⇒ [String]
    'The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Constraints: If supplied, must match the name of an existing DB cluster parameter group. ^'
    Property Attributes
    • create_db_cluster_prop ⇒ 'db_cluster_parameter_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'db_cluster_parameter_group_name'
    

66
67
68
69
70
71
72
73
74
75
76
77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 66

property :db_cluster_parameter_group_name, create_db_cluster_prop: 'db_cluster_parameter_group_name', type: [String], read_only: false, source: "create_db_cluster", description: 'The name of the DB cluster parameter group to associate with this DB
cluster. If you do not specify a value, then the default DB cluster
parameter group for the specified DB engine and version is used.

Constraints:


If supplied, must match the name of an existing DB cluster parameter
group.



^', modify_db_cluster_prop: 'db_cluster_parameter_group_name'
  • #db_subnet_group_name ⇒ [String]
    'A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: mySubnetgroup'
    Property Attributes
    • create_db_cluster_prop ⇒ 'db_subnet_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

79
80
81
82
83
84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 79

property :db_subnet_group_name, create_db_cluster_prop: 'db_subnet_group_name', type: [String], read_only: false, source: "create_db_cluster", description: 'A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.

Example: mySubnetgroup'
  • #engine ⇒ [String]
    'The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql'
    Property Attributes
    • create_db_cluster_prop ⇒ 'engine'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

85
86
87
88
89
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 85

property :engine, create_db_cluster_prop: 'engine', type: [String], read_only: false, source: "create_db_cluster", description: 'The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora),
aurora-mysql (for MySQL 5.7-compatible Aurora), and
aurora-postgresql'
  • #engine_version ⇒ [String]
    'The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" 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" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5 Aurora PostgreSQL Example: 9.6.3, 10.7'
    Property Attributes
    • create_db_cluster_prop ⇒ 'engine_version'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'engine_version'
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 90

property :engine_version, create_db_cluster_prop: 'engine_version', type: [String], read_only: false, source: "create_db_cluster", description: 'The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL
5.6-compatible Aurora), use the following command:

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

To list all of the available engine versions for aurora-mysql (for
MySQL 5.7-compatible Aurora), use the following command:

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

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"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12,
5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7', modify_db_cluster_prop: 'engine_version'
  • #port ⇒ [Integer]
    'The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'port'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'port'
    

118
119
120
121
122
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 118

property :port, create_db_cluster_prop: 'port', type: [Integer], read_only: false, source: "create_db_cluster", description: 'The port number on which the instances in the DB cluster accept
connections.

Default: 3306 if engine is set as aurora or 5432 if set to
aurora-postgresql.', modify_db_cluster_prop: 'port'
  • #master_username ⇒ [String]
    'The name of the master user for the DB cluster. Constraints: Must be 1 to 16 letters or numbers. First character must be a letter. Can"t be a reserved word for the chosen database engine.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'master_username'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

123
124
125
126
127
128
129
130
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 123

property :master_username, create_db_cluster_prop: 'master_username', type: [String], read_only: false, source: "create_db_cluster", description: 'The name of the master user for the DB cluster.

Constraints:


Must be 1 to 16 letters or numbers.
First character must be a letter.
Can"t be a reserved word for the chosen database engine.'
  • #master_user_password ⇒ [String]
    'The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'master_user_password'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'master_user_password'
    

131
132
133
134
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 131

property :master_user_password, create_db_cluster_prop: 'master_user_password', type: [String], read_only: false, source: "create_db_cluster", description: 'The password for the master database user. This password can contain
any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.', modify_db_cluster_prop: 'master_user_password'
  • #option_group_name ⇒ [String]
    'A value that indicates that the DB cluster should be associated with the specified option group. Permanent options can"t be removed from an option group. The option group can"t be removed from a DB cluster once it is associated with a DB cluster.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'option_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'option_group_name'
    

135
136
137
138
139
140
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 135

property :option_group_name, create_db_cluster_prop: 'option_group_name', type: [String], read_only: false, source: "create_db_cluster", description: 'A value that indicates that the DB cluster should be associated with
the specified option group.

Permanent options can"t be removed from an option group. The option
group can"t be removed from a DB cluster once it is associated with a
DB cluster.', modify_db_cluster_prop: 'option_group_name'
  • #preferred_backup_window ⇒ [String]
    'The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance 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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'preferred_backup_window'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'preferred_backup_window'
    

141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 141

property :preferred_backup_window, create_db_cluster_prop: 'preferred_backup_window', type: [String], read_only: false, source: "create_db_cluster", description: 'The daily time range during which automated backups are created if
automated backups are enabled using the BackupRetentionPeriod
parameter.

The default is a 30-minute window selected at random from an 8-hour
block of time for each AWS Region. To see the time blocks available,
see  Adjusting the Preferred DB Cluster Maintenance 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.', modify_db_cluster_prop: 'preferred_backup_window'
  • #preferred_maintenance_window ⇒ [String]
    '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 Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'preferred_maintenance_window'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'preferred_maintenance_window'
    

157
158
159
160
161
162
163
164
165
166
167
168
169
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 157

property :preferred_maintenance_window, create_db_cluster_prop: 'preferred_maintenance_window', type: [String], read_only: false, source: "create_db_cluster", description: '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  Adjusting the Preferred
DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

Constraints: Minimum 30-minute window.', modify_db_cluster_prop: 'preferred_maintenance_window'
  • #replication_source_identifier ⇒ [String]
    'The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'replication_source_identifier'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

170
171
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 170

property :replication_source_identifier, create_db_cluster_prop: 'replication_source_identifier', type: [String], read_only: false, source: "create_db_cluster", description: 'The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a read replica.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'Tags to assign to the DB cluster.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

172
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 172

property :tags, create_db_cluster_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_cluster", description: 'Tags to assign to the DB cluster.', hash: true
  • #storage_encrypted ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the DB cluster is encrypted.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'storage_encrypted'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

173
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 173

property :storage_encrypted, create_db_cluster_prop: 'storage_encrypted', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: 'A value that indicates whether the DB cluster is encrypted.'
  • #pre_signed_url ⇒ [String]
    'A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that Aurora read replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'pre_signed_url'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 174

property :pre_signed_url, create_db_cluster_prop: 'pre_signed_url', type: [String], read_only: false, source: "create_db_cluster", description: 'A URL that contains a Signature Version 4 signed request for the
CreateDBCluster action to be called in the source AWS Region where
the DB cluster is replicated from. You only need to specify
PreSignedUrl when you are performing cross-region replication from
an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster
API action that can be executed in the source AWS Region that contains
the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter
values:


KmsKeyId - The AWS KMS key identifier for the key to use to
encrypt the copy of the DB cluster in the destination AWS Region.
This should refer to the same AWS KMS CMK for both the
CreateDBCluster action that is called in the destination AWS
Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that Aurora read
replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the
encrypted DB cluster to be copied. This identifier must be in the
Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are copying an encrypted DB cluster from the
us-west-2 AWS Region, then your ReplicationSourceIdentifier would
look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.



To learn how to generate a Signature Version 4 signed request, see 
Authenticating Requests: Using Query Parameters (AWS Signature Version
4) and  Signature Version 4 Signing Process.

 If you are using an AWS SDK tool or the AWS CLI, you can specify
SourceRegion (or --source-region for the AWS CLI) instead of
specifying PreSignedUrl manually. Specifying SourceRegion
autogenerates a pre-signed URL that is a valid request for the
operation that can be executed in the source AWS Region.'
  • #enable_iam_database_authentication ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'enable_iam_database_authentication'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'enable_iam_database_authentication'
    

214
215
216
217
218
219
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 214

property :enable_iam_database_authentication, create_db_cluster_prop: 'enable_iam_database_authentication', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: '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.', modify_db_cluster_prop: 'enable_iam_database_authentication'
  • #backtrack_window ⇒ [Integer]
    'The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: If specified, this value must be set to a number from 0 to 259,200 (72 hours). ^'
    Property Attributes
    • create_db_cluster_prop ⇒ 'backtrack_window'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'backtrack_window'
    

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 220

property :backtrack_window, create_db_cluster_prop: 'backtrack_window', type: [Integer], read_only: false, source: "create_db_cluster", description: 'The target backtrack window, in seconds. To disable backtracking, set
this value to 0.

 Currently, Backtrack is only supported for Aurora MySQL DB clusters.

 

Default: 0

Constraints:


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



^', modify_db_cluster_prop: 'backtrack_window'
  • #enable_cloudwatch_logs_exports ⇒ Array of ⇒ [String]
    '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 Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible values are postgresql and upgrade.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'enable_cloudwatch_logs_exports'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

238
239
240
241
242
243
244
245
246
247
248
249
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 238

property :enable_cloudwatch_logs_exports, create_db_cluster_prop: 'enable_cloudwatch_logs_exports', type: [String], array: true, read_only: false, source: "create_db_cluster", description: '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

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible values are postgresql and upgrade.'
  • #engine_mode ⇒ [String]
    'The DB engine mode of the DB cluster, either provisioned serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn"t required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn"t required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn"t required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn"t required, and both the parallelquery and the multimaster engine modes currently aren"t supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless Limitations of Parallel Query Limitations of Aurora Global Databases Limitations of Multi-Master Clusters'
    Property Attributes
    • create_db_cluster_prop ⇒ 'engine_mode'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 250

property :engine_mode, create_db_cluster_prop: 'engine_mode', type: [String], read_only: false, source: "create_db_cluster", description: 'The DB engine mode of the DB cluster, either provisioned
serverless, parallelquery, global, or multimaster.

The parallelquery engine mode isn"t required for Aurora MySQL
version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x
versions.

The global engine mode isn"t required for Aurora MySQL version 1.22
and higher 1.x versions, and global engine mode isn"t required for
any 2.x versions.

The multimaster engine mode only applies for DB clusters created
with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn"t required, and
both the parallelquery and the multimaster engine modes currently
aren"t supported.

Limitations and requirements apply to some DB engine modes. For more
information, see the following sections in the Amazon Aurora User
Guide:


Limitations of Aurora Serverless
Limitations of Parallel Query
Limitations of Aurora Global Databases
Limitations of Multi-Master Clusters'
  • #scaling_configuration ⇒ [MintPress::Aws::RDS::ScalingConfiguration] (Default Value: MintPress::Aws::RDS::ScalingConfiguration.new)
    'For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'scaling_configuration'
    • default ⇒ MintPress::Aws::RDS::ScalingConfiguration.new
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'scaling_configuration'
    

277
278
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 277

property :scaling_configuration, create_db_cluster_prop: 'scaling_configuration', type: [MintPress::Aws::RDS::ScalingConfiguration], default: MintPress::Aws::RDS::ScalingConfiguration.new, read_only: false, source: "create_db_cluster", description: 'For DB clusters in serverless DB engine mode, the scaling properties
of the DB cluster.', modify_db_cluster_prop: 'scaling_configuration'
  • #deletion_protection ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'deletion_protection'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'deletion_protection'
    

279
280
281
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 279

property :deletion_protection, create_db_cluster_prop: 'deletion_protection', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: '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.', modify_db_cluster_prop: 'deletion_protection'
  • #global_cluster_identifier ⇒ [String]
    'The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'global_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

282
283
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 282

property :global_cluster_identifier, create_db_cluster_prop: 'global_cluster_identifier', type: [String], read_only: false, source: "create_db_cluster", description: 'The global cluster ID of an Aurora cluster that becomes the primary
cluster in the new global database cluster.'
  • #enable_http_endpoint ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'enable_http_endpoint'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'enable_http_endpoint'
    

284
285
286
287
288
289
290
291
292
293
294
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 284

property :enable_http_endpoint, create_db_cluster_prop: 'enable_http_endpoint', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: 'A value that indicates whether to enable the HTTP endpoint for an
Aurora Serverless DB cluster. By default, the HTTP endpoint is
disabled.

When enabled, the HTTP endpoint provides a connectionless web service
API for running SQL queries on the Aurora Serverless DB cluster. You
can also query your database from inside the RDS console with the
query editor.

For more information, see Using the Data API for Aurora
Serverless in the Amazon Aurora User Guide.', modify_db_cluster_prop: 'enable_http_endpoint'
  • #copy_tags_to_snapshot ⇒ [TrueClass,FalseClass]
    '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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'copy_tags_to_snapshot'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'copy_tags_to_snapshot'
    

295
296
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 295

property :copy_tags_to_snapshot, create_db_cluster_prop: 'copy_tags_to_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: '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.', modify_db_cluster_prop: 'copy_tags_to_snapshot'
  • #domain ⇒ [String]
    'The Active Directory directory ID to create the DB cluster in. 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.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'domain'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'domain'
    

297
298
299
300
301
302
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 297

property :domain, create_db_cluster_prop: 'domain', type: [String], read_only: false, source: "create_db_cluster", description: 'The Active Directory directory ID to create the DB cluster in.

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.', modify_db_cluster_prop: 'domain'
  • #domain_iam_role_name ⇒ [String]
    'Specify the name of the IAM role to be used when making API calls to the Directory Service.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'domain_iam_role_name'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'domain_iam_role_name'
    

303
304
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 303

property :domain_iam_role_name, create_db_cluster_prop: 'domain_iam_role_name', type: [String], read_only: false, source: "create_db_cluster", description: 'Specify the name of the IAM role to be used when making API calls to
the Directory Service.', modify_db_cluster_prop: 'domain_iam_role_name'
  • #enable_global_write_forwarding ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'enable_global_write_forwarding'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'enable_global_write_forwarding'
    

305
306
307
308
309
310
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 305

property :enable_global_write_forwarding, create_db_cluster_prop: 'enable_global_write_forwarding', type: [TrueClass,FalseClass], read_only: false, source: "create_db_cluster", description: 'A value that indicates whether to enable write operations to be
forwarded from this cluster to the primary cluster in an Aurora global
database. The resulting changes are replicated back to this cluster.
This parameter only applies to DB clusters that are secondary clusters
in an Aurora global database. By default, Aurora disallows write
operations for secondary clusters.', modify_db_cluster_prop: 'enable_global_write_forwarding'
  • #source_region ⇒ [String]
    'The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'source_region'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

311
312
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 311

property :source_region, create_db_cluster_prop: 'source_region', type: [String], read_only: false, source: "create_db_cluster", description: 'The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.'
  • #skip_final_snapshot ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn"t specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn"t specified, and the DB cluster snapshot is created. By default, this parameter is disabled. You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.'
    Property Attributes
    • delete_db_cluster_prop ⇒ 'skip_final_snapshot'
    • read_only ⇒ false
    • source ⇒ "delete_db_cluster"
    

313
314
315
316
317
318
319
320
321
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 313

property :skip_final_snapshot, delete_db_cluster_prop: 'skip_final_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "delete_db_cluster", description: 'A value that indicates whether to skip the creation of a final DB
cluster snapshot before the DB cluster is deleted. If skip is
specified, no DB cluster snapshot is created. If skip isn"t
specified, a DB cluster snapshot is created before the DB cluster is
deleted. By default, skip isn"t specified, and the DB cluster
snapshot is created. By default, this parameter is disabled.

 You must specify a FinalDBSnapshotIdentifier parameter if
SkipFinalSnapshot is disabled.'
  • #final_db_snapshot_identifier ⇒ [String]
    'The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled. Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can"t end with a hyphen or contain two consecutive hyphens'
    Property Attributes
    • delete_db_cluster_prop ⇒ 'final_db_snapshot_identifier'
    • read_only ⇒ false
    • source ⇒ "delete_db_cluster"
    

322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 322

property :final_db_snapshot_identifier, delete_db_cluster_prop: 'final_db_snapshot_identifier', type: [String], read_only: false, source: "delete_db_cluster", description: 'The DB cluster snapshot identifier of the new DB cluster snapshot
created when SkipFinalSnapshot is disabled.

 Specifying this parameter and also skipping the creation of a final DB
cluster snapshot with the SkipFinalShapshot parameter results in an
error.

 

Constraints:


Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can"t end with a hyphen or contain two consecutive hyphens'
  • #filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
    'A filter that specifies one or more DB clusters to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. ^'
    Property Attributes
    • describe_db_clusters_prop ⇒ 'filters'
    • source ⇒ "describe_db_clusters"
    

337
338
339
340
341
342
343
344
345
346
347
348
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 337

property :filters, describe_db_clusters_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_clusters", description: 'A filter that specifies one or more DB clusters to describe.

Supported filters:


db-cluster-id - Accepts DB cluster identifiers and DB cluster
Amazon Resource Names (ARNs). The results list will only include
information about the DB clusters identified by these ARNs.



^', hash: true
  • #max_records ⇒ [Integer]
    'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
    Property Attributes
    • describe_db_clusters_prop ⇒ 'max_records'
    • source ⇒ "describe_db_clusters"
    

349
350
351
352
353
354
355
356
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 349

property :max_records, describe_db_clusters_prop: 'max_records', type: [Integer], source: "describe_db_clusters", description: 'The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination
token called a marker is included in the response so you can retrieve
the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'
  • #include_shared ⇒ [TrueClass,FalseClass]
    'Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.'
    Property Attributes
    • describe_db_clusters_prop ⇒ 'include_shared'
    • source ⇒ "describe_db_clusters"
    

357
358
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 357

property :include_shared, describe_db_clusters_prop: 'include_shared', type: [TrueClass,FalseClass], source: "describe_db_clusters", description: 'Optional Boolean parameter that specifies whether the output includes
information about clusters shared from other AWS accounts.'
  • #new_db_cluster_identifier ⇒ [String]
    'The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can"t end with a hyphen or contain two consecutive hyphens Example: my-cluster2'
    Property Attributes
    • modify_db_cluster_prop ⇒ 'new_db_cluster_identifier'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster"
    

359
360
361
362
363
364
365
366
367
368
369
370
371
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 359

property :new_db_cluster_identifier, modify_db_cluster_prop: 'new_db_cluster_identifier', type: [String], read_only: false, source: "modify_db_cluster", description: 'The new DB cluster identifier for the DB cluster when renaming a DB
cluster. This value is stored as a lowercase string.

Constraints:


Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can"t end with a hyphen or contain two consecutive hyphens



Example: my-cluster2'
  • #apply_immediately ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window. The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter. By default, this parameter is disabled.'
    Property Attributes
    • modify_db_cluster_prop ⇒ 'apply_immediately'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster"
    

372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 372

property :apply_immediately, modify_db_cluster_prop: 'apply_immediately', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_cluster", description: 'A value that indicates whether the modifications in this request and
any pending modifications are asynchronously applied as soon as
possible, regardless of the PreferredMaintenanceWindow setting for
the DB cluster. If this parameter is disabled, changes to the DB
cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the
EnableIAMDatabaseAuthentication, MasterUserPassword, and
NewDBClusterIdentifier values. If the ApplyImmediately parameter
is disabled, then changes to the EnableIAMDatabaseAuthentication,
MasterUserPassword, and NewDBClusterIdentifier values are applied
during the next maintenance window. All other changes are applied
immediately, regardless of the value of the ApplyImmediately
parameter.

By default, this parameter is disabled.'
  • #cloudwatch_logs_export_configuration ⇒ [MintPress::Aws::RDS::CloudwatchLogsExportConfiguration] (Default Value: MintPress::Aws::RDS::CloudwatchLogsExportConfiguration.new)
    'The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.'
    Property Attributes
    • modify_db_cluster_prop ⇒ 'cloudwatch_logs_export_configuration'
    • default ⇒ MintPress::Aws::RDS::CloudwatchLogsExportConfiguration.new
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster"
    

388
389
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 388

property :cloudwatch_logs_export_configuration, modify_db_cluster_prop: 'cloudwatch_logs_export_configuration', type: [MintPress::Aws::RDS::CloudwatchLogsExportConfiguration], default: MintPress::Aws::RDS::CloudwatchLogsExportConfiguration.new, read_only: false, source: "modify_db_cluster", description: 'The configuration setting for the log types to be enabled for export
to CloudWatch Logs for a specific DB cluster.'
  • #allow_major_version_upgrade ⇒ [TrueClass,FalseClass]
    'A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster"s current version.'
    Property Attributes
    • modify_db_cluster_prop ⇒ 'allow_major_version_upgrade'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster"
    

390
391
392
393
394
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 390

property :allow_major_version_upgrade, modify_db_cluster_prop: 'allow_major_version_upgrade', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_cluster", description: 'A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a
value for the EngineVersion parameter that is a different major
version than the DB cluster"s current version.'
  • #db_instance_parameter_group_name ⇒ [String]
    '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 aren"t applied during the next maintenance window but instead are applied immediately. 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 only valid in combination with the AllowMajorVersionUpgrade parameter.'
    Property Attributes
    • modify_db_cluster_prop ⇒ 'db_instance_parameter_group_name'
    • read_only ⇒ false
    • source ⇒ "modify_db_cluster"
    

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 395

property :db_instance_parameter_group_name, modify_db_cluster_prop: 'db_instance_parameter_group_name', type: [String], read_only: false, source: "modify_db_cluster", description: '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 aren"t applied during
the next maintenance window but instead are applied immediately.

 

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 only valid in
combination with the AllowMajorVersionUpgrade parameter.'
  • #vpc_security_groups ⇒ Array of ⇒ [String]
    'A list of EC2 VPC security groups to associate with this DB cluster.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'vpc_security_group_ids'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    • modify_db_cluster_prop ⇒ 'vpc_security_group_ids'
    

414
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 414

property :vpc_security_groups, create_db_cluster_prop: 'vpc_security_group_ids', type: [String], array: true, read_only: false, source: "create_db_cluster", description: 'A list of EC2 VPC security groups to associate with this DB cluster.', modify_db_cluster_prop: 'vpc_security_group_ids'
  • #kms_key ⇒ [String]
    'The AWS KMS key identifier for an encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. When a CMK isn"t specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn"t specified, then Amazon RDS will use your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region. If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.'
    Property Attributes
    • create_db_cluster_prop ⇒ 'kms_key_id'
    • read_only ⇒ false
    • source ⇒ "create_db_cluster"
    

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 415

property :kms_key, create_db_cluster_prop: 'kms_key_id', type: [String], read_only: false, source: "create_db_cluster", description: 'The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
name for the AWS KMS customer master key (CMK). To use a CMK in a
different AWS account, specify the key ARN or alias ARN.

When a CMK isn"t specified in KmsKeyId:


If ReplicationSourceIdentifier identifies an encrypted source,
then Amazon RDS will use the CMK used to encrypt the source.
Otherwise, Amazon RDS will use your default CMK.
If the StorageEncrypted parameter is enabled and
ReplicationSourceIdentifier isn"t specified, then Amazon RDS will
use your default CMK.



There is a default CMK for your AWS account. Your AWS account has a
different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS
Region, you must set KmsKeyId to a AWS KMS key identifier that is
valid in the destination AWS Region. This CMK is used to encrypt the
read replica in that AWS Region.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

443
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 443

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

446
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_cluster.rb', line 446

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ DbCluster

Returns a new instance of DbCluster.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object

#start ⇒ Object

#stop ⇒ Object