Class: AWSCDK::EC2::CfnSubnet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::ISubnetRef
Defined in:
ec2/cfn_subnet.rb

Overview

Specifies a subnet for the specified VPC.

For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block.

For more information, see Subnets for your VPC in the Amazon VPC User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSubnet

Create a new AWS::EC2::Subnet.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EC2::CfnSubnetProps) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ec2/cfn_subnet.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnSubnetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblN1Ym5ldFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_subnet(resource) ⇒ String

Parameters:

Returns:

  • (String) 


100
101
102
103
 
# File 'ec2/cfn_subnet.rb', line 100

def self.arn_for_subnet(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVN1Ym5ldFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnSubnet", "arnForSubnet", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


220
221
222
 
# File 'ec2/cfn_subnet.rb', line 220

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

.from_subnet_id(scope, id, subnet_id) ⇒ AWSCDK::Interfaces::AWSEC2::ISubnetRef

Creates a new ISubnetRef from a subnetId.

Parameters:

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

Returns:



111
112
113
114
115
116
 
# File 'ec2/cfn_subnet.rb', line 111

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.CfnSubnet", "fromSubnetId", [scope, id, subnet_id])
end

.is_cfn_subnet(x) ⇒ Boolean

Checks whether the given object is a CfnSubnet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


122
123
124
125
 
# File 'ec2/cfn_subnet.rb', line 122

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

.jsii_overridable_methods ⇒ Object 



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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'ec2/cfn_subnet.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_availability_zone => { kind: :property, name: "attrAvailabilityZone", is_optional: false },
    :attr_availability_zone_id => { kind: :property, name: "attrAvailabilityZoneId", is_optional: false },
    :attr_block_public_access_states => { kind: :property, name: "attrBlockPublicAccessStates", is_optional: false },
    :attr_cidr_block => { kind: :property, name: "attrCidrBlock", is_optional: false },
    :attr_ipv6_cidr_blocks => { kind: :property, name: "attrIpv6CidrBlocks", is_optional: false },
    :attr_network_acl_association_id => { kind: :property, name: "attrNetworkAclAssociationId", is_optional: false },
    :attr_outpost_arn => { kind: :property, name: "attrOutpostArn", is_optional: false },
    :attr_subnet_id => { kind: :property, name: "attrSubnetId", is_optional: false },
    :attr_vpc_id => { kind: :property, name: "attrVpcId", is_optional: false },
    :subnet_ref => { kind: :property, name: "subnetRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :private_dns_name_options_on_launch => { kind: :property, name: "privateDnsNameOptionsOnLaunch", is_optional: false },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: false },
    :assign_ipv6_address_on_creation => { kind: :property, name: "assignIpv6AddressOnCreation", is_optional: true },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :availability_zone_id => { kind: :property, name: "availabilityZoneId", is_optional: true },
    :cidr_block => { kind: :property, name: "cidrBlock", is_optional: true },
    :enable_dns64 => { kind: :property, name: "enableDns64", is_optional: true },
    :enable_lni_at_device_index => { kind: :property, name: "enableLniAtDeviceIndex", is_optional: true },
    :ipv4_ipam_pool_id => { kind: :property, name: "ipv4IpamPoolId", is_optional: true },
    :ipv4_netmask_length => { kind: :property, name: "ipv4NetmaskLength", is_optional: true },
    :ipv6_cidr_block => { kind: :property, name: "ipv6CidrBlock", is_optional: true },
    :ipv6_ipam_pool_id => { kind: :property, name: "ipv6IpamPoolId", is_optional: true },
    :ipv6_native => { kind: :property, name: "ipv6Native", is_optional: true },
    :ipv6_netmask_length => { kind: :property, name: "ipv6NetmaskLength", is_optional: true },
    :map_public_ip_on_launch => { kind: :property, name: "mapPublicIpOnLaunch", is_optional: true },
    :outpost_arn => { kind: :property, name: "outpostArn", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



548
549
550
551
 
# File 'ec2/cfn_subnet.rb', line 548

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



560
561
562
563
 
# File 'ec2/cfn_subnet.rb', line 560

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



570
571
572
573
 
# File 'ec2/cfn_subnet.rb', line 570

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



581
582
583
584
585
 
# File 'ec2/cfn_subnet.rb', line 581

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


638
639
640
641
642
 
# File 'ec2/cfn_subnet.rb', line 638

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



648
649
650
651
 
# File 'ec2/cfn_subnet.rb', line 648

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



660
661
662
663
664
 
# File 'ec2/cfn_subnet.rb', line 660

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



673
674
675
676
 
# File 'ec2/cfn_subnet.rb', line 673

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



695
696
697
698
699
700
 
# File 'ec2/cfn_subnet.rb', line 695

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#assign_ipv6_address_on_creation ⇒ Boolean, ...

Indicates whether a network interface created in this subnet receives an IPv6 address.

The default value is false .

Returns:



332
333
334
 
# File 'ec2/cfn_subnet.rb', line 332

def assign_ipv6_address_on_creation()
  jsii_get_property("assignIpv6AddressOnCreation")
end

#assign_ipv6_address_on_creation=(value) ⇒ Object 



336
337
338
339
 
# File 'ec2/cfn_subnet.rb', line 336

def assign_ipv6_address_on_creation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "assignIpv6AddressOnCreation") unless value.nil?
  jsii_set_property("assignIpv6AddressOnCreation", value)
end

#attr_availability_zone ⇒ String

The Availability Zone of this subnet.

For example, us-east-1a .

Returns:

  • (String) 


229
230
231
 
# File 'ec2/cfn_subnet.rb', line 229

def attr_availability_zone()
  jsii_get_property("attrAvailabilityZone")
end

#attr_availability_zone_id ⇒ String

The Availability Zone ID of this subnet.

For example, use1-az1 .

Returns:

  • (String) 


238
239
240
 
# File 'ec2/cfn_subnet.rb', line 238

def attr_availability_zone_id()
  jsii_get_property("attrAvailabilityZoneId")
end

#attr_block_public_access_states ⇒ AWSCDK::IResolvable

Returns:



243
244
245
 
# File 'ec2/cfn_subnet.rb', line 243

def attr_block_public_access_states()
  jsii_get_property("attrBlockPublicAccessStates")
end

#attr_cidr_block ⇒ String

The IPv4 CIDR blocks that are associated with the subnet.

Returns:

  • (String) 


250
251
252
 
# File 'ec2/cfn_subnet.rb', line 250

def attr_cidr_block()
  jsii_get_property("attrCidrBlock")
end

#attr_ipv6_cidr_blocks ⇒ Array<String>

The IPv6 CIDR blocks that are associated with the subnet.

Returns:

  • (Array<String>) 


257
258
259
 
# File 'ec2/cfn_subnet.rb', line 257

def attr_ipv6_cidr_blocks()
  jsii_get_property("attrIpv6CidrBlocks")
end

#attr_network_acl_association_id ⇒ String

The ID of the network ACL that is associated with the subnet's VPC, such as acl-5fb85d36 .

Returns:

  • (String) 


264
265
266
 
# File 'ec2/cfn_subnet.rb', line 264

def attr_network_acl_association_id()
  jsii_get_property("attrNetworkAclAssociationId")
end

#attr_outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String) 


271
272
273
 
# File 'ec2/cfn_subnet.rb', line 271

def attr_outpost_arn()
  jsii_get_property("attrOutpostArn")
end

#attr_subnet_id ⇒ String

The ID of the subnet.

Returns:

  • (String) 


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

def attr_subnet_id()
  jsii_get_property("attrSubnetId")
end

#attr_vpc_id ⇒ String

The ID of the subnet's VPC, such as vpc-11ad4878 .

Returns:

  • (String) 


285
286
287
 
# File 'ec2/cfn_subnet.rb', line 285

def attr_vpc_id()
  jsii_get_property("attrVpcId")
end

#availability_zone ⇒ String?

The Availability Zone of the subnet.

Returns:

  • (String, nil) 


344
345
346
 
# File 'ec2/cfn_subnet.rb', line 344

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



348
349
350
351
 
# File 'ec2/cfn_subnet.rb', line 348

def availability_zone=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZone") unless value.nil?
  jsii_set_property("availabilityZone", value)
end

#availability_zone_id ⇒ String?

The AZ ID of the subnet.

Returns:

  • (String, nil) 


356
357
358
 
# File 'ec2/cfn_subnet.rb', line 356

def availability_zone_id()
  jsii_get_property("availabilityZoneId")
end

#availability_zone_id=(value) ⇒ Object 



360
361
362
363
 
# File 'ec2/cfn_subnet.rb', line 360

def availability_zone_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "availabilityZoneId") unless value.nil?
  jsii_set_property("availabilityZoneId", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



173
174
175
 
# File 'ec2/cfn_subnet.rb', line 173

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'ec2/cfn_subnet.rb', line 178

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


704
705
706
707
 
# File 'ec2/cfn_subnet.rb', line 704

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


190
191
192
 
# File 'ec2/cfn_subnet.rb', line 190

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cidr_block ⇒ String?

The IPv4 CIDR block assigned to the subnet.

Returns:

  • (String, nil) 


368
369
370
 
# File 'ec2/cfn_subnet.rb', line 368

def cidr_block()
  jsii_get_property("cidrBlock")
end

#cidr_block=(value) ⇒ Object 



372
373
374
375
 
# File 'ec2/cfn_subnet.rb', line 372

def cidr_block=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cidrBlock") unless value.nil?
  jsii_set_property("cidrBlock", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


135
136
137
 
# File 'ec2/cfn_subnet.rb', line 135

def creation_stack()
  jsii_get_property("creationStack")
end

#enable_dns64 ⇒ Boolean, ...

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

Returns:



380
381
382
 
# File 'ec2/cfn_subnet.rb', line 380

def enable_dns64()
  jsii_get_property("enableDns64")
end

#enable_dns64=(value) ⇒ Object 



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

def enable_dns64=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableDns64") unless value.nil?
  jsii_set_property("enableDns64", value)
end

#enable_lni_at_device_index ⇒ Numeric?

Indicates the device position for local network interfaces in this subnet.

Returns:

  • (Numeric, nil) 


392
393
394
 
# File 'ec2/cfn_subnet.rb', line 392

def enable_lni_at_device_index()
  jsii_get_property("enableLniAtDeviceIndex")
end

#enable_lni_at_device_index=(value) ⇒ Object 



396
397
398
399
 
# File 'ec2/cfn_subnet.rb', line 396

def enable_lni_at_device_index=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "enableLniAtDeviceIndex") unless value.nil?
  jsii_set_property("enableLniAtDeviceIndex", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



717
718
719
720
721
 
# File 'ec2/cfn_subnet.rb', line 717

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



728
729
730
731
 
# File 'ec2/cfn_subnet.rb', line 728

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



798
799
800
801
 
# File 'ec2/cfn_subnet.rb', line 798

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#ipv4_ipam_pool_id ⇒ String?

An IPv4 IPAM pool ID for the subnet.

Returns:

  • (String, nil) 


404
405
406
 
# File 'ec2/cfn_subnet.rb', line 404

def ipv4_ipam_pool_id()
  jsii_get_property("ipv4IpamPoolId")
end

#ipv4_ipam_pool_id=(value) ⇒ Object 



408
409
410
411
 
# File 'ec2/cfn_subnet.rb', line 408

def ipv4_ipam_pool_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipv4IpamPoolId") unless value.nil?
  jsii_set_property("ipv4IpamPoolId", value)
end

#ipv4_netmask_length ⇒ Numeric?

An IPv4 netmask length for the subnet.

Returns:

  • (Numeric, nil) 


416
417
418
 
# File 'ec2/cfn_subnet.rb', line 416

def ipv4_netmask_length()
  jsii_get_property("ipv4NetmaskLength")
end

#ipv4_netmask_length=(value) ⇒ Object 



420
421
422
423
 
# File 'ec2/cfn_subnet.rb', line 420

def ipv4_netmask_length=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv4NetmaskLength") unless value.nil?
  jsii_set_property("ipv4NetmaskLength", value)
end

#ipv6_cidr_block ⇒ String?

The IPv6 CIDR block.

Returns:

  • (String, nil) 


428
429
430
 
# File 'ec2/cfn_subnet.rb', line 428

def ipv6_cidr_block()
  jsii_get_property("ipv6CidrBlock")
end

#ipv6_cidr_block=(value) ⇒ Object 



432
433
434
435
 
# File 'ec2/cfn_subnet.rb', line 432

def ipv6_cidr_block=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipv6CidrBlock") unless value.nil?
  jsii_set_property("ipv6CidrBlock", value)
end

#ipv6_ipam_pool_id ⇒ String?

An IPv6 IPAM pool ID for the subnet.

Returns:

  • (String, nil) 


440
441
442
 
# File 'ec2/cfn_subnet.rb', line 440

def ipv6_ipam_pool_id()
  jsii_get_property("ipv6IpamPoolId")
end

#ipv6_ipam_pool_id=(value) ⇒ Object 



444
445
446
447
 
# File 'ec2/cfn_subnet.rb', line 444

def ipv6_ipam_pool_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipv6IpamPoolId") unless value.nil?
  jsii_set_property("ipv6IpamPoolId", value)
end

#ipv6_native ⇒ Boolean, ...

Indicates whether this is an IPv6 only subnet.

Returns:



452
453
454
 
# File 'ec2/cfn_subnet.rb', line 452

def ipv6_native()
  jsii_get_property("ipv6Native")
end

#ipv6_native=(value) ⇒ Object 



456
457
458
459
 
# File 'ec2/cfn_subnet.rb', line 456

def ipv6_native=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "ipv6Native") unless value.nil?
  jsii_set_property("ipv6Native", value)
end

#ipv6_netmask_length ⇒ Numeric?

An IPv6 netmask length for the subnet.

Returns:

  • (Numeric, nil) 


464
465
466
 
# File 'ec2/cfn_subnet.rb', line 464

def ipv6_netmask_length()
  jsii_get_property("ipv6NetmaskLength")
end

#ipv6_netmask_length=(value) ⇒ Object 



468
469
470
471
 
# File 'ec2/cfn_subnet.rb', line 468

def ipv6_netmask_length=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ipv6NetmaskLength") unless value.nil?
  jsii_set_property("ipv6NetmaskLength", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


147
148
149
 
# File 'ec2/cfn_subnet.rb', line 147

def logical_id()
  jsii_get_property("logicalId")
end

#map_public_ip_on_launch ⇒ Boolean, ...

Indicates whether instances launched in this subnet receive a public IPv4 address.

The default value is false .

Returns:



478
479
480
 
# File 'ec2/cfn_subnet.rb', line 478

def map_public_ip_on_launch()
  jsii_get_property("mapPublicIpOnLaunch")
end

#map_public_ip_on_launch=(value) ⇒ Object 



482
483
484
485
 
# File 'ec2/cfn_subnet.rb', line 482

def map_public_ip_on_launch=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "mapPublicIpOnLaunch") unless value.nil?
  jsii_set_property("mapPublicIpOnLaunch", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


130
131
132
 
# File 'ec2/cfn_subnet.rb', line 130

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



739
740
741
 
# File 'ec2/cfn_subnet.rb', line 739

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



746
747
748
 
# File 'ec2/cfn_subnet.rb', line 746

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#outpost_arn ⇒ String?

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String, nil) 


490
491
492
 
# File 'ec2/cfn_subnet.rb', line 490

def outpost_arn()
  jsii_get_property("outpostArn")
end

#outpost_arn=(value) ⇒ Object 



494
495
496
497
 
# File 'ec2/cfn_subnet.rb', line 494

def outpost_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outpostArn") unless value.nil?
  jsii_set_property("outpostArn", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



539
540
541
542
 
# File 'ec2/cfn_subnet.rb', line 539

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#private_dns_name_options_on_launch ⇒ Object

The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled.

Returns:

  • (Object) 


306
307
308
 
# File 'ec2/cfn_subnet.rb', line 306

def private_dns_name_options_on_launch()
  jsii_get_property("privateDnsNameOptionsOnLaunch")
end

#private_dns_name_options_on_launch=(value) ⇒ Object 



310
311
312
313
 
# File 'ec2/cfn_subnet.rb', line 310

def private_dns_name_options_on_launch=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "privateDnsNameOptionsOnLaunch")
  jsii_set_property("privateDnsNameOptionsOnLaunch", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


166
167
168
 
# File 'ec2/cfn_subnet.rb', line 166

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



757
758
759
760
 
# File 'ec2/cfn_subnet.rb', line 757

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


764
765
766
767
 
# File 'ec2/cfn_subnet.rb', line 764

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



774
775
776
777
778
 
# File 'ec2/cfn_subnet.rb', line 774

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



783
784
785
 
# File 'ec2/cfn_subnet.rb', line 783

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



156
157
158
 
# File 'ec2/cfn_subnet.rb', line 156

def stack()
  jsii_get_property("stack")
end

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

A reference to a Subnet resource.

Returns:



292
293
294
 
# File 'ec2/cfn_subnet.rb', line 292

def subnet_ref()
  jsii_get_property("subnetRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



299
300
301
 
# File 'ec2/cfn_subnet.rb', line 299

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

Any tags assigned to the subnet.

Returns:



502
503
504
 
# File 'ec2/cfn_subnet.rb', line 502

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



506
507
508
509
510
 
# File 'ec2/cfn_subnet.rb', line 506

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



515
516
517
 
# File 'ec2/cfn_subnet.rb', line 515

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


203
204
205
 
# File 'ec2/cfn_subnet.rb', line 203

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


213
214
215
 
# File 'ec2/cfn_subnet.rb', line 213

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


789
790
791
792
 
# File 'ec2/cfn_subnet.rb', line 789

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_id ⇒ String

The ID of the VPC the subnet is in.

Returns:

  • (String) 


318
319
320
 
# File 'ec2/cfn_subnet.rb', line 318

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object 



322
323
324
325
 
# File 'ec2/cfn_subnet.rb', line 322

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId")
  jsii_set_property("vpcId", value)
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) 


528
529
530
531
532
533
 
# File 'ec2/cfn_subnet.rb', line 528

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