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 |
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'],
privateSubnetIds: ['privateSubnetIds'],
privateSubnetNames: ['privateSubnetNames'],
privateSubnetRouteTableIds: ['privateSubnetRouteTableIds'],
publicSubnetIds: ['publicSubnetIds'],
publicSubnetNames: ['publicSubnetNames'],
publicSubnetRouteTableIds: ['publicSubnetRouteTableIds'],
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 |
---|---|---|
availability | string[] | AZs. |
vpc | string | VPC id. |
isolated | string[] | IDs of all isolated subnets. |
isolated | string[] | Name of isolated subnet groups. |
isolated | string[] | Route Table IDs of isolated subnet groups. |
private | string[] | IDs of all private subnets. |
private | string[] | Name of private subnet groups. |
private | string[] | Route Table IDs of private subnet groups. |
public | string[] | IDs of all public subnets. |
public | string[] | Name of public subnet groups. |
public | string[] | Route Table IDs of public subnet groups. |
subnet | Vpc [] | The subnet groups discovered for the given VPC. |
vpc | string | VPC cidr. |
vpn | string | The VPN gateway ID. |
availabilityZones
Type:
string[]
AZs.
vpcId
Type:
string
VPC id.
isolatedSubnetIds?
Type:
string[]
(optional)
IDs of all isolated subnets.
Element count: #(availabilityZones) · #(isolatedGroups)
isolatedSubnetNames?
Type:
string[]
(optional)
Name of isolated subnet groups.
Element count: #(isolatedGroups)
isolatedSubnetRouteTableIds?
Type:
string[]
(optional)
Route Table IDs of isolated subnet groups.
Element count: #(availabilityZones) · #(isolatedGroups)
privateSubnetIds?
Type:
string[]
(optional)
IDs of all private subnets.
Element count: #(availabilityZones) · #(privateGroups)
privateSubnetNames?
Type:
string[]
(optional)
Name of private subnet groups.
Element count: #(privateGroups)
privateSubnetRouteTableIds?
Type:
string[]
(optional)
Route Table IDs of private subnet groups.
Element count: #(availabilityZones) · #(privateGroups)
publicSubnetIds?
Type:
string[]
(optional)
IDs of all public subnets.
Element count: #(availabilityZones) · #(publicGroups)
publicSubnetNames?
Type:
string[]
(optional)
Name of public subnet groups.
Element count: #(publicGroups)
publicSubnetRouteTableIds?
Type:
string[]
(optional)
Route Table IDs of public subnet groups.
Element count: #(availabilityZones) · #(publicGroups)
subnetGroups?
Type:
Vpc
[]
(optional, default: no subnet groups will be returned unless {@link 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 {@link VpcContextQuery.returnAsymmetricSubnets} is true.
vpcCidrBlock?
Type:
string
(optional, default: CIDR information not available)
VPC cidr.
vpnGatewayId?
Type:
string
(optional)
The VPN gateway ID.