Class: MintPress::Aws::RDS::DbInstanceReadReplica

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

Properties (Read/Write)

  • #db_instance_identifier ⇒ [String]
    'The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'db_instance_identifier'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

19
20
21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 19

property :db_instance_identifier, create_db_instance_read_replica_prop: 'db_instance_identifier', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The DB instance identifier of the read replica. This identifier is the
unique key that identifies a DB instance. This parameter is stored as
a lowercase string.'
  • #source_db_instance_identifier ⇒ [String]
    'The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. If the source DB instance is in the same AWS Region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different AWS Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn"t apply to SQL Server, which doesn"t support cross-region replicas.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'source_db_instance_identifier'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 22

property :source_db_instance_identifier, create_db_instance_read_replica_prop: 'source_db_instance_identifier', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The identifier of the DB instance that will act as the source for the
read replica. Each DB instance can have up to five read replicas.

Constraints:


Must be the identifier of an existing MySQL, MariaDB, Oracle,
PostgreSQL, or SQL Server DB instance.
Can specify a DB instance that is a MySQL read replica only if the
source is running MySQL 5.6 or later.
For the limitations of Oracle read replicas, see Read Replica
Limitations with Oracle in the Amazon RDS User Guide.
For the limitations of SQL Server read replicas, see Read Replica
Limitations with Microsoft SQL Server in the Amazon RDS User
Guide.
Can specify a PostgreSQL DB instance only if the source is running
PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region
replication).
The specified DB instance must have automatic backups enabled, that
is, its backup retention period must be greater than 0.
If the source DB instance is in the same AWS Region as the read
replica, specify a valid DB instance identifier.
If the source DB instance is in a different AWS Region from the read
replica, specify a valid DB instance ARN. For more information, see
Constructing an ARN for Amazon RDS in the Amazon RDS User
Guide. This doesn"t apply to SQL Server, which doesn"t support
cross-region replicas.'
  • #db_instance_class ⇒ [String]
    'The compute and memory capacity of the read replica, for example, db.m4.large. 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. Default: Inherits from the source DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'db_instance_class'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

49
50
51
52
53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 49

property :db_instance_class, create_db_instance_read_replica_prop: 'db_instance_class', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The compute and memory capacity of the read replica, for example,
db.m4.large. 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.

Default: Inherits from the source DB instance.'
  • #availability_zone ⇒ [String]
    'The Availability Zone (AZ) where the read replica will be created. Default: A random, system-chosen Availability Zone in the endpoint"s AWS Region. Example: us-east-1d'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'availability_zone'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

56
57
58
59
60
61
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 56

property :availability_zone, create_db_instance_read_replica_prop: 'availability_zone', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint"s
AWS Region.

Example: us-east-1d'
  • #port ⇒ [Integer]
    'The port number that the DB instance uses for connections. Default: Inherits from the source DB instance Valid Values: 1150-65535'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'port'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

62
63
64
65
66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 62

property :port, create_db_instance_read_replica_prop: 'port', type: [Integer], read_only: false, source: "create_db_instance_read_replica", description: 'The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535'
  • #multi_az ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'multi_az'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

67
68
69
70
71
72
73
74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 67

property :multi_az, create_db_instance_read_replica_prop: 'multi_az', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether the read replica is in a Multi-AZ
deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a
standby of your replica in another Availability Zone for failover
support for the replica. Creating your read replica as a Multi-AZ DB
instance is independent of whether the source database is a Multi-AZ
DB instance.'
  • #auto_minor_version_upgrade ⇒ [TrueClass,FalseClass]
    'A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. Default: Inherits from the source DB instance'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'auto_minor_version_upgrade'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

75
76
77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 75

property :auto_minor_version_upgrade, create_db_instance_read_replica_prop: 'auto_minor_version_upgrade', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether minor engine upgrades are applied
automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance'
  • #iops ⇒ [Integer]
    'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'iops'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 79

property :iops, create_db_instance_read_replica_prop: 'iops', type: [Integer], read_only: false, source: "create_db_instance_read_replica", description: 'The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance.'
  • #option_group_name ⇒ [String]
    'The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'option_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

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

property :option_group_name, create_db_instance_read_replica_prop: 'option_group_name', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The option group the DB instance is associated with. If omitted, the
option group associated with the source instance is used.

 For SQL Server, you must use the option group associated with the
source instance.'
  • #db_parameter_group_name ⇒ [String]
    'The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica. Currently, specifying a parameter group for this operation is only supported for Oracle DB instances. 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
    • create_db_instance_read_replica_prop ⇒ 'db_parameter_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 86

property :db_parameter_group_name, create_db_instance_read_replica_prop: 'db_parameter_group_name', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon
RDS uses the DBParameterGroup of source DB instance for a same
region read replica, or the default DBParameterGroup for the
specified DB engine for a cross region read replica.

 Currently, specifying a parameter group for this operation is only
supported for Oracle DB instances.

 

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'
  • #publicly_accessible ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance"s VPC, and to the public IP address from outside of the DB instance"s VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn"t permit it. When the DB instance isn"t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'publicly_accessible'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

104
105
106
107
108
109
110
111
112
113
114
115
116
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 104

property :publicly_accessible, create_db_instance_read_replica_prop: 'publicly_accessible', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves
to the private IP address from within the DB instance"s VPC, and to
the public IP address from outside of the DB instance"s VPC. Access
to the DB instance is ultimately controlled by the security group it
uses, and that public access is not permitted if the security group
assigned to the DB instance doesn"t permit it.

When the DB instance isn"t publicly accessible, it is an internal DB
instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.'
  • #tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
    'A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

117
118
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 117

property :tags, create_db_instance_read_replica_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_instance_read_replica", description: 'A list of tags. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.', hash: true
  • #db_subnet_group_name ⇒ [String]
    'Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn"t created in a VPC. Constraints: Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region. If supplied, must match the name of an existing DBSubnetGroup. The specified DB subnet group must be in the same AWS Region in which the operation is running. All read replicas in one AWS Region that are created from the same source DB instance must either:> Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC. Not specify a DB subnet group. All these read replicas are created outside of any VPC. Example: mySubnetgroup'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'db_subnet_group_name'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

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

property :db_subnet_group_name, create_db_instance_read_replica_prop: 'db_subnet_group_name', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'Specifies a DB subnet group for the DB instance. The new DB instance
is created in the VPC associated with the DB subnet group. If no DB
subnet group is specified, then the new DB instance isn"t created in
a VPC.

Constraints:


Can only be specified if the source DB instance identifier specifies
a DB instance in another AWS Region.
If supplied, must match the name of an existing DBSubnetGroup.
The specified DB subnet group must be in the same AWS Region in
which the operation is running.
All read replicas in one AWS Region that are created from the same
source DB instance must either:>


Specify DB subnet groups from the same VPC. All these read
replicas are created in the same VPC.
Not specify a DB subnet group. All these read replicas are created
outside of any VPC.





Example: mySubnetgroup'
  • #storage_type ⇒ [String]
    'Specifies the storage type to be associated with the read replica. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'storage_type'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

146
147
148
149
150
151
152
153
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 146

property :storage_type, create_db_instance_read_replica_prop: 'storage_type', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops
parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2'
  • #copy_tags_to_snapshot ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'copy_tags_to_snapshot'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

154
155
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 154

property :copy_tags_to_snapshot, create_db_instance_read_replica_prop: 'copy_tags_to_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether to copy all tags from the read replica
to snapshots of the read replica. By default, tags are not copied.'
  • #monitoring_interval ⇒ [Integer]
    'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'monitoring_interval'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

156
157
158
159
160
161
162
163
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 156

property :monitoring_interval, create_db_instance_read_replica_prop: 'monitoring_interval', type: [Integer], read_only: false, source: "create_db_instance_read_replica", description: 'The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the read replica. To disable collecting
Enhanced Monitoring metrics, specify 0. The default is 0.

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

Valid Values: 0, 1, 5, 10, 15, 30, 60'
  • #monitoring_role_arn ⇒ [String]
    'The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'monitoring_role_arn'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

164
165
166
167
168
169
170
171
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 164

property :monitoring_role_arn, create_db_instance_read_replica_prop: 'monitoring_role_arn', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The ARN for the IAM role that permits RDS to send enhanced monitoring
metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess. For information on creating
a monitoring role, go to To create an IAM role for Amazon RDS
Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must
supply a MonitoringRoleArn value.'
  • #pre_signed_url ⇒ [String]
    'The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another AWS Region by using the Amazon RDS API. Don"t specify PreSignedUrl when you are creating an encrypted read replica in the same AWS Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted read replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the read replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. 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 presigned URL that is a valid request for the operation that can be executed in the source AWS Region. SourceRegion isn"t supported for SQL Server, because SQL Server on Amazon RDS doesn"t support cross-region read replicas.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'pre_signed_url'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

172
173
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
214
215
216
217
218
219
220
221
222
223
224
225
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 172

property :pre_signed_url, create_db_instance_read_replica_prop: 'pre_signed_url', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The URL that contains a Signature Version 4 signed request for the
CreateDBInstanceReadReplica API action in the source AWS Region that
contains the source DB instance.

You must specify this parameter when you create an encrypted read
replica from another AWS Region by using the Amazon RDS API. Don"t
specify PreSignedUrl when you are creating an encrypted read replica
in the same AWS Region.

The presigned URL must be a valid request for the
CreateDBInstanceReadReplica API action that can be executed in the
source AWS Region that contains the encrypted source DB instance. The
presigned URL request must contain the following parameter values:


DestinationRegion - The AWS Region that the encrypted read replica
is created in. This AWS Region is the same one where the
CreateDBInstanceReadReplica action is called that contains this
presigned URL.

For example, if you create an encrypted DB instance in the us-west-1
AWS Region, from a source DB instance in the us-east-2 AWS Region,
then you call the CreateDBInstanceReadReplica action in the
us-east-1 AWS Region and provide a presigned URL that contains a
call to the CreateDBInstanceReadReplica action in the us-west-2
AWS Region. For this example, the DestinationRegion in the
presigned URL must be set to the us-east-1 AWS Region.
KmsKeyId - The AWS KMS key identifier for the key to use to
encrypt the read replica in the destination AWS Region. This is the
same identifier for both the CreateDBInstanceReadReplica action
that is called in the destination AWS Region, and the action
contained in the presigned URL.
SourceDBInstanceIdentifier - The DB instance identifier for the
encrypted DB instance to be replicated. This identifier must be in
the Amazon Resource Name (ARN) format for the source AWS Region. For
example, if you are creating an encrypted read replica from a DB
instance in the us-west-2 AWS Region, then your
SourceDBInstanceIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.



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 presigned URL that is a valid request for the
operation that can be executed in the source AWS Region.

 SourceRegion isn"t supported for SQL Server, because SQL Server on
Amazon RDS doesn"t support cross-region read replicas.'
  • #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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'enable_iam_database_authentication'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

226
227
228
229
230
231
232
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 226

property :enable_iam_database_authentication, create_db_instance_read_replica_prop: 'enable_iam_database_authentication', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", 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 about IAM database authentication, see  IAM
Database Authentication for MySQL and PostgreSQL in the Amazon
RDS User Guide.'
  • #enable_performance_insights ⇒ [TrueClass,FalseClass]
    'A value that indicates whether to enable Performance Insights for the read replica. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'enable_performance_insights'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

233
234
235
236
237
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 233

property :enable_performance_insights, create_db_instance_read_replica_prop: 'enable_performance_insights', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether to enable Performance Insights for the
read replica.

For more information, see Using Amazon Performance Insights in
the Amazon RDS User Guide.'
  • #performance_insights_retention_period ⇒ [Integer]
    'The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'performance_insights_retention_period'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

238
239
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 238

property :performance_insights_retention_period, create_db_instance_read_replica_prop: 'performance_insights_retention_period', type: [Integer], read_only: false, source: "create_db_instance_read_replica", description: 'The amount of time, in days, to retain Performance Insights data.
Valid values are 7 or 731 (2 years).'
  • #enable_cloudwatch_logs_exports ⇒ Array of ⇒ [String]
    'The list of logs that the new DB instance is to export 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 RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'enable_cloudwatch_logs_exports'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

240
241
242
243
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 240

property :enable_cloudwatch_logs_exports, create_db_instance_read_replica_prop: 'enable_cloudwatch_logs_exports', type: [String], array: true, read_only: false, source: "create_db_instance_read_replica", description: 'The list of logs that the new DB instance is to export 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 RDS User Guide.'
  • #processor_features ⇒ Hash of ⇒ [MintPress::Aws::RDS::ProcessorFeature]
    'The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'processor_features'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

244
245
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 244

property :processor_features, create_db_instance_read_replica_prop: 'processor_features', type: [MintPress::Aws::RDS::ProcessorFeature], array: false, read_only: false, source: "create_db_instance_read_replica", description: 'The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.', hash: true
  • #use_default_processor_features ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the DB instance class of the DB instance uses its default processor features.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'use_default_processor_features'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

246
247
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 246

property :use_default_processor_features, create_db_instance_read_replica_prop: 'use_default_processor_features', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether the DB instance class of the DB
instance uses its default processor features.'
  • #deletion_protection ⇒ [TrueClass,FalseClass]
    'A value that indicates whether the DB instance has deletion protection enabled. The database can"t be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'deletion_protection'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

248
249
250
251
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 248

property :deletion_protection, create_db_instance_read_replica_prop: 'deletion_protection', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance_read_replica", description: 'A value that indicates whether the DB instance has deletion protection
enabled. The database can"t be deleted when deletion protection is
enabled. By default, deletion protection is disabled. For more
information, see  Deleting a DB Instance.'
  • #domain ⇒ [String]
    'The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'domain'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

252
253
254
255
256
257
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 252

property :domain, create_db_instance_read_replica_prop: 'domain', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The Active Directory directory ID to create the DB instance in.
Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
instances can be created in an Active Directory Domain.

For more information, see  Kerberos Authentication in the Amazon
RDS User Guide.'
  • #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_instance_read_replica_prop ⇒ 'domain_iam_role_name'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

258
259
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 258

property :domain_iam_role_name, create_db_instance_read_replica_prop: 'domain_iam_role_name', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'Specify the name of the IAM role to be used when making API calls to
the Directory Service.'
  • #replica_mode ⇒ [String]
    'The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn"t use Active Data Guard to transmit information to the mounted replica. Because it doesn"t accept user connections, a mounted replica can"t serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'replica_mode'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 260

property :replica_mode, create_db_instance_read_replica_prop: 'replica_mode', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The open mode of the replica database: mounted or read-only.

 This parameter is only supported for Oracle DB instances.

 

Mounted DB replicas are included in Oracle Enterprise Edition. The
main use case for mounted replicas is cross-Region disaster recovery.
The primary database doesn"t use Active Data Guard to transmit
information to the mounted replica. Because it doesn"t accept user
connections, a mounted replica can"t serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for
the same primary DB instance. For more information, see Working with
Oracle Read Replicas for Amazon RDS in the Amazon RDS User
Guide.'
  • #max_allocated_storage ⇒ [Integer]
    'The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'max_allocated_storage'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

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

property :max_allocated_storage, create_db_instance_read_replica_prop: 'max_allocated_storage', type: [Integer], read_only: false, source: "create_db_instance_read_replica", description: 'The upper limit to which Amazon RDS can automatically scale the
storage of the DB instance.'
  • #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_instance_read_replica_prop ⇒ 'source_region'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

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

property :source_region, create_db_instance_read_replica_prop: 'source_region', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.'
  • #vpc_security_groups ⇒ Array of ⇒ [String]
    'A list of EC2 VPC security groups to associate with the read replica. Default: The default EC2 VPC security group for the DB subnet group"s VPC.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'vpc_security_group_ids'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

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

property :vpc_security_groups, create_db_instance_read_replica_prop: 'vpc_security_group_ids', type: [String], array: true, read_only: false, source: "create_db_instance_read_replica", description: 'A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group"s
VPC.'
  • #kms_key ⇒ [String]
    'The AWS KMS key identifier for an encrypted read replica. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK. If you create an encrypted read replica in the same AWS Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same AWS KMS CMK as the source DB instance. If you create an encrypted read replica in a different AWS Region, then you must specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can"t use CMKs from one AWS Region in another AWS Region. You can"t create an encrypted read replica from an unencrypted DB instance.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'kms_key_id'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 284

property :kms_key, create_db_instance_read_replica_prop: 'kms_key_id', type: [String], read_only: false, source: "create_db_instance_read_replica", description: 'The AWS KMS key identifier for an encrypted read replica.

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

If you create an encrypted read replica in the same AWS Region as the
source DB instance, then do not specify a value for this parameter. A
read replica in the same Region is always encrypted with the same AWS
KMS CMK as the source DB instance.

If you create an encrypted read replica in a different AWS Region,
then you must specify a AWS KMS key identifier for the destination AWS
Region. AWS KMS CMKs are specific to the AWS Region that they are
created in, and you can"t use CMKs from one AWS Region in another AWS
Region.

You can"t create an encrypted read replica from an unencrypted DB
instance.'
  • #performance_insights_kms_key ⇒ [String]
    '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 AWS KMS customer master key (CMK). If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.'
    Property Attributes
    • create_db_instance_read_replica_prop ⇒ 'performance_insights_kms_key_id'
    • read_only ⇒ false
    • source ⇒ "create_db_instance_read_replica"
    

302
303
304
305
306
307
308
309
310
311
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/rds/db_instance_read_replica.rb', line 302

property :performance_insights_kms_key, create_db_instance_read_replica_prop: 'performance_insights_kms_key_id', type: [String], read_only: false, source: "create_db_instance_read_replica", description: '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 AWS KMS customer master key (CMK).

If you do not specify a value for PerformanceInsightsKMSKeyId, then
Amazon RDS uses your default CMK. There is a default CMK for your AWS
account. Your AWS account has a different default CMK for each 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 
    

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

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
    

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

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 = {}) ⇒ DbInstanceReadReplica

Returns a new instance of DbInstanceReadReplica.

Instance Method Details

#create ⇒ Object