aws-cdk-lib.aws_synthetics.CfnCanary.VPCConfigProperty

interface VPCConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Synthetics.CfnCanary.VPCConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary_VPCConfigProperty
Javasoftware.amazon.awscdk.services.synthetics.CfnCanary.VPCConfigProperty
Pythonaws_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
  vpcId: 'vpcId',
};

Properties

NameTypeDescription
securityGroupIdsstring[]The IDs of the security groups for this canary.
subnetIdsstring[]The IDs of the subnets where this canary is to run.
vpcId?stringThe 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.


vpcId?

Type: string (optional)

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