AWS::RDS::DBInstance

AWS::RDS::DBInstance

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html
• Template snippets: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-rds.html

• AWS CloudFormation templates: https://s3.us-west-2.amazonaws.com/cloudformation-templates-us-west-2/RDS_Snapshot_On_Delete.template

Snippets

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-rds.html

PostgreSQL AWS Free Tier: db.t2.micro and 20 GB of database storage and backup.

MyDB:
  Type: AWS::RDS::DBInstance
  Properties:
    AllocatedStorage: '5'
    DBInstanceClass: db.t2.micro
    Engine: postgres
    MasterUsername: MyName
    MasterUserPassword: MyPassword
  DeletionPolicy: Delete 

Complete example: RDS_template.cf

• Engines: MySQL, postgres, ... https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html

MyDB:
  Type: AWS::RDS::DBInstance
  Properties:
    DBSecurityGroups:
    - Ref: MyDbSecurityByEC2SecurityGroup
    - Ref: MyDbSecurityByCIDRIPGroup
    AllocatedStorage: '5'
    DBInstanceClass: db.t2.micro
    Engine: PostgreSQL
    MasterUsername: MyName
    MasterUserPassword: MyPassword
  DeletionPolicy: Delete 

Delete | Snapshot | Retain

Complete example

Type: AWS::RDS::DBInstance
Properties: 
  AllocatedStorage: String
  AllowMajorVersionUpgrade: Boolean
  AssociatedRoles: 
    - DBInstanceRole
  AutoMinorVersionUpgrade: Boolean
  AvailabilityZone: String
  BackupRetentionPeriod: Integer
  CACertificateIdentifier: String
  CharacterSetName: String
  CopyTagsToSnapshot: Boolean
  DBClusterIdentifier: String
  DBInstanceClass: String
  DBInstanceIdentifier: String
  DBName: String
  DBParameterGroupName: String
  DBSecurityGroups: 
    - String
  DBSnapshotIdentifier: String
  DBSubnetGroupName: String
  DeleteAutomatedBackups: Boolean
  DeletionProtection: Boolean
  Domain: String
  DomainIAMRoleName: String
  EnableCloudwatchLogsExports: 
    - String
  EnableIAMDatabaseAuthentication: Boolean
  EnablePerformanceInsights: Boolean
  Engine: String
  EngineVersion: String
  Iops: Integer
  KmsKeyId: String
  LicenseModel: String
  MasterUsername: String
  MasterUserPassword: String
  MaxAllocatedStorage: Integer
  MonitoringInterval: Integer
  MonitoringRoleArn: String
  MultiAZ: Boolean
  OptionGroupName: String
  PerformanceInsightsKMSKeyId: String
  PerformanceInsightsRetentionPeriod: Integer
  Port: String
  PreferredBackupWindow: String
  PreferredMaintenanceWindow: String
  ProcessorFeatures: 
    - ProcessorFeature
  PromotionTier: Integer
  PubliclyAccessible: Boolean
  SourceDBInstanceIdentifier: String
  SourceRegion: String
  StorageEncrypted: Boolean
  StorageType: String
  Tags: 
    - Tag
  Timezone: String
  UseDefaultProcessorFeatures: Boolean
  VPCSecurityGroups: 
    - String

Related terms

• aws cloudformation create-stack
• AWS CloudFormation functions: Fn::GetAtt
• aws rds create-db-instance
• SourceDBInstanceIdentifier for replicas

See also

• AWS::RDS, AWS::RDS::DBInstance
• AWS RDS: AWS::RDS, aws rds [ create-db-instance | create-db-instance-read-replica | describe-db-instances | modify-db-instance | modify-db-cluster | create-db-subnet-group | delete-db-instance | create-db-snapshot | aws rds create-db-parameter-group ], AllocatedStorage, FreeStorageSpace, generate-db-auth-token
• Amazon databases: AWS RDS, storage, aws rds, Amazon RDS Proxy, RDS FAQs, PostgreSQL, MySQL, SQL Server, AWS Outposts, Amazon Aurora, Amazon Aurora Serverless , Amazon DocumentDB, Amazon DynamoDB, Amazon Redshift, Amazon QLDB, Amazon RDS Performance Insights, DataFileRead, DMS, Amazon Neptune, Amazon MemoryDB for Redis, Amazon RDS query editor for Aurora Serverless, Amazon Redshift query editor, AWS RDS Snapshots, AWS RDS Instance Types, rds_superuser, Authentication, autoscaling, Blue/Green deployments, AAS