Class: MintPress::Aws::RDS::DbInstance

Properties (Read/Write)

#db_name ⇒ [String]
'The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn"t specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can"t be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn"t specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can"t be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn"t specified, no database is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can"t be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can"t specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can"t be longer than 8 characters ^ SQL Server Not applicable. Must be null. Amazon Aurora The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn"t specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Can"t be a word reserved by the specified database engine'
Property Attributes

create_db_instance_prop ⇒ 'db_name'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :db_name, create_db_instance_prop: 'db_name', type: [String], read_only: false, source: "create_db_instance", description: 'The meaning of this parameter differs according to the database engine
you use.

MySQL

The name of the database to create when the DB instance is created. If
this parameter isn"t specified, no database is created in the DB
instance.

Constraints:


Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters,
underscores, or digits (0-9).
Can"t be a word reserved by the specified database engine



MariaDB

The name of the database to create when the DB instance is created. If
this parameter isn"t specified, no database is created in the DB
instance.

Constraints:


Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters,
underscores, or digits (0-9).
Can"t be a word reserved by the specified database engine



PostgreSQL

The name of the database to create when the DB instance is created. If
this parameter isn"t specified, no database is created in the DB
instance.

Constraints:


Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters,
underscores, or digits (0-9).
Can"t be a word reserved by the specified database engine



Oracle

The Oracle System ID (SID) of the created DB instance. If you specify
null, the default value ORCL is used. You can"t specify the
string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:


Can"t be longer than 8 characters



^

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB
cluster is created. If this parameter isn"t specified, no database is
created in the DB instance.

Constraints:


Must contain 1 to 64 letters or numbers.
Can"t be a word reserved by the specified database engine'

#db_instance_identifier ⇒ [String]
'The DB instance 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: mydbinstance'
Property Attributes

create_db_instance_prop ⇒ 'db_instance_identifier'
read_only ⇒ false
source ⇒ "create_db_instance"
delete_db_instance_prop ⇒ 'db_instance_identifier'
describe_db_instances_prop ⇒ 'db_instance_identifier'
modify_db_instance_prop ⇒ 'db_instance_identifier'
start_db_instance_prop ⇒ 'db_instance_identifier'
stop_db_instance_prop ⇒ 'db_instance_identifier'

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

property :db_instance_identifier, create_db_instance_prop: 'db_instance_identifier', type: [String], read_only: false, source: "create_db_instance", description: 'The DB instance 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: mydbinstance', delete_db_instance_prop: 'db_instance_identifier', describe_db_instances_prop: 'db_instance_identifier', modify_db_instance_prop: 'db_instance_identifier', start_db_instance_prop: 'db_instance_identifier', stop_db_instance_prop: 'db_instance_identifier'

#allocated_storage ⇒ [Integer]
'The amount of storage (in gibibytes) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to Provisioned IOPS storage (io1): Must be an integer from 100 to Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to Provisioned IOPS storage (io1): Must be an integer from 100 to Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to Provisioned IOPS storage (io1): Must be an integer from 100 to Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to Provisioned IOPS storage (io1): Must be an integer from 100 to Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to Web and Express editions: Must be an integer from 20 to 1024.'
Property Attributes

create_db_instance_prop ⇒ 'allocated_storage'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'allocated_storage'

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

property :allocated_storage, create_db_instance_prop: 'allocated_storage', type: [Integer], read_only: false, source: "create_db_instance", description: 'The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the
amount of data in your database increases, though you are only charged
for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the
following:


General Purpose (SSD) storage (gp2): Must be an integer from 20 to





Provisioned IOPS storage (io1): Must be an integer from 100 to





Magnetic storage (standard): Must be an integer from 5 to 3072.



MariaDB

Constraints to the amount of storage for each storage type are the
following:


General Purpose (SSD) storage (gp2): Must be an integer from 20 to





Provisioned IOPS storage (io1): Must be an integer from 100 to





Magnetic storage (standard): Must be an integer from 5 to 3072.



PostgreSQL

Constraints to the amount of storage for each storage type are the
following:


General Purpose (SSD) storage (gp2): Must be an integer from 20 to





Provisioned IOPS storage (io1): Must be an integer from 100 to





Magnetic storage (standard): Must be an integer from 5 to 3072.



Oracle

Constraints to the amount of storage for each storage type are the
following:


General Purpose (SSD) storage (gp2): Must be an integer from 20 to





Provisioned IOPS storage (io1): Must be an integer from 100 to





Magnetic storage (standard): Must be an integer from 10 to 3072.



SQL Server

Constraints to the amount of storage for each storage type are the
following:


General Purpose (SSD) storage (gp2):


Enterprise and Standard editions: Must be an integer from 200 to





Web and Express editions: Must be an integer from 20 to 16384.


Provisioned IOPS storage (io1):


Enterprise and Standard editions: Must be an integer from 200 to





Web and Express editions: Must be an integer from 100 to 16384.


Magnetic storage (standard):


Enterprise and Standard editions: Must be an integer from 200 to





Web and Express editions: Must be an integer from 20 to 1024.', modify_db_instance_prop: 'allocated_storage'

#db_instance_class ⇒ [String]
'The compute and memory capacity of the DB instance, 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.'
Property Attributes

create_db_instance_prop ⇒ 'db_instance_class'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'db_instance_class'

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

property :db_instance_class, create_db_instance_prop: 'db_instance_class', type: [String], read_only: false, source: "create_db_instance", description: 'The compute and memory capacity of the DB instance, 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.', modify_db_instance_prop: 'db_instance_class'

#engine ⇒ [String]
'The name of the database engine to be used for this instance. Not every database engine is available for every AWS Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-se2 oracle-se1 oracle-se postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web'
Property Attributes

create_db_instance_prop ⇒ 'engine'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :engine, create_db_instance_prop: 'engine', type: [String], read_only: false, source: "create_db_instance", description: 'The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:


aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web'

#master_username ⇒ [String]
'The name for the master user. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. MariaDB Constraints: Required for MariaDB. Must be 1 to 16 letters or numbers. Can"t be a reserved word for the chosen database engine. Microsoft SQL Server Constraints: Required for SQL Server. Must be 1 to 128 letters or numbers. The first character must be a letter. Can"t be a reserved word for the chosen database engine. MySQL Constraints: Required for MySQL. 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. Oracle Constraints: Required for Oracle. Must be 1 to 30 letters or numbers. First character must be a letter. Can"t be a reserved word for the chosen database engine. PostgreSQL Constraints: Required for PostgreSQL. Must be 1 to 63 letters or numbers. First character must be a letter. Can"t be a reserved word for the chosen database engine.'
Property Attributes

create_db_instance_prop ⇒ 'master_username'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :master_username, create_db_instance_prop: 'master_username', type: [String], read_only: false, source: "create_db_instance", description: 'The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB
cluster.

MariaDB

Constraints:


Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can"t be a reserved word for the chosen database engine.



Microsoft SQL Server

Constraints:


Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can"t be a reserved word for the chosen database engine.



MySQL

Constraints:


Required for MySQL.
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.



Oracle

Constraints:


Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can"t be a reserved word for the chosen database engine.



PostgreSQL

Constraints:


Required for PostgreSQL.
Must be 1 to 63 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 user. The password can include any printable ASCII character except "/", """, or "@". Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters.'
Property Attributes

create_db_instance_prop ⇒ 'master_user_password'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'master_user_password'

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

property :master_user_password, create_db_instance_prop: 'master_user_password', type: [String], read_only: false, source: "create_db_instance", description: 'The password for the master user. The password can include any
printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB
cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.', modify_db_instance_prop: 'master_user_password'

#db_security_groups ⇒ Array of ⇒ [String]
'A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.'
Property Attributes

create_db_instance_prop ⇒ 'db_security_groups'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'db_security_groups'



382
383
384

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

property :db_security_groups, create_db_instance_prop: 'db_security_groups', type: [String], array: true, read_only: false, source: "create_db_instance", description: 'A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.', modify_db_instance_prop: 'db_security_groups'

#availability_zone ⇒ [String]
'The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint"s AWS Region. Example: us-east-1d Constraint: The AvailabilityZone parameter can"t be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint. If you"re creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in. For more information about RDS on VMware, see the RDS on VMware User Guide.'
Property Attributes

create_db_instance_prop ⇒ 'availability_zone'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :availability_zone, create_db_instance_prop: 'availability_zone', type: [String], read_only: false, source: "create_db_instance", description: 'The Availability Zone (AZ) where the database will be created. For
information on AWS Regions and Availability Zones, see Regions and
Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can"t be specified if
the DB instance is a Multi-AZ deployment. The specified Availability
Zone must be in the same AWS Region as the current endpoint.

 If you"re creating a DB instance in an RDS on VMware environment,
specify the identifier of the custom Availability Zone to create the
DB instance in.

 For more information about RDS on VMware, see the  RDS on VMware User
Guide.'

#db_subnet_group_name ⇒ [String]
'A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance.'
Property Attributes

create_db_instance_prop ⇒ 'db_subnet_group_name'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'db_subnet_group_name'



404
405
406

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

property :db_subnet_group_name, create_db_instance_prop: 'db_subnet_group_name', type: [String], read_only: false, source: "create_db_instance", description: 'A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.', modify_db_instance_prop: 'db_subnet_group_name'

#preferred_maintenance_window ⇒ [String]
'The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window. 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. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.'
Property Attributes

create_db_instance_prop ⇒ 'preferred_maintenance_window'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'preferred_maintenance_window'

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

property :preferred_maintenance_window, create_db_instance_prop: 'preferred_maintenance_window', type: [String], read_only: false, source: "create_db_instance", description: 'The time range each week during which system maintenance can occur, in
Universal Coordinated Time (UTC). For more information, see Amazon
RDS Maintenance Window.

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.

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

Constraints: Minimum 30-minute window.', modify_db_instance_prop: 'preferred_maintenance_window'

#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, then the default DB parameter group for the specified DB engine and version is used. 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_prop ⇒ 'db_parameter_group_name'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'db_parameter_group_name'

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

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

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', modify_db_instance_prop: 'db_parameter_group_name'

#backup_retention_period ⇒ [Integer]
'The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can"t be set to 0 if the DB instance is a source to read replicas'
Property Attributes

create_db_instance_prop ⇒ 'backup_retention_period'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'backup_retention_period'

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

property :backup_retention_period, create_db_instance_prop: 'backup_retention_period', type: [Integer], read_only: false, source: "create_db_instance", description: 'The number of days for which automated backups are retained. Setting
this parameter to a positive number enables backups. Setting this
parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed
by the DB cluster.

Default: 1

Constraints:


Must be a value from 0 to 35
Can"t be set to 0 if the DB instance is a source to read replicas', modify_db_instance_prop: 'backup_retention_period'

#preferred_backup_window ⇒ [String]
'The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. 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 Instance Maintenance Window in the Amazon RDS 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_instance_prop ⇒ 'preferred_backup_window'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'preferred_backup_window'

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

property :preferred_backup_window, create_db_instance_prop: 'preferred_backup_window', type: [String], read_only: false, source: "create_db_instance", description: 'The daily time range during which automated backups are created if
automated backups are enabled, using the BackupRetentionPeriod
parameter. For more information, see The Backup Window in the
Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is
managed by the DB cluster.

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 Instance Maintenance Window in
the Amazon RDS 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_instance_prop: 'preferred_backup_window'

#port ⇒ [Integer]
'The port number on which the database accepts connections. MySQL Default: 3306 Valid values: 1150-65535 Type: Integer MariaDB Default: 3306 Valid values: 1150-65535 Type: Integer PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535 Type: Integer'
Property Attributes

create_db_instance_prop ⇒ 'port'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :port, create_db_instance_prop: 'port', type: [Integer], read_only: false, source: "create_db_instance", description: 'The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343,
3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer'

#multi_az ⇒ [TrueClass,FalseClass]
'A value that indicates whether the DB instance is a Multi-AZ deployment. You can"t set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.'
Property Attributes

create_db_instance_prop ⇒ 'multi_az'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'multi_az'



514
515
516

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

property :multi_az, create_db_instance_prop: 'multi_az', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether the DB instance is a Multi-AZ
deployment. You can"t set the AvailabilityZone parameter if the DB
instance is a Multi-AZ deployment.', modify_db_instance_prop: 'multi_az'

#engine_version ⇒ [String]
'The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.'
Property Attributes

create_db_instance_prop ⇒ 'engine_version'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'engine_version'

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

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

For a list of valid engine versions, use the
DescribeDBEngineVersions action.

The following are the database engines and links to information about
the major and minor versions that are available with Amazon RDS. Not
every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used
by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User
Guide.

Microsoft SQL Server

See Microsoft SQL Server Versions on Amazon RDS in the Amazon
RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User
Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS
User Guide.', modify_db_instance_prop: 'engine_version'

#auto_minor_version_upgrade ⇒ [TrueClass,FalseClass]
'A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.'
Property Attributes

create_db_instance_prop ⇒ 'auto_minor_version_upgrade'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'auto_minor_version_upgrade'



554
555
556

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

property :auto_minor_version_upgrade, create_db_instance_prop: 'auto_minor_version_upgrade', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether minor engine upgrades are applied
automatically to the DB instance during the maintenance window. By
default, minor engine upgrades are applied automatically.', modify_db_instance_prop: 'auto_minor_version_upgrade'

#license_model ⇒ [String]
'License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license'
Property Attributes

create_db_instance_prop ⇒ 'license_model'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'license_model'

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

property :license_model, create_db_instance_prop: 'license_model', type: [String], read_only: false, source: "create_db_instance", description: 'License model information for this DB instance.

Valid values: license-included | bring-your-own-license |
general-public-license', modify_db_instance_prop: 'license_model'

#iops ⇒ [Integer]
'The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.'
Property Attributes

create_db_instance_prop ⇒ 'iops'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'iops'

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

property :iops, create_db_instance_prop: 'iops', type: [Integer], read_only: false, source: "create_db_instance", description: 'The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance. For information about
valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve
Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
must be a multiple between .5 and 50 of the storage amount for the DB
instance. For SQL Server DB instances, must be a multiple between 1
and 50 of the storage amount for the DB instance.', modify_db_instance_prop: 'iops'

#option_group_name ⇒ [String]
'Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can"t be removed from an option group. Also, that option group can"t be removed from a DB instance once it is associated with a DB instance'
Property Attributes

create_db_instance_prop ⇒ 'option_group_name'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'option_group_name'

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

property :option_group_name, create_db_instance_prop: 'option_group_name', type: [String], read_only: false, source: "create_db_instance", description: 'Indicates that the DB instance should be associated with the specified
option group.

Permanent options, such as the TDE option for Oracle Advanced Security
TDE, can"t be removed from an option group. Also, that option group
can"t be removed from a DB instance once it is associated with a DB
instance', modify_db_instance_prop: 'option_group_name'

#character_set_name ⇒ [String]
'For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.'
Property Attributes

create_db_instance_prop ⇒ 'character_set_name'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :character_set_name, create_db_instance_prop: 'character_set_name', type: [String], read_only: false, source: "create_db_instance", description: 'For supported engines, indicates that the DB instance should be
associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For
more information, see CreateDBCluster.'

#nchar_character_set_name ⇒ [String]
'The name of the NCHAR character set for the Oracle DB instance.'
Property Attributes

create_db_instance_prop ⇒ 'nchar_character_set_name'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :nchar_character_set_name, create_db_instance_prop: 'nchar_character_set_name', type: [String], read_only: false, source: "create_db_instance", description: 'The name of the NCHAR character set for the Oracle DB instance.'

#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. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn"t specified, and PubliclyAccessible isn"t specified, the following applies: If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private. If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn"t specified, the following applies: If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private. If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.'
Property Attributes

create_db_instance_prop ⇒ 'publicly_accessible'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'publicly_accessible'

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

property :publicly_accessible, create_db_instance_prop: 'publicly_accessible', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", 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.

Default: The default behavior varies depending on whether
DBSubnetGroupName is specified.

If DBSubnetGroupName isn"t specified, and PubliclyAccessible
isn"t specified, the following applies:


If the default VPC in the target region doesn’t have an Internet
gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway
attached to it, the DB instance is public.



If DBSubnetGroupName is specified, and PubliclyAccessible isn"t
specified, the following applies:


If the subnets are part of a VPC that doesn’t have an Internet
gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway
attached to it, the DB instance is public.', modify_db_instance_prop: 'publicly_accessible'

#tags ⇒ Hash of ⇒ [MintPress::Aws::RDS::Tag]
'Tags to assign to the DB instance.'
Property Attributes

create_db_instance_prop ⇒ 'tags'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :tags, create_db_instance_prop: 'tags', type: [MintPress::Aws::RDS::Tag], array: false, read_only: false, source: "create_db_instance", description: 'Tags to assign to the DB instance.', hash: true

#db_cluster_identifier ⇒ [String]
'The identifier of the DB cluster that the instance will belong to.'
Property Attributes

create_db_instance_prop ⇒ 'db_cluster_identifier'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :db_cluster_identifier, create_db_instance_prop: 'db_cluster_identifier', type: [String], read_only: false, source: "create_db_instance", description: 'The identifier of the DB cluster that the instance will belong to.'

#storage_type ⇒ [String]
'Specifies the storage type to be associated with the DB instance. 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_prop ⇒ 'storage_type'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'storage_type'

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

property :storage_type, create_db_instance_prop: 'storage_type', type: [String], read_only: false, source: "create_db_instance", description: 'Specifies the storage type to be associated with the DB instance.

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', modify_db_instance_prop: 'storage_type'

#tde_credential_arn ⇒ [String]
'The ARN from the key store with which to associate the instance for TDE encryption.'
Property Attributes

create_db_instance_prop ⇒ 'tde_credential_arn'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'tde_credential_arn'



629
630

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

property :tde_credential_arn, create_db_instance_prop: 'tde_credential_arn', type: [String], read_only: false, source: "create_db_instance", description: 'The ARN from the key store with which to associate the instance for
TDE encryption.', modify_db_instance_prop: 'tde_credential_arn'

#tde_credential_password ⇒ [String]
'The password for the given ARN from the key store in order to access the device.'
Property Attributes

create_db_instance_prop ⇒ 'tde_credential_password'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'tde_credential_password'



631
632

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

property :tde_credential_password, create_db_instance_prop: 'tde_credential_password', type: [String], read_only: false, source: "create_db_instance", description: 'The password for the given ARN from the key store in order to access
the device.', modify_db_instance_prop: 'tde_credential_password'

#storage_encrypted ⇒ [TrueClass,FalseClass]
'A value that indicates whether the DB instance is encrypted. By default, it isn"t encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.'
Property Attributes

create_db_instance_prop ⇒ 'storage_encrypted'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :storage_encrypted, create_db_instance_prop: 'storage_encrypted', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether the DB instance is encrypted. By
default, it isn"t encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB
cluster.'

#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_prop ⇒ 'domain'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'domain'

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

property :domain, create_db_instance_prop: 'domain', type: [String], read_only: false, source: "create_db_instance", 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.', modify_db_instance_prop: 'domain'

#copy_tags_to_snapshot ⇒ [TrueClass,FalseClass]
'A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.'
Property Attributes

create_db_instance_prop ⇒ 'copy_tags_to_snapshot'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'copy_tags_to_snapshot'

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

property :copy_tags_to_snapshot, create_db_instance_prop: 'copy_tags_to_snapshot', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether to copy tags from the DB instance to
snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB
cluster. Setting this value for an Aurora DB instance has no effect on
the DB cluster setting.', modify_db_instance_prop: 'copy_tags_to_snapshot'

#monitoring_interval ⇒ [Integer]
'The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 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_prop ⇒ 'monitoring_interval'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'monitoring_interval'

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

property :monitoring_interval, create_db_instance_prop: 'monitoring_interval', type: [Integer], read_only: false, source: "create_db_instance", description: 'The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance. 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', modify_db_instance_prop: 'monitoring_interval'

#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 Setting Up and Enabling 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_prop ⇒ 'monitoring_role_arn'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'monitoring_role_arn'

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

property :monitoring_role_arn, create_db_instance_prop: 'monitoring_role_arn', type: [String], read_only: false, source: "create_db_instance", 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 Setting Up and Enabling 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.', modify_db_instance_prop: 'monitoring_role_arn'

#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_prop ⇒ 'domain_iam_role_name'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'domain_iam_role_name'



670
671

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

property :domain_iam_role_name, create_db_instance_prop: 'domain_iam_role_name', type: [String], read_only: false, source: "create_db_instance", description: 'Specify the name of the IAM role to be used when making API calls to
the Directory Service.', modify_db_instance_prop: 'domain_iam_role_name'

#promotion_tier ⇒ [Integer]
'A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15'
Property Attributes

create_db_instance_prop ⇒ 'promotion_tier'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'promotion_tier'

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

property :promotion_tier, create_db_instance_prop: 'promotion_tier', type: [Integer], read_only: false, source: "create_db_instance", description: 'A value that specifies the order in which an Aurora Replica is
promoted to the primary instance after a failure of the existing
primary instance. For more information, see  Fault Tolerance for an
Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15', modify_db_instance_prop: 'promotion_tier'

#timezone ⇒ [String]
'The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.'
Property Attributes

create_db_instance_prop ⇒ 'timezone'
read_only ⇒ false
source ⇒ "create_db_instance"



680
681

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

property :timezone, create_db_instance_prop: 'timezone', type: [String], read_only: false, source: "create_db_instance", description: 'The time zone of the DB instance. The time zone parameter is currently
supported only by Microsoft SQL Server.'

#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. This setting doesn"t apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.'
Property Attributes

create_db_instance_prop ⇒ 'enable_iam_database_authentication'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'enable_iam_database_authentication'

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

property :enable_iam_database_authentication, create_db_instance_prop: 'enable_iam_database_authentication', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", 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.

This setting doesn"t apply to Amazon Aurora. Mapping AWS IAM accounts
to database accounts is managed by the DB cluster.

For more information, see  IAM Database Authentication for MySQL and
PostgreSQL in the Amazon RDS User Guide.', modify_db_instance_prop: 'enable_iam_database_authentication'

#enable_performance_insights ⇒ [TrueClass,FalseClass]
'A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.'
Property Attributes

create_db_instance_prop ⇒ 'enable_performance_insights'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'enable_performance_insights'

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

property :enable_performance_insights, create_db_instance_prop: 'enable_performance_insights', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether to enable Performance Insights for the
DB instance.

For more information, see Using Amazon Performance Insights in
the Amazon Relational Database Service User Guide.', modify_db_instance_prop: 'enable_performance_insights'

#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_prop ⇒ 'performance_insights_retention_period'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'performance_insights_retention_period'



696
697

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

property :performance_insights_retention_period, create_db_instance_prop: 'performance_insights_retention_period', type: [Integer], read_only: false, source: "create_db_instance", description: 'The amount of time, in days, to retain Performance Insights data.
Valid values are 7 or 731 (2 years).', modify_db_instance_prop: 'performance_insights_retention_period'

#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 Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, and trace. PostgreSQL Possible values are postgresql and upgrade.'
Property Attributes

create_db_instance_prop ⇒ 'enable_cloudwatch_logs_exports'
read_only ⇒ false
source ⇒ "create_db_instance"

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

property :enable_cloudwatch_logs_exports, create_db_instance_prop: 'enable_cloudwatch_logs_exports', type: [String], array: true, read_only: false, source: "create_db_instance", 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 Relational Database Service User
Guide.

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

MariaDB

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

Microsoft SQL Server

Possible values are agent and error.

MySQL

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

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.'

#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_prop ⇒ 'processor_features'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'processor_features'



727
728

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

property :processor_features, create_db_instance_prop: 'processor_features', type: [MintPress::Aws::RDS::ProcessorFeature], array: false, read_only: false, source: "create_db_instance", description: 'The number of CPU cores and the number of threads per core for the DB
instance class of the DB instance.', modify_db_instance_prop: 'processor_features', hash: true

#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. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.'
Property Attributes

create_db_instance_prop ⇒ 'deletion_protection'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'deletion_protection'

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

property :deletion_protection, create_db_instance_prop: 'deletion_protection', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", 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.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the
DB cluster. For more information, see CreateDBCluster. DB instances
in a DB cluster can be deleted even when deletion protection is
enabled for the DB cluster.', modify_db_instance_prop: 'deletion_protection'

#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_prop ⇒ 'max_allocated_storage'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'max_allocated_storage'



740
741

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

property :max_allocated_storage, create_db_instance_prop: 'max_allocated_storage', type: [Integer], read_only: false, source: "create_db_instance", description: 'The upper limit to which Amazon RDS can automatically scale the
storage of the DB instance.', modify_db_instance_prop: 'max_allocated_storage'

#enable_customer_owned_ip ⇒ [TrueClass,FalseClass]
'A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.'
Property Attributes

create_db_instance_prop ⇒ 'enable_customer_owned_ip'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'enable_customer_owned_ip'

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

property :enable_customer_owned_ip, create_db_instance_prop: 'enable_customer_owned_ip', type: [TrueClass,FalseClass], read_only: false, source: "create_db_instance", description: 'A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your
Outpost subnets through your on-premises network. For some use cases,
a CoIP can provide lower latency for connections to the DB instance
from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon
RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses
in the AWS Outposts User Guide.', modify_db_instance_prop: 'enable_customer_owned_ip'

#skip_final_snapshot ⇒ [TrueClass,FalseClass]
'A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn"t specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn"t specified, and the DB snapshot is created. When a DB instance is in a failure state and has a status of "failed", "incompatible-restore", or "incompatible-network", it can only be deleted when skip is specified. Specify skip when deleting a read replica. The FinalDBSnapshotIdentifier parameter must be specified if skip isn"t specified.'
Property Attributes

delete_db_instance_prop ⇒ 'skip_final_snapshot'
read_only ⇒ false
source ⇒ "delete_db_instance"

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

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

When a DB instance is in a failure state and has a status of
"failed", "incompatible-restore", or "incompatible-network", it
can only be deleted when skip is specified.

Specify skip when deleting a read replica.

 The FinalDBSnapshotIdentifier parameter must be specified if skip
isn"t specified.'

#final_db_snapshot_identifier ⇒ [String]
'The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter. Can"t end with a hyphen or contain two consecutive hyphens. Can"t be specified when deleting a read replica.'
Property Attributes

delete_db_instance_prop ⇒ 'final_db_snapshot_identifier'
read_only ⇒ false
source ⇒ "delete_db_instance"

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

property :final_db_snapshot_identifier, delete_db_instance_prop: 'final_db_snapshot_identifier', type: [String], read_only: false, source: "delete_db_instance", description: 'The DBSnapshotIdentifier of the new DBSnapshot created when the
SkipFinalSnapshot parameter is disabled.

 Specifying this parameter and also specifying to skip final DB
snapshot creation in SkipFinalShapshot results in an error.

 

Constraints:


Must be 1 to 255 letters or numbers.
First character must be a letter.
Can"t end with a hyphen or contain two consecutive hyphens.
Can"t be specified when deleting a read replica.'

#delete_automated_backups ⇒ [TrueClass,FalseClass]
'A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn"t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.'
Property Attributes

delete_db_instance_prop ⇒ 'delete_automated_backups'
read_only ⇒ false
source ⇒ "delete_db_instance"

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

property :delete_automated_backups, delete_db_instance_prop: 'delete_automated_backups', type: [TrueClass,FalseClass], read_only: false, source: "delete_db_instance", description: 'A value that indicates whether to remove automated backups immediately
after the DB instance is deleted. This parameter isn"t
case-sensitive. The default is to remove automated backups immediately
after the DB instance is deleted.'

#filters ⇒ Hash of ⇒ [MintPress::Aws::RDS::Filter]
'A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs. db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs. dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers. domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains. engine - Accepts engine names. The results list will only include information about the DB instances for these engines.'
Property Attributes

describe_db_instances_prop ⇒ 'filters'
source ⇒ "describe_db_instances"

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

property :filters, describe_db_instances_prop: 'filters', type: [MintPress::Aws::RDS::Filter], array: false, source: "describe_db_instances", description: 'A filter that specifies one or more DB instances 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 instances associated with the DB clusters
identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance
Amazon Resource Names (ARNs). The results list will only include
information about the DB instances identified by these ARNs.
dbi-resource-id - Accepts DB instance resource identifiers. The
results list will only include information about the DB instances
identified by these DB instance resource identifiers.
domain - Accepts Active Directory directory IDs. The results list
will only include information about the DB instances associated with
these domains.
engine - Accepts engine names. The results list will only include
information about the DB instances for these engines.', 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 that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.'
Property Attributes

describe_db_instances_prop ⇒ 'max_records'
source ⇒ "describe_db_instances"

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

property :max_records, describe_db_instances_prop: 'max_records', type: [Integer], source: "describe_db_instances", 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 that you can
retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.'

#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 instance. By default, this parameter is disabled. If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.'
Property Attributes

modify_db_instance_prop ⇒ 'apply_immediately'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :apply_immediately, modify_db_instance_prop: 'apply_immediately', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_instance", 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 instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied
during the next maintenance window. Some parameter changes can cause
an outage and are applied on the next call to RebootDBInstance, or the
next failure reboot. Review the table of parameters in Modifying a DB
Instance in the Amazon RDS User Guide. to see the impact of
enabling or disabling ApplyImmediately for each modified parameter
and to determine when the changes are applied.'

#allow_major_version_upgrade ⇒ [TrueClass,FalseClass]
'A value that indicates whether major version upgrades are allowed. Changing this parameter doesn"t result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance"s current version.'
Property Attributes

modify_db_instance_prop ⇒ 'allow_major_version_upgrade'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :allow_major_version_upgrade, modify_db_instance_prop: 'allow_major_version_upgrade', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_instance", description: 'A value that indicates whether major version upgrades are allowed.
Changing this parameter doesn"t result in an outage and the change is
asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a
value for the EngineVersion parameter that is a different major
version than the DB instance"s current version.'

#new_db_instance_identifier ⇒ [String]
'The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. 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: mydbinstance'
Property Attributes

modify_db_instance_prop ⇒ 'new_db_instance_identifier'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :new_db_instance_identifier, modify_db_instance_prop: 'new_db_instance_identifier', type: [String], read_only: false, source: "modify_db_instance", description: 'The new DB instance identifier for the DB instance when renaming a DB
instance. When you change the DB instance identifier, an instance
reboot occurs immediately if you enable ApplyImmediately, or will
occur during the next maintenance window if you disable Apply
Immediately. 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: mydbinstance'

#ca_certificate_identifier ⇒ [String]
'Indicates the certificate that needs to be associated with the instance.'
Property Attributes

modify_db_instance_prop ⇒ 'ca_certificate_identifier'
read_only ⇒ false
source ⇒ "modify_db_instance"



851
852

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

property :ca_certificate_identifier, modify_db_instance_prop: 'ca_certificate_identifier', type: [String], read_only: false, source: "modify_db_instance", description: 'Indicates the certificate that needs to be associated with the
instance.'

#db_port_number ⇒ [Integer]
'The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter. MySQL Default: 3306 Valid values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535'
Property Attributes

modify_db_instance_prop ⇒ 'db_port_number'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :db_port_number, modify_db_instance_prop: 'db_port_number', type: [Integer], read_only: false, source: "modify_db_instance", description: 'The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the
port values specified for options in the option group for the DB
instance.

Your database will restart when you change the DBPortNumber value
regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid values: 1150-65535

MariaDB

Default: 3306

Valid values: 1150-65535

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343,
3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535'

#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 instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.'
Property Attributes

modify_db_instance_prop ⇒ 'cloudwatch_logs_export_configuration'
default ⇒ MintPress::Aws::RDS::CloudwatchLogsExportConfiguration.new
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :cloudwatch_logs_export_configuration, modify_db_instance_prop: 'cloudwatch_logs_export_configuration', type: [MintPress::Aws::RDS::CloudwatchLogsExportConfiguration], default: MintPress::Aws::RDS::CloudwatchLogsExportConfiguration.new, read_only: false, source: "modify_db_instance", description: 'The configuration setting for the log types to be enabled for export
to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is
always applied to the DB instance immediately. Therefore, the
ApplyImmediately parameter has no effect.'

#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

modify_db_instance_prop ⇒ 'use_default_processor_features'
read_only ⇒ false
source ⇒ "modify_db_instance"



906
907

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

property :use_default_processor_features, modify_db_instance_prop: 'use_default_processor_features', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_instance", description: 'A value that indicates whether the DB instance class of the DB
instance uses its default processor features.'

#certificate_rotation_restart ⇒ [TrueClass,FalseClass]
'A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.'
Property Attributes

modify_db_instance_prop ⇒ 'certificate_rotation_restart'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :certificate_rotation_restart, modify_db_instance_prop: 'certificate_rotation_restart', type: [TrueClass,FalseClass], read_only: false, source: "modify_db_instance", description: 'A value that indicates whether the DB instance is restarted when you
rotate your SSL/TLS certificate.

By default, the DB instance is restarted when you rotate your SSL/TLS
certificate. The certificate is not updated until the DB instance is
restarted.

Set this parameter only if you are not using SSL/TLS to connect to
the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the
appropriate instructions for your DB engine to rotate your SSL/TLS
certificate:


For more information about rotating your SSL/TLS certificate for RDS
DB engines, see  Rotating Your SSL/TLS Certificate. in the
Amazon RDS User Guide.
For more information about rotating your SSL/TLS certificate for
Aurora DB engines, see  Rotating Your SSL/TLS Certificate in
the Amazon Aurora User Guide.'

#replica_mode ⇒ [String]
'A value that sets the open mode of a replica database to either mounted or read-only. Currently, 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. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.'
Property Attributes

modify_db_instance_prop ⇒ 'replica_mode'
read_only ⇒ false
source ⇒ "modify_db_instance"

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

property :replica_mode, modify_db_instance_prop: 'replica_mode', type: [String], read_only: false, source: "modify_db_instance", description: 'A value that sets the open mode of a replica database to either
mounted or read-only.

 Currently, 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. For
more information, see Working with Oracle Read Replicas for Amazon
RDS in the Amazon RDS User Guide.'

#db_snapshot_identifier ⇒ [String]
'The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.'
Property Attributes

stop_db_instance_prop ⇒ 'db_snapshot_identifier'
read_only ⇒ false
source ⇒ "stop_db_instance"



943
944

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

property :db_snapshot_identifier, stop_db_instance_prop: 'db_snapshot_identifier', type: [String], read_only: false, source: "stop_db_instance", description: 'The user-supplied instance identifier of the DB Snapshot created
immediately before the DB instance is stopped.'

#vpc_security_groups ⇒ Array of ⇒ [String]
'A list of Amazon EC2 VPC security groups to associate with this DB instance. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. Default: The default EC2 VPC security group for the DB subnet group"s VPC.'
Property Attributes

create_db_instance_prop ⇒ 'vpc_security_group_ids'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'vpc_security_group_ids'

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

property :vpc_security_groups, create_db_instance_prop: 'vpc_security_group_ids', type: [String], array: true, read_only: false, source: "create_db_instance", description: 'A list of Amazon EC2 VPC security groups to associate with this DB
instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is
managed by the DB cluster.

Default: The default EC2 VPC security group for the DB subnet group"s
VPC.', modify_db_instance_prop: 'vpc_security_group_ids'

#kms_key ⇒ [String]
'The AWS KMS key identifier for an encrypted DB instance. 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. Amazon Aurora Not applicable. The AWS KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, 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_prop ⇒ 'kms_key_id'
read_only ⇒ false
source ⇒ "create_db_instance"

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

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

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.

Amazon Aurora

Not applicable. The AWS KMS key identifier is managed by the DB
cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for
the KmsKeyId parameter, 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.'

#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_prop ⇒ 'performance_insights_kms_key_id'
read_only ⇒ false
source ⇒ "create_db_instance"
modify_db_instance_prop ⇒ 'performance_insights_kms_key_id'

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

property :performance_insights_kms_key, create_db_instance_prop: 'performance_insights_kms_key_id', type: [String], read_only: false, source: "create_db_instance", 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.', modify_db_instance_prop: 'performance_insights_kms_key_id'

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

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

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

Properties (Read Only)

Constructor Details

#initialize(opts = {}) ⇒ `DbInstance`

Returns a new instance of DbInstance.

Properties (Read/Write)

Properties (Read Only)

Constant Summary

Constants included from MintLogger

Instance Attribute Summary

Attributes included from Mixins::Properties

Instance Method Summary collapse

Methods included from AwsCommon

Methods included from Mixins::Properties

Methods included from MintLogger::Utils::Common

Constructor Details

#initialize(opts = {}) ⇒ `DbInstance`

Instance Method Details

#create ⇒ `Object`

#delete ⇒ `Object`

#delete_cascade ⇒ `Object`

#describe ⇒ `Object`

#modify ⇒ `Object`

#start ⇒ `Object`

#stop ⇒ `Object`

Class: MintPress::Aws::RDS::DbInstance

Properties (Read/Write)

Properties (Read Only)

Constant Summary

Constants included from MintLogger

Instance Attribute Summary

Attributes included from Mixins::Properties

Instance Method Summary collapse

Methods included from AwsCommon

Methods included from Mixins::Properties

Methods included from MintLogger::Utils::Common

Constructor Details

#initialize(opts = {}) ⇒ DbInstance

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#modify ⇒ Object

#start ⇒ Object

#stop ⇒ Object

#initialize(opts = {}) ⇒ `DbInstance`

#create ⇒ `Object`

#delete ⇒ `Object`

#delete_cascade ⇒ `Object`

#describe ⇒ `Object`

#modify ⇒ `Object`

#start ⇒ `Object`

#stop ⇒ `Object`