AWS::RDS::DBSnapshot

RDS DBSnapshot

Creates a snapshot of a DB instance.

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DBInstanceIdentifier`	`string`	RequiredCreate-only
`DBSnapshotIdentifier`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AllocatedStorage`	`integer`	The allocated storage size in gibibytes (GiB).
`AvailabilityZone`	`string`	The name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
`DbiResourceId`	`string`	The identifier for the source DB instance, which is unique to an AWS Region.
`DBSnapshotArn`	`string`	The Amazon Resource Name (ARN) for the DB snapshot.
`Encrypted`	`boolean`	Indicates whether the DB snapshot is encrypted.
`Engine`	`string`	The name of the database engine.
`EngineVersion`	`string`	The version of the database engine.
`IAMDatabaseAuthenticationEnabled`	`boolean`	Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
`InstanceCreateTime`	`string`	The time when the DB instance was created, in UTC.
`Iops`	`integer`	The Provisioned IOPS value of the DB instance at the time of the snapshot.
`KmsKeyId`	`string`	If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
`LicenseModel`	`string`	License model information for the restored DB instance.
`MasterUsername`	`string`	The master username for the DB snapshot.
`OptionGroupName`	`string`	The option group name for the DB snapshot.
`OriginalSnapshotCreateTime`	`string`	The time of the CreateDBSnapshot operation in UTC. Doesn't change when the snapshot is copied.
`Port`	`integer`	The port that the database engine was listening on at the time of the snapshot.
`SnapshotCreateTime`	`string`	The time when the snapshot was taken, in UTC.
`SnapshotType`	`string`	The type of the DB snapshot.
`Status`	`string`	The status of this DB snapshot.
`StorageThroughput`	`integer`	The storage throughput for the DB snapshot.
`StorageType`	`string`	The storage type associated with the DB snapshot.
`VpcId`	`string`	The VPC ID associated with the DB snapshot.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::DBSnapshot

Resources:
  MyResource:
    Type: AWS::RDS::DBSnapshot
    Properties:
      DBSnapshotIdentifier: "my-dbsnapshotidentifier"
      DBInstanceIdentifier: "my-dbinstanceidentifier"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

rds:CreateDBSnapshotrds:DescribeDBSnapshotsrds:DescribeDBInstancesrds:AddTagsToResourcerds:ListTagsForResource

read

rds:DescribeDBSnapshotsrds:ListTagsForResource

update

rds:DescribeDBSnapshotsrds:AddTagsToResourcerds:RemoveTagsFromResourcerds:ListTagsForResource

delete

rds:DeleteDBSnapshotrds:DescribeDBSnapshotsrds:ListTagsForResource

list

rds:DescribeDBSnapshots

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS

Properties25

Required2

TaggingSupported

Primary IDDBSnapshotArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DBSnapshotIdentifierDBInstanceIdentifier

Related Resources

External Links

AWS Documentation