Class: AWSCDK::CXAPI::VPCContextResponse Deprecated

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cxapi/vpc_context_response.rb

Overview

Deprecated.

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

Properties of a discovered VPC.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(availability_zones:, vpc_id:, isolated_subnet_ids: nil, isolated_subnet_names: nil, isolated_subnet_route_table_ids: nil, owner_account_id: nil, private_subnet_ids: nil, private_subnet_names: nil, private_subnet_route_table_ids: nil, public_subnet_ids: nil, public_subnet_names: nil, public_subnet_route_table_ids: nil, region: nil, subnet_groups: nil, vpc_cidr_block: nil, vpn_gateway_id: nil) ⇒ VPCContextResponse

Returns a new instance of VPCContextResponse.

Parameters:

  • availability_zones (Array<String>) —

    AZs.

  • vpc_id (String) —

    VPC id.

  • isolated_subnet_ids (Array<String>, nil) (defaults to: nil) —

    IDs of all isolated subnets.

  • isolated_subnet_names (Array<String>, nil) (defaults to: nil) —

    Name of isolated subnet groups.

  • isolated_subnet_route_table_ids (Array<String>, nil) (defaults to: nil) —

    Route Table IDs of isolated subnet groups.

  • owner_account_id (String, nil) (defaults to: nil) —

    The ID of the AWS account that owns the VPC.

  • private_subnet_ids (Array<String>, nil) (defaults to: nil) —

    IDs of all private subnets.

  • private_subnet_names (Array<String>, nil) (defaults to: nil) —

    Name of private subnet groups.

  • private_subnet_route_table_ids (Array<String>, nil) (defaults to: nil) —

    Route Table IDs of private subnet groups.

  • public_subnet_ids (Array<String>, nil) (defaults to: nil) —

    IDs of all public subnets.

  • public_subnet_names (Array<String>, nil) (defaults to: nil) —

    Name of public subnet groups.

  • public_subnet_route_table_ids (Array<String>, nil) (defaults to: nil) —

    Route Table IDs of public subnet groups.

  • region (String, nil) (defaults to: nil) —

    The region in which the VPC is in.

  • subnet_groups (Array<AWSCDK::CXAPI::VPCSubnetGroup>, nil) (defaults to: nil) —

    The subnet groups discovered for the given VPC.

  • vpc_cidr_block (String, nil) (defaults to: nil) —

    VPC cidr.

  • vpn_gateway_id (String, nil) (defaults to: nil) —

    The VPN gateway ID.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'cxapi/vpc_context_response.rb', line 25

def initialize(availability_zones:, vpc_id:, isolated_subnet_ids: nil, isolated_subnet_names: nil, isolated_subnet_route_table_ids: nil, owner_account_id: nil, private_subnet_ids: nil, private_subnet_names: nil, private_subnet_route_table_ids: nil, public_subnet_ids: nil, public_subnet_names: nil, public_subnet_route_table_ids: nil, region: nil, subnet_groups: nil, vpc_cidr_block: nil, vpn_gateway_id: nil)
  @availability_zones = availability_zones
  Jsii::Type.check_type(@availability_zones, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "availabilityZones")
  @vpc_id = vpc_id
  Jsii::Type.check_type(@vpc_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId")
  @isolated_subnet_ids = isolated_subnet_ids
  Jsii::Type.check_type(@isolated_subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "isolatedSubnetIds") unless @isolated_subnet_ids.nil?
  @isolated_subnet_names = isolated_subnet_names
  Jsii::Type.check_type(@isolated_subnet_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "isolatedSubnetNames") unless @isolated_subnet_names.nil?
  @isolated_subnet_route_table_ids = isolated_subnet_route_table_ids
  Jsii::Type.check_type(@isolated_subnet_route_table_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "isolatedSubnetRouteTableIds") unless @isolated_subnet_route_table_ids.nil?
  @owner_account_id = 
  Jsii::Type.check_type(@owner_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ownerAccountId") unless @owner_account_id.nil?
  @private_subnet_ids = private_subnet_ids
  Jsii::Type.check_type(@private_subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "privateSubnetIds") unless @private_subnet_ids.nil?
  @private_subnet_names = private_subnet_names
  Jsii::Type.check_type(@private_subnet_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "privateSubnetNames") unless @private_subnet_names.nil?
  @private_subnet_route_table_ids = private_subnet_route_table_ids
  Jsii::Type.check_type(@private_subnet_route_table_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "privateSubnetRouteTableIds") unless @private_subnet_route_table_ids.nil?
  @public_subnet_ids = public_subnet_ids
  Jsii::Type.check_type(@public_subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "publicSubnetIds") unless @public_subnet_ids.nil?
  @public_subnet_names = public_subnet_names
  Jsii::Type.check_type(@public_subnet_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "publicSubnetNames") unless @public_subnet_names.nil?
  @public_subnet_route_table_ids = public_subnet_route_table_ids
  Jsii::Type.check_type(@public_subnet_route_table_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "publicSubnetRouteTableIds") unless @public_subnet_route_table_ids.nil?
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region") unless @region.nil?
  @subnet_groups = subnet_groups.is_a?(Array) ? subnet_groups.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CXAPI::VPCSubnetGroup.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : subnet_groups
  Jsii::Type.check_type(@subnet_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmN4X2FwaS5WcGNTdWJuZXRHcm91cCJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetGroups") unless @subnet_groups.nil?
  @vpc_cidr_block = vpc_cidr_block
  Jsii::Type.check_type(@vpc_cidr_block, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcCidrBlock") unless @vpc_cidr_block.nil?
  @vpn_gateway_id = vpn_gateway_id
  Jsii::Type.check_type(@vpn_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpnGatewayId") unless @vpn_gateway_id.nil?
end

Instance Attribute Details

#availability_zones ⇒ Array<String> (readonly)

AZs.

Returns:

  • (Array<String>) 


63
64
65
 
# File 'cxapi/vpc_context_response.rb', line 63

def availability_zones
  @availability_zones
end

#isolated_subnet_ids ⇒ Array<String>? (readonly)

IDs of all isolated subnets.

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

Returns:

  • (Array<String>, nil) 


73
74
75
 
# File 'cxapi/vpc_context_response.rb', line 73

def isolated_subnet_ids
  @isolated_subnet_ids
end

#isolated_subnet_names ⇒ Array<String>? (readonly)

Name of isolated subnet groups.

Element count: #(isolatedGroups)

Returns:

  • (Array<String>, nil) 


79
80
81
 
# File 'cxapi/vpc_context_response.rb', line 79

def isolated_subnet_names
  @isolated_subnet_names
end

#isolated_subnet_route_table_ids ⇒ Array<String>? (readonly)

Route Table IDs of isolated subnet groups.

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

Returns:

  • (Array<String>, nil) 


85
86
87
 
# File 'cxapi/vpc_context_response.rb', line 85

def isolated_subnet_route_table_ids
  @isolated_subnet_route_table_ids
end

#owner_account_id ⇒ String? (readonly)

Note:

Default: the account id of the parent stack

The ID of the AWS account that owns the VPC.

Returns:

  • (String, nil) 


90
91
92
 
# File 'cxapi/vpc_context_response.rb', line 90

def 
  @owner_account_id
end

#private_subnet_ids ⇒ Array<String>? (readonly)

IDs of all private subnets.

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

Returns:

  • (Array<String>, nil) 


96
97
98
 
# File 'cxapi/vpc_context_response.rb', line 96

def private_subnet_ids
  @private_subnet_ids
end

#private_subnet_names ⇒ Array<String>? (readonly)

Name of private subnet groups.

Element count: #(privateGroups)

Returns:

  • (Array<String>, nil) 


102
103
104
 
# File 'cxapi/vpc_context_response.rb', line 102

def private_subnet_names
  @private_subnet_names
end

#private_subnet_route_table_ids ⇒ Array<String>? (readonly)

Route Table IDs of private subnet groups.

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

Returns:

  • (Array<String>, nil) 


108
109
110
 
# File 'cxapi/vpc_context_response.rb', line 108

def private_subnet_route_table_ids
  @private_subnet_route_table_ids
end

#public_subnet_ids ⇒ Array<String>? (readonly)

IDs of all public subnets.

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

Returns:

  • (Array<String>, nil) 


114
115
116
 
# File 'cxapi/vpc_context_response.rb', line 114

def public_subnet_ids
  @public_subnet_ids
end

#public_subnet_names ⇒ Array<String>? (readonly)

Name of public subnet groups.

Element count: #(publicGroups)

Returns:

  • (Array<String>, nil) 


120
121
122
 
# File 'cxapi/vpc_context_response.rb', line 120

def public_subnet_names
  @public_subnet_names
end

#public_subnet_route_table_ids ⇒ Array<String>? (readonly)

Route Table IDs of public subnet groups.

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

Returns:

  • (Array<String>, nil) 


126
127
128
 
# File 'cxapi/vpc_context_response.rb', line 126

def public_subnet_route_table_ids
  @public_subnet_route_table_ids
end

#region ⇒ String? (readonly)

Note:

Default: - Region of the parent stack

The region in which the VPC is in.

Returns:

  • (String, nil) 


131
132
133
 
# File 'cxapi/vpc_context_response.rb', line 131

def region
  @region
end

#subnet_groups ⇒ Array<AWSCDK::CXAPI::VPCSubnetGroup>? (readonly)

Note:

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.

Returns:



141
142
143
 
# File 'cxapi/vpc_context_response.rb', line 141

def subnet_groups
  @subnet_groups
end

#vpc_cidr_block ⇒ String? (readonly)

Note:

Default: - CIDR information not available

VPC cidr.

Returns:

  • (String, nil) 


146
147
148
 
# File 'cxapi/vpc_context_response.rb', line 146

def vpc_cidr_block
  @vpc_cidr_block
end

#vpc_id ⇒ String (readonly)

VPC id.

Returns:

  • (String) 


67
68
69
 
# File 'cxapi/vpc_context_response.rb', line 67

def vpc_id
  @vpc_id
end

#vpn_gateway_id ⇒ String? (readonly)

The VPN gateway ID.

Returns:

  • (String, nil) 


150
151
152
 
# File 'cxapi/vpc_context_response.rb', line 150

def vpn_gateway_id
  @vpn_gateway_id
end

Class Method Details

.jsii_properties ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'cxapi/vpc_context_response.rb', line 152

def self.jsii_properties
  {
    :availability_zones => "availabilityZones",
    :vpc_id => "vpcId",
    :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 => "subnetGroups",
    :vpc_cidr_block => "vpcCidrBlock",
    :vpn_gateway_id => "vpnGatewayId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'cxapi/vpc_context_response.rb', line 173

def to_jsii
  result = {}
  result.merge!({
    "availabilityZones" => @availability_zones,
    "vpcId" => @vpc_id,
    "isolatedSubnetIds" => @isolated_subnet_ids,
    "isolatedSubnetNames" => @isolated_subnet_names,
    "isolatedSubnetRouteTableIds" => @isolated_subnet_route_table_ids,
    "ownerAccountId" => @owner_account_id,
    "privateSubnetIds" => @private_subnet_ids,
    "privateSubnetNames" => @private_subnet_names,
    "privateSubnetRouteTableIds" => @private_subnet_route_table_ids,
    "publicSubnetIds" => @public_subnet_ids,
    "publicSubnetNames" => @public_subnet_names,
    "publicSubnetRouteTableIds" => @public_subnet_route_table_ids,
    "region" => @region,
    "subnetGroups" => @subnet_groups,
    "vpcCidrBlock" => @vpc_cidr_block,
    "vpnGatewayId" => @vpn_gateway_id,
  })
  result.compact
end