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).

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

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

YAML

  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String
  VpcId: String

Properties

SecurityGroupIds

The IDs of the security groups for this canary.

Required: Yes

Type: List of String

Maximum: 5

Update requires: No interruption

SubnetIds

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

Required: Yes

Type: List of String

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