VpcContextResponse
- class aws_cdk.cx_api.VpcContextResponse(*, availability_zones, vpc_id, isolated_subnet_ids=None, isolated_subnet_names=None, isolated_subnet_route_table_ids=None, private_subnet_ids=None, private_subnet_names=None, private_subnet_route_table_ids=None, public_subnet_ids=None, public_subnet_names=None, public_subnet_route_table_ids=None, subnet_groups=None, vpc_cidr_block=None, vpn_gateway_id=None)
Bases:
object
Properties of a discovered VPC.
- Parameters:
availability_zones (
Sequence
[str
]) – AZs.vpc_id (
str
) – VPC id.isolated_subnet_ids (
Optional
[Sequence
[str
]]) – IDs of all isolated subnets. Element count: #(availabilityZones) · #(isolatedGroups)isolated_subnet_names (
Optional
[Sequence
[str
]]) – Name of isolated subnet groups. Element count: #(isolatedGroups)isolated_subnet_route_table_ids (
Optional
[Sequence
[str
]]) – Route Table IDs of isolated subnet groups. Element count: #(availabilityZones) · #(isolatedGroups)private_subnet_ids (
Optional
[Sequence
[str
]]) – IDs of all private subnets. Element count: #(availabilityZones) · #(privateGroups)private_subnet_names (
Optional
[Sequence
[str
]]) – Name of private subnet groups. Element count: #(privateGroups)private_subnet_route_table_ids (
Optional
[Sequence
[str
]]) – Route Table IDs of private subnet groups. Element count: #(availabilityZones) · #(privateGroups)public_subnet_ids (
Optional
[Sequence
[str
]]) – IDs of all public subnets. Element count: #(availabilityZones) · #(publicGroups)public_subnet_names (
Optional
[Sequence
[str
]]) – Name of public subnet groups. Element count: #(publicGroups)public_subnet_route_table_ids (
Optional
[Sequence
[str
]]) – Route Table IDs of public subnet groups. Element count: #(availabilityZones) · #(publicGroups)subnet_groups (
Optional
[Sequence
[Union
[VpcSubnetGroup
,Dict
[str
,Any
]]]]) – 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. Default: - no subnet groups will be returned unless {@link VpcContextQuery.returnAsymmetricSubnets} is truevpc_cidr_block (
Optional
[str
]) – VPC cidr. Default: - CIDR information not availablevpn_gateway_id (
Optional
[str
]) – The VPN gateway ID.
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.cx_api as cx_api vpc_context_response = cx_api.VpcContextResponse( availability_zones=["availabilityZones"], vpc_id="vpcId", # the properties below are optional isolated_subnet_ids=["isolatedSubnetIds"], isolated_subnet_names=["isolatedSubnetNames"], isolated_subnet_route_table_ids=["isolatedSubnetRouteTableIds"], private_subnet_ids=["privateSubnetIds"], private_subnet_names=["privateSubnetNames"], private_subnet_route_table_ids=["privateSubnetRouteTableIds"], public_subnet_ids=["publicSubnetIds"], public_subnet_names=["publicSubnetNames"], public_subnet_route_table_ids=["publicSubnetRouteTableIds"], subnet_groups=[cx_api.VpcSubnetGroup( name="name", subnets=[cx_api.VpcSubnet( availability_zone="availabilityZone", route_table_id="routeTableId", subnet_id="subnetId", # the properties below are optional cidr="cidr" )], type=cx_api.VpcSubnetGroupType.PUBLIC )], vpc_cidr_block="vpcCidrBlock", vpn_gateway_id="vpnGatewayId" )
Attributes
- availability_zones
AZs.
- isolated_subnet_ids
IDs of all isolated subnets.
Element count: #(availabilityZones) · #(isolatedGroups)
- isolated_subnet_names
Name of isolated subnet groups.
Element count: #(isolatedGroups)
- isolated_subnet_route_table_ids
Route Table IDs of isolated subnet groups.
Element count: #(availabilityZones) · #(isolatedGroups)
- private_subnet_ids
IDs of all private subnets.
Element count: #(availabilityZones) · #(privateGroups)
- private_subnet_names
Name of private subnet groups.
Element count: #(privateGroups)
- private_subnet_route_table_ids
Route Table IDs of private subnet groups.
Element count: #(availabilityZones) · #(privateGroups)
- public_subnet_ids
IDs of all public subnets.
Element count: #(availabilityZones) · #(publicGroups)
- public_subnet_names
Name of public subnet groups.
Element count: #(publicGroups)
- public_subnet_route_table_ids
Route Table IDs of public subnet groups.
Element count: #(availabilityZones) · #(publicGroups)
- subnet_groups
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.
- Default:
no subnet groups will be returned unless {@link VpcContextQuery.returnAsymmetricSubnets} is true
- vpc_cidr_block
VPC cidr.
- Default:
CIDR information not available
- vpc_id
VPC id.
- vpn_gateway_id
The VPN gateway ID.