AWS::EC2::Snapshot - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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::EC2::Snapshot

Describes a snapshot.

Syntax

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

JSON

{
  "Type" : "AWS::EC2::Snapshot",
  "Properties" : {
      "Description" : String,
      "Tags" : [ TagsItems, ... ],
      "VolumeId" : String
    }
}

YAML

Type: AWS::EC2::Snapshot
Properties:
  Description: String
  Tags: 
    - TagsItems
  VolumeId: String

Properties

Description

The description for the snapshot.

Required: No

Type: String

Update requires: Replacement

Tags

Any tags assigned to the snapshot.

Required: No

Type: Array of TagsItems

Update requires: No interruption

VolumeId

The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

Encrypted

Indicates whether the snapshot is encrypted.

KmsKeyId

The Amazon Resource Name (ARN) of the AWS KMS key that was used to protect the volume encryption key for the parent volume.

OwnerId

The ID of the AWS account that owns the EBS snapshot.

Progress

The progress of the snapshot, as a percentage.

SnapshotId

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

StartTime

The time stamp when the snapshot was initiated.

State

The snapshot state.

StorageTier

The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

VolumeSize

The size of the volume, in GiB.