VpcConfigOutput - Amazon CloudWatch Synthetics
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

VpcConfigOutput

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

Contents

Ipv6AllowedForDualStack

Indicates whether this canary allows outbound IPv6 traffic if it is connected to dual-stack subnets.

Type: Boolean

Required: No

SecurityGroupIds

The IDs of the security groups for this canary.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No

SubnetIds

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 16 items.

Required: No

VpcId

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: