View a markdown version of this page

AWS::Synthetics::Canary Replica - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::Synthetics::Canary Replica

A structure that contains information about a canary replica in a specific location.

Syntax

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

JSON

{
  "CanaryState" : String,
  "KmsKeyArn" : String,
  "LastModified" : Number,
  "Location" : String,
  "ReplicationStatus" : ReplicaReplicationStatus,
  "ResourcesToReplicateTags" : [ String, ... ],
  "Tags" : [ Tag, ... ],
  "VpcConfig" : VPCConfig
}

Properties

CanaryState

The current state of the canary in this replica location.

Required: No

Type: String

Allowed values: CREATING | READY | STARTING | RUNNING | UPDATING | STOPPING | STOPPED | ERROR | DELETING

Update requires: No interruption

KmsKeyArn

Property description not available.

Required: No

Type: String

Pattern: ^arn:[a-z0-9-]+:kms:[a-z0-9-]+:[0-9]{12}:(key/([a-f0-9-]{36}|mrk-[a-f0-9]{32})|alias/[a-zA-Z0-9:/_.-]+)$

Update requires: No interruption

LastModified

The date and time that the replica was last modified.

Required: No

Type: Number

Update requires: No interruption

Location

The Amazon Web Services Region where this replica is located.

Required: Yes

Type: String

Pattern: ^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$

Minimum: 1

Maximum: 20

Update requires: No interruption

ReplicationStatus

A structure that contains information about the replication status of this replica.

Required: No

Type: ReplicaReplicationStatus

Update requires: No interruption

ResourcesToReplicateTags

Property description not available.

Required: No

Type: Array of String

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcConfig

The VPC configuration for the canary replica in this location.

Required: No

Type: VPCConfig

Update requires: No interruption