AWS::Synthetics::Canary VPCConfig - 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 VPCConfig

If this canary is to test an endpoint in a VPC, this structure contains information about the subnet and security groups of the VPC endpoint. For more information, see Running a Canary in a VPC.

Syntax

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

JSON

{
  "Ipv6AllowedForDualStack" : Boolean,
  "SecurityGroupIds" : [ String, ... ],
  "SubnetIds" : [ String, ... ],
  "VpcId" : String
}

YAML

  Ipv6AllowedForDualStack: Boolean
  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String
  VpcId: String

Properties

Ipv6AllowedForDualStack

Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is false.

Required: No

Type: Boolean

Update requires: No interruption

SecurityGroupIds

The IDs of the security groups for this canary.

Required: Yes

Type: Array of String

Minimum: 0

Maximum: 5

Update requires: No interruption

SubnetIds

The IDs of the subnets where this canary is to run.

Required: Yes

Type: Array of String

Minimum: 0

Maximum: 16

Update requires: No interruption

VpcId

The ID of the VPC where this canary is to run.

Required: No

Type: String

Update requires: No interruption