AWS::SES::MailManagerArchive - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::SES::MailManagerArchive

Creates a new email archive resource for storing and retaining emails.

Syntax

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

JSON

{
  "Type" : "AWS::SES::MailManagerArchive",
  "Properties" : {
      "ArchiveName" : String,
      "KmsKeyArn" : String,
      "Retention" : ArchiveRetention,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SES::MailManagerArchive
Properties:
  ArchiveName: String
  KmsKeyArn: String
  Retention: 
    ArchiveRetention
  Tags: 
    - Tag

Properties

ArchiveName

A unique name for the new archive.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*[a-zA-Z0-9]$

Minimum: 1

Maximum: 64

Update requires: No interruption

KmsKeyArn

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Required: No

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$

Update requires: Replacement

Retention

The period for retaining emails in the archive before automatic deletion.

Required: No

Type: ArchiveRetention

Update requires: No interruption

Tags

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ArchiveArn

The Amazon Resource Name (ARN) of the archive.

ArchiveId

The unique identifier of the archive.

ArchiveState

The current state of the archive:

  • ACTIVE – The archive is ready and available for use.

  • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.