View a markdown version of this page

AWS::DynamoDB::Export - 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::DynamoDB::Export

The AWS::DynamoDB::Export resource Property description not available. for DynamoDB.

Syntax

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

JSON

{
  "Type" : "AWS::DynamoDB::Export",
  "Properties" : {
      "ExportFormat" : String,
      "ExportType" : String,
      "S3Bucket" : String,
      "S3BucketOwner" : String,
      "S3Prefix" : String,
      "S3SseAlgorithm" : String,
      "TableArn" : String
    }
}

YAML

Type: AWS::DynamoDB::Export
Properties:
  ExportFormat: String
  ExportType: String
  S3Bucket: String
  S3BucketOwner: String
  S3Prefix: String
  S3SseAlgorithm: String
  TableArn: String

Properties

ExportFormat

The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

Required: No

Type: String

Allowed values: DYNAMODB_JSON | ION

Update requires: Replacement

ExportType

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

Required: No

Type: String

Allowed values: FULL_EXPORT | INCREMENTAL_EXPORT

Update requires: Replacement

S3Bucket

The name of the Amazon S3 bucket containing the export.

Required: Yes

Type: String

Pattern: ^[a-z0-9A-Z]+[\.\-\w]*[a-z0-9A-Z]+$

Maximum: 255

Update requires: Replacement

S3BucketOwner

The ID of the AWS account that owns the bucket containing the export.

Required: No

Type: String

Pattern: ^[0-9]{12}$

Update requires: Replacement

S3Prefix

The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

Required: No

Type: String

Maximum: 1024

Update requires: Replacement

S3SseAlgorithm

Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys

  • KMS - server-side encryption with AWS KMS managed keys

Required: No

Type: String

Allowed values: AES256 | KMS

Update requires: Replacement

TableArn

The Amazon Resource Name (ARN) of the table that was exported.

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Return values

Ref

Fn::GetAtt

BilledSizeBytes

The billable size of the table export.

EndTime

The time at which the export task completed.

ExportArn

The Amazon Resource Name (ARN) of the table export.

ExportId

Property description not available.

ExportManifest

The name of the manifest file for the export task.

ExportStatus

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

ExportTime

Point in time from which table data was exported.

ItemCount

The number of items exported.

StartTime

The time at which the export task began.

TableId

Unique ID of the table that was exported.

TableName

Property description not available.