interface VPCConfigProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Synthetics.CfnCanary.VPCConfigProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary_VPCConfigProperty |
 Java | software.amazon.awscdk.services.synthetics.CfnCanary.VPCConfigProperty |
 Python | aws_cdk.aws_synthetics.CfnCanary.VPCConfigProperty |
 TypeScript | aws-cdk-lib » aws_synthetics » CfnCanary » 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 .
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-lib';
const vPCConfigProperty: synthetics.CfnCanary.VPCConfigProperty = {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
// the properties below are optional
ipv6AllowedForDualStack: false,
vpcId: 'vpcId',
};
Properties
| Name | Type | Description |
|---|---|---|
| security | string[] | The IDs of the security groups for this canary. |
| subnet | string[] | The IDs of the subnets where this canary is to run. |
| ipv6 | boolean | IResolvable | Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. |
| vpc | string | The ID of the VPC where this canary is to run. |
securityGroupIds
Type:
string[]
The IDs of the security groups for this canary.
subnetIds
Type:
string[]
The IDs of the subnets 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 .
vpcId?
Type:
string
(optional)
The ID of the VPC where this canary is to run.