Class: AWSCDK::EC2::Subnet

Inherits:
Resource
  • Object
show all
Includes:
ISubnet
Defined in:
ec2/subnet.rb

Overview

Represents a new VPC subnet resource.

Direct Known Subclasses

PrivateSubnet, PublicSubnet

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Subnet

Returns a new instance of Subnet.

Parameters:



12
13
14
15
16
17
18
 
# File 'ec2/subnet.rb', line 12

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::SubnetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlN1Ym5ldFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_subnet_attributes(scope, id, attrs) ⇒ AWSCDK::EC2::ISubnet

Parameters:

Returns:



60
61
62
63
64
65
66
 
# File 'ec2/subnet.rb', line 60

def self.from_subnet_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::EC2::SubnetAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLlN1Ym5ldEF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Subnet", "fromSubnetAttributes", [scope, id, attrs])
end

.from_subnet_id(scope, id, subnet_id) ⇒ AWSCDK::EC2::ISubnet

Import existing subnet from id.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • subnet_id (String)

Returns:



74
75
76
77
78
79
 
# File 'ec2/subnet.rb', line 74

def self.from_subnet_id(scope, id, subnet_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(subnet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subnetId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Subnet", "fromSubnetId", [scope, id, subnet_id])
end

.is_vpc_subnet(x) ⇒ Boolean

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


83
84
85
86
 
# File 'ec2/subnet.rb', line 83

def self.is_vpc_subnet(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.Subnet", "isVpcSubnet", [x])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
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
 
# File 'ec2/subnet.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: false },
    :dependency_elements => { kind: :property, name: "dependencyElements", is_optional: false },
    :internet_connectivity_established => { kind: :property, name: "internetConnectivityEstablished", is_optional: false },
    :ipv4_cidr_block => { kind: :property, name: "ipv4CidrBlock", is_optional: false },
    :network_acl => { kind: :property, name: "networkAcl", is_optional: false },
    :route_table => { kind: :property, name: "routeTable", is_optional: false },
    :subnet_availability_zone => { kind: :property, name: "subnetAvailabilityZone", is_optional: false },
    :subnet_id => { kind: :property, name: "subnetId", is_optional: false },
    :subnet_ipv6_cidr_blocks => { kind: :property, name: "subnetIpv6CidrBlocks", is_optional: false },
    :subnet_network_acl_association_id => { kind: :property, name: "subnetNetworkAclAssociationId", is_optional: false },
    :subnet_outpost_arn => { kind: :property, name: "subnetOutpostArn", is_optional: false },
    :subnet_ref => { kind: :property, name: "subnetRef", is_optional: false },
    :subnet_vpc_id => { kind: :property, name: "subnetVpcId", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_default_internet_route => { kind: :method, name: "addDefaultInternetRoute", is_optional: false },
    :add_default_nat_route => { kind: :method, name: "addDefaultNatRoute", is_optional: false },
    :add_ipv6_default_egress_only_internet_route => { kind: :method, name: "addIpv6DefaultEgressOnlyInternetRoute", is_optional: false },
    :add_ipv6_default_internet_route => { kind: :method, name: "addIpv6DefaultInternetRoute", is_optional: false },
    :add_ipv6_nat64_route => { kind: :method, name: "addIpv6Nat64Route", is_optional: false },
    :add_route => { kind: :method, name: "addRoute", is_optional: false },
    :associate_network_acl => { kind: :method, name: "associateNetworkAcl", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


134
135
136
 
# File 'ec2/subnet.rb', line 134

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_ec2.Subnet", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_default_internet_route(gateway_id, gateway_attachment) ⇒ void

This method returns an undefined value.

Create a default route that points to a passed IGW, with a dependency on the IGW's attachment to the VPC.

Parameters:

  • gateway_id (String) —

    the logical ID (ref) of the gateway attached to your VPC.

  • gateway_attachment (Constructs::IDependable) —

    the gateway attachment construct to be added as a dependency.



323
324
325
326
327
 
# File 'ec2/subnet.rb', line 323

def add_default_internet_route(gateway_id, gateway_attachment)
  Jsii::Type.check_type(gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayId")
  Jsii::Type.check_type(gateway_attachment, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklEZXBlbmRhYmxlIn0=")), "gatewayAttachment")
  jsii_call_method("addDefaultInternetRoute", [gateway_id, gateway_attachment])
end

#add_default_nat_route(nat_gateway_id) ⇒ void

This method returns an undefined value.

Adds an entry to this subnets route table that points to the passed NATGatewayId.

Parameters:

  • nat_gateway_id (String) —

    The ID of the NAT gateway.



333
334
335
336
 
# File 'ec2/subnet.rb', line 333

def add_default_nat_route(nat_gateway_id)
  Jsii::Type.check_type(nat_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "natGatewayId")
  jsii_call_method("addDefaultNatRoute", [nat_gateway_id])
end

#add_ipv6_default_egress_only_internet_route(gateway_id) ⇒ void

This method returns an undefined value.

Create a default IPv6 route that points to a passed EIGW.

Parameters:

  • gateway_id (String) —

    the logical ID (ref) of the gateway attached to your VPC.



342
343
344
345
 
# File 'ec2/subnet.rb', line 342

def add_ipv6_default_egress_only_internet_route(gateway_id)
  Jsii::Type.check_type(gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayId")
  jsii_call_method("addIpv6DefaultEgressOnlyInternetRoute", [gateway_id])
end

#add_ipv6_default_internet_route(gateway_id) ⇒ void

This method returns an undefined value.

Create a default IPv6 route that points to a passed IGW.

Parameters:

  • gateway_id (String) —

    the logical ID (ref) of the gateway attached to your VPC.



351
352
353
354
 
# File 'ec2/subnet.rb', line 351

def add_ipv6_default_internet_route(gateway_id)
  Jsii::Type.check_type(gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayId")
  jsii_call_method("addIpv6DefaultInternetRoute", [gateway_id])
end

#add_ipv6_nat64_route(nat_gateway_id) ⇒ void

This method returns an undefined value.

Adds an entry to this subnets route table that points to the passed NATGatewayId.

Uses the known 64:ff9b::/96 prefix.

Parameters:

  • nat_gateway_id (String) —

    The ID of the NAT gateway.



362
363
364
365
 
# File 'ec2/subnet.rb', line 362

def add_ipv6_nat64_route(nat_gateway_id)
  Jsii::Type.check_type(nat_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "natGatewayId")
  jsii_call_method("addIpv6Nat64Route", [nat_gateway_id])
end

#add_route(id, options) ⇒ void

This method returns an undefined value.

Adds an entry to this subnets route table.

Parameters:



372
373
374
375
376
377
 
# File 'ec2/subnet.rb', line 372

def add_route(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::EC2::AddRouteOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkFkZFJvdXRlT3B0aW9ucyJ9")), "options")
  jsii_call_method("addRoute", [id, options])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



261
262
263
264
 
# File 'ec2/subnet.rb', line 261

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



278
279
280
281
 
# File 'ec2/subnet.rb', line 278

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#associate_network_acl(id, network_acl) ⇒ void

This method returns an undefined value.

Associate a Network ACL with this subnet.

Parameters:



384
385
386
387
388
 
# File 'ec2/subnet.rb', line 384

def associate_network_acl(id, network_acl)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(network_acl, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklOZXR3b3JrQWNsIn0=")), "networkAcl")
  jsii_call_method("associateNetworkAcl", [id, network_acl])
end

#availability_zone ⇒ String

The Availability Zone the subnet is located in.

Returns:

  • (String) 


141
142
143
 
# File 'ec2/subnet.rb', line 141

def availability_zone()
  jsii_get_property("availabilityZone")
end

#dependency_elements ⇒ Array<Constructs::IDependable>

Parts of this VPC subnet.

Returns:

  • (Array<Constructs::IDependable>) 


148
149
150
 
# File 'ec2/subnet.rb', line 148

def dependency_elements()
  jsii_get_property("dependencyElements")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



106
107
108
 
# File 'ec2/subnet.rb', line 106

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


284
285
286
 
# File 'ec2/subnet.rb', line 284

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


298
299
300
301
302
303
 
# File 'ec2/subnet.rb', line 298

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


313
314
315
316
 
# File 'ec2/subnet.rb', line 313

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#internet_connectivity_established ⇒ Constructs::IDependable

Dependable that can be depended upon to force internet connectivity established on the VPC.

Returns:

  • (Constructs::IDependable) 


155
156
157
 
# File 'ec2/subnet.rb', line 155

def internet_connectivity_established()
  jsii_get_property("internetConnectivityEstablished")
end

#ipv4_cidr_block ⇒ String

The IPv4 CIDR block for this subnet.

Returns:

  • (String) 


162
163
164
 
# File 'ec2/subnet.rb', line 162

def ipv4_cidr_block()
  jsii_get_property("ipv4CidrBlock")
end

#network_acl ⇒ AWSCDK::EC2::INetworkAcl

Network ACL associated with this Subnet.

Upon creation, this is the default ACL which allows all traffic, except explicit DENY entries that you add.

You can replace it with a custom ACL which denies all traffic except the explicit ALLOW entries that you add by creating a NetworkAcl object and calling associate_network_acl().

Returns:



176
177
178
 
# File 'ec2/subnet.rb', line 176

def network_acl()
  jsii_get_property("networkAcl")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


91
92
93
 
# File 'ec2/subnet.rb', line 91

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


120
121
122
 
# File 'ec2/subnet.rb', line 120

def physical_name()
  jsii_get_property("physicalName")
end

#route_table ⇒ AWSCDK::EC2::IRouteTable

The routeTableId attached to this subnet.

Returns:



183
184
185
 
# File 'ec2/subnet.rb', line 183

def route_table()
  jsii_get_property("routeTable")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



127
128
129
 
# File 'ec2/subnet.rb', line 127

def stack()
  jsii_get_property("stack")
end

#subnet_availability_zone ⇒ String

Returns:

  • (String) 


188
189
190
 
# File 'ec2/subnet.rb', line 188

def subnet_availability_zone()
  jsii_get_property("subnetAvailabilityZone")
end

#subnet_id ⇒ String

The subnetId for this particular subnet.

Returns:

  • (String) 


195
196
197
 
# File 'ec2/subnet.rb', line 195

def subnet_id()
  jsii_get_property("subnetId")
end

#subnet_ipv6_cidr_blocks ⇒ Array<String>

Returns:

  • (Array<String>) 


200
201
202
 
# File 'ec2/subnet.rb', line 200

def subnet_ipv6_cidr_blocks()
  jsii_get_property("subnetIpv6CidrBlocks")
end

#subnet_network_acl_association_id ⇒ String

Returns:

  • (String) 


205
206
207
 
# File 'ec2/subnet.rb', line 205

def subnet_network_acl_association_id()
  jsii_get_property("subnetNetworkAclAssociationId")
end

#subnet_outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost for this subnet (if one exists).

Returns:

  • (String) 


212
213
214
 
# File 'ec2/subnet.rb', line 212

def subnet_outpost_arn()
  jsii_get_property("subnetOutpostArn")
end

#subnet_ref ⇒ AWSCDK::Interfaces::AWSEC2::SubnetReference

A reference to a Subnet resource.

Returns:



219
220
221
 
# File 'ec2/subnet.rb', line 219

def subnet_ref()
  jsii_get_property("subnetRef")
end

#subnet_vpc_id ⇒ String

Returns:

  • (String) 


224
225
226
 
# File 'ec2/subnet.rb', line 224

def subnet_vpc_id()
  jsii_get_property("subnetVpcId")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


231
232
233
 
# File 'ec2/subnet.rb', line 231

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


244
245
246
247
248
249
 
# File 'ec2/subnet.rb', line 244

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end