Package software.amazon.awscdk.cfnpropertymixins.services.synthetics

Interface CfnCanaryPropsMixin.VPCConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCanaryPropsMixin.VPCConfigProperty.Jsii$Proxy

Enclosing class:

CfnCanaryPropsMixin

@Stability(Stable)
public static interface CfnCanaryPropsMixin.VPCConfigProperty
extends software.amazon.jsii.JsiiSerializable

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.cfnpropertymixins.services.synthetics.*;
 VPCConfigProperty vPCConfigProperty = VPCConfigProperty.builder()
         .ipv6AllowedForDualStack(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCanaryPropsMixin.VPCConfigProperty.Builder	builder()
default Object	getIpv6AllowedForDualStack()	Set this to true to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets.
default List<String>	getSecurityGroupIds()	The IDs of the security groups for this canary.
default List<Object>	getSubnetIds()	The IDs of the subnets where this canary is to run.
default Object	getVpcId()	The ID of the VPC where this canary is to run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpv6AllowedForDualStack

@Stability(Stable)
@Nullable
default Object getIpv6AllowedForDualStack()

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

The default is false .

Returns union: either Boolean or IResolvable

See Also:

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

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

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

getSubnetIds

@Stability(Stable)
@Nullable
default List<Object> getSubnetIds()

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

Returns union: Listinvalid input: '<'either String or ISubnetRef>

See Also:

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

getVpcId

@Stability(Stable)
@Nullable
default Object getVpcId()

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

Returns union: either String or IVPCRef

See Also:

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

builder

@Stability(Stable)
static CfnCanaryPropsMixin.VPCConfigProperty.Builder builder()

Returns:

a CfnCanaryPropsMixin.VPCConfigProperty.Builder of CfnCanaryPropsMixin.VPCConfigProperty