View a markdown version of this page

AWS::RDS::DBSnapshot - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::RDS::DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RDS::DBSnapshot",
  "Properties" : {
      "DBInstanceIdentifier" : String,
      "DBSnapshotIdentifier" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RDS::DBSnapshot
Properties:
  DBInstanceIdentifier: String
  DBSnapshotIdentifier: String
  Tags: 
    - Tag

Properties

DBInstanceIdentifier

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Required: Yes

Type: String

Update requires: Replacement

DBSnapshotIdentifier

Specifies the identifier for the DB snapshot.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AllocatedStorage

Specifies the allocated storage size in gibibytes (GiB).

AvailabilityZone

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

DbiResourceId

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

DBSnapshotArn

The Amazon Resource Name (ARN) for the DB snapshot.

Encrypted

Indicates whether the DB snapshot is encrypted.

Engine

Specifies the name of the database engine.

EngineVersion

Specifies the version of the database engine.

IAMDatabaseAuthenticationEnabled

Indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

InstanceCreateTime

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

KmsKeyId

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

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

LicenseModel

License model information for the restored DB instance.

MasterUsername

Provides the master username for the DB snapshot.

OptionGroupName

Provides the option group name for the DB snapshot.

OriginalSnapshotCreateTime

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

Port

Specifies the port that the database engine was listening on at the time of the snapshot.

SnapshotCreateTime

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

SnapshotType

Provides the type of the DB snapshot.

Status

Specifies the status of this DB snapshot.

StorageThroughput

Specifies the storage throughput for the DB snapshot.

StorageType

Specifies the storage type associated with DB snapshot.

VpcId

Provides the VPC ID associated with the DB snapshot.