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, owner_account_id=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, region=None, subnet_groups=None, vpc_cidr_block=None, vpn_gateway_id=None)
Bases:
object(deprecated) Properties of a discovered VPC.
- Parameters:
availability_zones (
Sequence[str]) – (deprecated) AZs.vpc_id (
str) – (deprecated) VPC id.isolated_subnet_ids (
Optional[Sequence[str]]) – (deprecated) IDs of all isolated subnets. Element count: #(availabilityZones) · #(isolatedGroups)isolated_subnet_names (
Optional[Sequence[str]]) – (deprecated) Name of isolated subnet groups. Element count: #(isolatedGroups)isolated_subnet_route_table_ids (
Optional[Sequence[str]]) – (deprecated) Route Table IDs of isolated subnet groups. Element count: #(availabilityZones) · #(isolatedGroups)owner_account_id (
Optional[str]) – (deprecated) The ID of the AWS account that owns the VPC. Default: the account id of the parent stackprivate_subnet_ids (
Optional[Sequence[str]]) – (deprecated) IDs of all private subnets. Element count: #(availabilityZones) · #(privateGroups)private_subnet_names (
Optional[Sequence[str]]) – (deprecated) Name of private subnet groups. Element count: #(privateGroups)private_subnet_route_table_ids (
Optional[Sequence[str]]) – (deprecated) Route Table IDs of private subnet groups. Element count: #(availabilityZones) · #(privateGroups)public_subnet_ids (
Optional[Sequence[str]]) – (deprecated) IDs of all public subnets. Element count: #(availabilityZones) · #(publicGroups)public_subnet_names (
Optional[Sequence[str]]) – (deprecated) Name of public subnet groups. Element count: #(publicGroups)public_subnet_route_table_ids (
Optional[Sequence[str]]) – (deprecated) Route Table IDs of public subnet groups. Element count: #(availabilityZones) · #(publicGroups)region (
Optional[str]) – (deprecated) The region in which the VPC is in. Default: - Region of the parent stacksubnet_groups (
Optional[Sequence[Union[VpcSubnetGroup,Dict[str,Any]]]]) – (deprecated) 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 ifVpcContextQuery.returnAsymmetricSubnetsis true. Default: - no subnet groups will be returned unlessVpcContextQuery.returnAsymmetricSubnetsis truevpc_cidr_block (
Optional[str]) – (deprecated) VPC cidr. Default: - CIDR information not availablevpn_gateway_id (
Optional[str]) – (deprecated) The VPN gateway ID.
- Deprecated:
The definition of this type has moved to
@aws-cdk/cloud-assembly-api.- Stability:
deprecated
- 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"], owner_account_id="ownerAccountId", 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"], region="region", 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
(deprecated) AZs.
- Stability:
deprecated
- isolated_subnet_ids
(deprecated) IDs of all isolated subnets.
Element count: #(availabilityZones) · #(isolatedGroups)
- Stability:
deprecated
- isolated_subnet_names
(deprecated) Name of isolated subnet groups.
Element count: #(isolatedGroups)
- Stability:
deprecated
- isolated_subnet_route_table_ids
(deprecated) Route Table IDs of isolated subnet groups.
Element count: #(availabilityZones) · #(isolatedGroups)
- Stability:
deprecated
- owner_account_id
(deprecated) The ID of the AWS account that owns the VPC.
- Default:
the account id of the parent stack
- Stability:
deprecated
- private_subnet_ids
(deprecated) IDs of all private subnets.
Element count: #(availabilityZones) · #(privateGroups)
- Stability:
deprecated
- private_subnet_names
(deprecated) Name of private subnet groups.
Element count: #(privateGroups)
- Stability:
deprecated
- private_subnet_route_table_ids
(deprecated) Route Table IDs of private subnet groups.
Element count: #(availabilityZones) · #(privateGroups)
- Stability:
deprecated
- public_subnet_ids
(deprecated) IDs of all public subnets.
Element count: #(availabilityZones) · #(publicGroups)
- Stability:
deprecated
- public_subnet_names
(deprecated) Name of public subnet groups.
Element count: #(publicGroups)
- Stability:
deprecated
- public_subnet_route_table_ids
(deprecated) Route Table IDs of public subnet groups.
Element count: #(availabilityZones) · #(publicGroups)
- Stability:
deprecated
- region
(deprecated) The region in which the VPC is in.
- Default:
Region of the parent stack
- Stability:
deprecated
- subnet_groups
(deprecated) 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.returnAsymmetricSubnetsis true.- Default:
no subnet groups will be returned unless
VpcContextQuery.returnAsymmetricSubnetsis true
- Stability:
deprecated
- vpc_cidr_block
(deprecated) VPC cidr.
- Default:
CIDR information not available
- Stability:
deprecated
- vpc_id
(deprecated) VPC id.
- Stability:
deprecated
- vpn_gateway_id
(deprecated) The VPN gateway ID.
- Stability:
deprecated