Package software.amazon.awscdk.cxapi

Interface VpcSubnetGroup

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VpcSubnetGroup.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:54.747Z")
@Stability(Stable)
public interface VpcSubnetGroup
extends software.amazon.jsii.JsiiSerializable

A group of subnets returned by the VPC provider.

The included subnets do NOT have to be symmetric!

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cxapi.*;
 VpcSubnetGroup vpcSubnetGroup = VpcSubnetGroup.builder()
         .name("name")
         .subnets(List.of(VpcSubnet.builder()
                 .availabilityZone("availabilityZone")
                 .routeTableId("routeTableId")
                 .subnetId("subnetId")
                 // the properties below are optional
                 .cidr("cidr")
                 .build()))
         .type(VpcSubnetGroupType.PUBLIC)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VpcSubnetGroup.Builder	builder()
String	getName()	The name of the subnet group, determined by looking at the tags of of the subnets that belong to it.
List<VpcSubnet>	getSubnets()	The subnets that are part of this group.
VpcSubnetGroupType	getType()	The type of the subnet group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the subnet group, determined by looking at the tags of of the subnets that belong to it.

getSubnets

@Stability(Stable)
@NotNull
List<VpcSubnet> getSubnets()

The subnets that are part of this group.

There is no condition that the subnets have to be symmetric in the group.

getType

@Stability(Stable)
@NotNull
VpcSubnetGroupType getType()

The type of the subnet group.

builder

@Stability(Stable)
static VpcSubnetGroup.Builder builder()

Returns:

a VpcSubnetGroup.Builder of VpcSubnetGroup