software.amazon.awscdk.services.synthetics

Interface CfnCanary.VPCConfigProperty

All Known Implementing Classes:

CfnCanary.VPCConfigProperty.Jsii$Proxy

Enclosing class:

CfnCanary

public static interface 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 software.amazon.awscdk.services.synthetics.*;
 VPCConfigProperty vPCConfigProperty = VPCConfigProperty.builder()
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCanary.VPCConfigProperty.Builder A builder for CfnCanary.VPCConfigProperty
static class	CfnCanary.VPCConfigProperty.Jsii$Proxy An implementation for CfnCanary.VPCConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnCanary.VPCConfigProperty.Builder	builder()
java.util.List<java.lang.String>	getSecurityGroupIds() The IDs of the security groups for this canary.
java.util.List<java.lang.String>	getSubnetIds() The IDs of the subnets where this canary is to run.
default java.lang.String	getVpcId() The ID of the VPC where this canary is to run.

Method Detail

getSecurityGroupIds

java.util.List<java.lang.String> getSecurityGroupIds()

The IDs of the security groups for this canary.

getSubnetIds

java.util.List<java.lang.String> getSubnetIds()

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

getVpcId

default java.lang.String getVpcId()

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

builder

static CfnCanary.VPCConfigProperty.Builder builder()

Returns:

a CfnCanary.VPCConfigProperty.Builder of CfnCanary.VPCConfigProperty