interface VpcContextResponse ⚠️

Language	Type name
.NET	Amazon.CDK.CXAPI.VpcContextResponse
Java	software.amazon.awscdk.cxapi.VpcContextResponse
Python	aws_cdk.cx_api.VpcContextResponse
TypeScript (source)	@aws-cdk/cx-api » VpcContextResponse

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

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 * as cx_api from '@aws-cdk/cx-api';
const vpcContextResponse: cx_api.VpcContextResponse = {
  availabilityZones: ['availabilityZones'],
  vpcId: 'vpcId',

  // the properties below are optional
  isolatedSubnetIds: ['isolatedSubnetIds'],
  isolatedSubnetNames: ['isolatedSubnetNames'],
  isolatedSubnetRouteTableIds: ['isolatedSubnetRouteTableIds'],
  ownerAccountId: 'ownerAccountId',
  privateSubnetIds: ['privateSubnetIds'],
  privateSubnetNames: ['privateSubnetNames'],
  privateSubnetRouteTableIds: ['privateSubnetRouteTableIds'],
  publicSubnetIds: ['publicSubnetIds'],
  publicSubnetNames: ['publicSubnetNames'],
  publicSubnetRouteTableIds: ['publicSubnetRouteTableIds'],
  region: 'region',
  subnetGroups: [{
    name: 'name',
    subnets: [{
      availabilityZone: 'availabilityZone',
      routeTableId: 'routeTableId',
      subnetId: 'subnetId',

      // the properties below are optional
      cidr: 'cidr',
    }],
    type: cx_api.VpcSubnetGroupType.PUBLIC,
  }],
  vpcCidrBlock: 'vpcCidrBlock',
  vpnGatewayId: 'vpnGatewayId',
};

Properties

Name	Type	Description
availabilityZones⚠️	string[]	AZs.
vpcId⚠️	string	VPC id.
isolatedSubnetIds?⚠️	string[]	IDs of all isolated subnets.
isolatedSubnetNames?⚠️	string[]	Name of isolated subnet groups.
isolatedSubnetRouteTableIds?⚠️	string[]	Route Table IDs of isolated subnet groups.
ownerAccountId?⚠️	string	The ID of the AWS account that owns the VPC.
privateSubnetIds?⚠️	string[]	IDs of all private subnets.
privateSubnetNames?⚠️	string[]	Name of private subnet groups.
privateSubnetRouteTableIds?⚠️	string[]	Route Table IDs of private subnet groups.
publicSubnetIds?⚠️	string[]	IDs of all public subnets.
publicSubnetNames?⚠️	string[]	Name of public subnet groups.
publicSubnetRouteTableIds?⚠️	string[]	Route Table IDs of public subnet groups.
region?⚠️	string	The region in which the VPC is in.
subnetGroups?⚠️	VpcSubnetGroup[]	The subnet groups discovered for the given VPC.
vpcCidrBlock?⚠️	string	VPC cidr.
vpnGatewayId?⚠️	string	The VPN gateway ID.

---

availabilityZones⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[]

AZs.

---

vpcId⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string

VPC id.

---

isolatedSubnetIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

IDs of all isolated subnets.

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

---

isolatedSubnetNames?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Name of isolated subnet groups.

Element count: #(isolatedGroups)

---

isolatedSubnetRouteTableIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Route Table IDs of isolated subnet groups.

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

---

ownerAccountId?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string (optional, default: the account id of the parent stack)

The ID of the AWS account that owns the VPC.

---

privateSubnetIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

IDs of all private subnets.

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

---

privateSubnetNames?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Name of private subnet groups.

Element count: #(privateGroups)

---

privateSubnetRouteTableIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Route Table IDs of private subnet groups.

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

---

publicSubnetIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

IDs of all public subnets.

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

---

publicSubnetNames?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Name of public subnet groups.

Element count: #(publicGroups)

---

publicSubnetRouteTableIds?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string[] (optional)

Route Table IDs of public subnet groups.

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

---

region?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string (optional, default: Region of the parent stack)

The region in which the VPC is in.

---

subnetGroups?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: VpcSubnetGroup[] (optional, default: no subnet groups will be returned unless VpcContextQuery.returnAsymmetricSubnets is true)

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.

---

vpcCidrBlock?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string (optional, default: CIDR information not available)

VPC cidr.

---

vpnGatewayId?⚠️

⚠️ Deprecated: The definition of this type has moved to @aws-cdk/cloud-assembly-api.

Type: string (optional)

The VPN gateway ID.