interface VPCConfigProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Synthetics.CfnCanaryPropsMixin.VPCConfigProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awssynthetics#CfnCanaryPropsMixin_VPCConfigProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.synthetics.CfnCanaryPropsMixin.VPCConfigProperty
Python	aws_cdk.cfn_property_mixins.aws_synthetics.CfnCanaryPropsMixin.VPCConfigProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_synthetics » CfnCanaryPropsMixin » VPCConfigProperty

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from '@aws-cdk/cfn-property-mixins';
const vPCConfigProperty: synthetics.CfnCanaryPropsMixin.VPCConfigProperty = {
  ipv6AllowedForDualStack: false,
  securityGroupIds: ['securityGroupIds'],
  subnetIds: ['subnetIds'],
  vpcId: 'vpcId',
};

Properties

Name	Type	Description
ipv6AllowedForDualStack?	boolean | IResolvable	Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets.
securityGroupIds?	string[]	The IDs of the security groups for this canary.
subnetIds?	(string | ISubnetRef)[]	The IDs of the subnets where this canary is to run.
vpcId?	string | IVPCRef	The ID of the VPC where this canary is to run.

---

ipv6AllowedForDualStack?

Type: boolean | IResolvable (optional)

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

The default is false .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-ipv6allowedfordualstack

---

securityGroupIds?

Type: string[] (optional)

The IDs of the security groups for this canary.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-securitygroupids

---

subnetIds?

Type: (string | ISubnetRef)[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-subnetids

---

vpcId?

Type: string | IVPCRef (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-vpcconfig.html#cfn-synthetics-canary-vpcconfig-vpcid