Package software.amazon.awscdk.cxapi

Interface VpcContextResponse

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
VpcContextResponse.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:18.453Z") @Stability(Stable) public interface VpcContextResponse extends software.amazon.jsii.JsiiSerializable
Properties of a discovered 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.cxapi.*;
 VpcContextResponse vpcContextResponse = VpcContextResponse.builder()
         .availabilityZones(List.of("availabilityZones"))
         .vpcId("vpcId")
         // the properties below are optional
         .isolatedSubnetIds(List.of("isolatedSubnetIds"))
         .isolatedSubnetNames(List.of("isolatedSubnetNames"))
         .isolatedSubnetRouteTableIds(List.of("isolatedSubnetRouteTableIds"))
         .ownerAccountId("ownerAccountId")
         .privateSubnetIds(List.of("privateSubnetIds"))
         .privateSubnetNames(List.of("privateSubnetNames"))
         .privateSubnetRouteTableIds(List.of("privateSubnetRouteTableIds"))
         .publicSubnetIds(List.of("publicSubnetIds"))
         .publicSubnetNames(List.of("publicSubnetNames"))
         .publicSubnetRouteTableIds(List.of("publicSubnetRouteTableIds"))
         .region("region")
         .subnetGroups(List.of(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()))
         .vpcCidrBlock("vpcCidrBlock")
         .vpnGatewayId("vpnGatewayId")
         .build();

  • Method Details

    • getAvailabilityZones

      @Stability(Stable) @NotNull List<String> getAvailabilityZones()
      AZs.

    • getVpcId

      @Stability(Stable) @NotNull String getVpcId()
      VPC id.

    • getIsolatedSubnetIds

      @Stability(Stable) @Nullable default List<String> getIsolatedSubnetIds()
      IDs of all isolated subnets.

      Element count: #(availabilityZones) · #(isolatedGroups)

    • getIsolatedSubnetNames

      @Stability(Stable) @Nullable default List<String> getIsolatedSubnetNames()
      Name of isolated subnet groups.

      Element count: #(isolatedGroups)

    • getIsolatedSubnetRouteTableIds

      @Stability(Stable) @Nullable default List<String> getIsolatedSubnetRouteTableIds()
      Route Table IDs of isolated subnet groups.

      Element count: #(availabilityZones) · #(isolatedGroups)

    • getOwnerAccountId

      @Stability(Stable) @Nullable default String getOwnerAccountId()
      The ID of the AWS account that owns the VPC.

      Default: the account id of the parent stack

    • getPrivateSubnetIds

      @Stability(Stable) @Nullable default List<String> getPrivateSubnetIds()
      IDs of all private subnets.

      Element count: #(availabilityZones) · #(privateGroups)

    • getPrivateSubnetNames

      @Stability(Stable) @Nullable default List<String> getPrivateSubnetNames()
      Name of private subnet groups.

      Element count: #(privateGroups)

    • getPrivateSubnetRouteTableIds

      @Stability(Stable) @Nullable default List<String> getPrivateSubnetRouteTableIds()
      Route Table IDs of private subnet groups.

      Element count: #(availabilityZones) · #(privateGroups)

    • getPublicSubnetIds

      @Stability(Stable) @Nullable default List<String> getPublicSubnetIds()
      IDs of all public subnets.

      Element count: #(availabilityZones) · #(publicGroups)

    • getPublicSubnetNames

      @Stability(Stable) @Nullable default List<String> getPublicSubnetNames()
      Name of public subnet groups.

      Element count: #(publicGroups)

    • getPublicSubnetRouteTableIds

      @Stability(Stable) @Nullable default List<String> getPublicSubnetRouteTableIds()
      Route Table IDs of public subnet groups.

      Element count: #(availabilityZones) · #(publicGroups)

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      The region in which the VPC is in.

      Default: - Region of the parent stack

    • getSubnetGroups

      @Stability(Stable) @Nullable default List<VpcSubnetGroup> getSubnetGroups()
      The subnet groups discovered for the given VPC.

      Unlike the above properties, this will include asymmetric subnets, if the VPC has any. This property will only be populated if VpcContextQuery.returnAsymmetricSubnets is true.

      Default: - no subnet groups will be returned unless `VpcContextQuery.returnAsymmetricSubnets` is true

    • getVpcCidrBlock

      @Stability(Stable) @Nullable default String getVpcCidrBlock()
      VPC cidr.

      Default: - CIDR information not available

    • getVpnGatewayId

      @Stability(Stable) @Nullable default String getVpnGatewayId()
      The VPN gateway ID.

    • builder

      @Stability(Stable) static VpcContextResponse.Builder builder()
      Returns:
      a VpcContextResponse.Builder of VpcContextResponse