RDS Instance

Add an RDS Instance resource to your Altostra project

The RDS Instance resource creates a standalone RDS instance.
To add an RDS Instance resource in the designer, go to the "Database" section and select the "RDS Instance" resource, or search "instance" in the search box:

RDS Instance properties

Name:

type: string | required

• Altostra will use Name property for generating a logical ID:
  • Only strict alpha-numeric characters will be used (by the restrictions of CFN)
  • If non alpha-numeric characters were used in the name, the logical ID will be generated by the resource type
  • Up to 64 characters

SQL Engine:

type: string | required

• The name of the database engine that you want to use for this DB instance.
• Allowed values:
  • MySQL
  • PostgreSQL

SQL Engine Version:

type: string | required

• The version number of the database engine to use.
• Allowed Values: Dependent on the selected SQL Engine.

Instance Class:

type: string | required

• Specifies the compute, memory capacity and pricing 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.

Initial Storage Size (GB):

type: integer | default: 20 | allowed values: 20-65,536 | required

• The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.

Maximum Storage Size (GB):

type: integer | allowed values: 21-65,536 | optional

• The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
  
  If specified, must be greater than Initial Storage Size (GB).

Port:

type: integer | allowed values: 1,150-65,535 | optional

• The port number on which the database accepts connections.
  • Defaults to 3306 on MySQL and 5432 on PostgreSQL

Character Set:

type: string | optional

• Indicates that the DB instance should be associated with the specified character set.
  
  For more information:
  • Supported MySQL Character Sets and Collations
  • Supported PostgreSQL Character Sets

Default Database Name:

type: string | default: MyDB | required

• The name of the database to create when the DB instance is created.
• MySQL Constraints:
  • Must contain 1 to 64 letters or numbers.
  • Can't be a word reserved by the specified database engine.
• PostgreSQL Constraints:
  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
  • Must contain 1 to 63 characters.
  • Can't be a word reserved by the specified database engine.

Username:

type: string | default: MyDB | required

• The master user name for the DB instance.
• MySQL Constraints:
  • Must be 1 to 16 letters or numbers.
  • First character must be a letter.
  • Can't be a reserved word for the chosen database engine.
• PostgreSQL Constraints:
  • 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.

Advanced Parameters:

Security Group IDs:

type: string | optional

• A comma separated list of the VPC security group IDs to assign to the DB instance.

Subnet IDs:

type: string | optional

• A comma separated list of the VPC subnet IDs to assign to the DB instance.

Enable Storage Encryption:

type: boolean | default: true | required

• A value that indicates whether the DB instance is encrypted.
  
  RDS instances can be encrypted to protect the data stored in the database.
  
  When an RDS instance is encrypted, the data stored in the underlying storage is encrypted using an encryption key. This encryption key is managed by the AWS Key Management Service (KMS), and it is used to encrypt and decrypt the data stored in the RDS instance.

Use default key:

type: boolean | default: true | required if Enable Storage Encryption is true

• If true, indicates that the default KMS key should be used for Storage Encryption.
  Otherwise, the user must specify an Encryption Key ID.

Encryption Key ID:

type: string | required if Enable Storage Encryption is true and Use default key is false

• The ARN of the AWS KMS key that is used to encrypt the DB instance, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

Backup Retention Days:

type: integer | allowed values: 1-35 | optional

• The number of days for which automated backups are retained.

Publicly accessible:

type: boolean | default: false | required

• Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.

Deletion Protection:

type: boolean | default: true | required

• A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled.