Class: Aws::EC2::Types::Subnet

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::Subnet

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a subnet.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assign_ipv_6_address_on_creation ⇒ Boolean

  Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

• #availability_zone ⇒ String

  The Availability Zone of the subnet.

• #availability_zone_id ⇒ String

  The AZ ID of the subnet.

• #available_ip_address_count ⇒ Integer

  The number of unused private IPv4 addresses in the subnet.

• #cidr_block ⇒ String

  The IPv4 CIDR block assigned to the subnet.

• #customer_owned_ipv_4_pool ⇒ String

  The customer-owned IPv4 address pool associated with the subnet.

• #default_for_az ⇒ Boolean

  Indicates whether this is the default subnet for the Availability Zone.

• #enable_dns_64 ⇒ Boolean

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

• #enable_lni_at_device_index ⇒ Integer

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

• #ipv_6_cidr_block_association_set ⇒ Array<Types::SubnetIpv6CidrBlockAssociation>

  Information about the IPv6 CIDR blocks associated with the subnet.

• #ipv_6_native ⇒ Boolean

  Indicates whether this is an IPv6 only subnet.

• #map_customer_owned_ip_on_launch ⇒ Boolean

  Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

• #map_public_ip_on_launch ⇒ Boolean

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

• #outpost_arn ⇒ String

  The Amazon Resource Name (ARN) of the Outpost.

• #owner_id ⇒ String

  The ID of the Amazon Web Services account that owns the subnet.

• #private_dns_name_options_on_launch ⇒ Types::PrivateDnsNameOptionsOnLaunch

  The type of hostnames to assign to instances in the subnet at launch.

• #state ⇒ String

  The current state of the subnet.

• #subnet_arn ⇒ String

  The Amazon Resource Name (ARN) of the subnet.

• #subnet_id ⇒ String

  The ID of the subnet.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the subnet.

• #vpc_id ⇒ String

  The ID of the VPC the subnet is in.

Instance Attribute Details

#assign_ipv_6_address_on_creation ⇒ Boolean

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone of the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ String

The AZ ID of the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#available_ip_address_count ⇒ Integer

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#cidr_block ⇒ String

The IPv4 CIDR block assigned to the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#customer_owned_ipv_4_pool ⇒ String

The customer-owned IPv4 address pool associated with the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#default_for_az ⇒ Boolean

Indicates whether this is the default subnet for the Availability Zone.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#enable_dns_64 ⇒ 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:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#enable_lni_at_device_index ⇒ Integer

Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_cidr_block_association_set ⇒ Array<Types::SubnetIpv6CidrBlockAssociation>

Information about the IPv6 CIDR blocks associated with the subnet.

Returns:

• (Array<Types::SubnetIpv6CidrBlockAssociation>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#ipv_6_native ⇒ Boolean

Indicates whether this is an IPv6 only subnet.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#map_customer_owned_ip_on_launch ⇒ Boolean

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#map_public_ip_on_launch ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

The ID of the Amazon Web Services account that owns the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#private_dns_name_options_on_launch ⇒ Types::PrivateDnsNameOptionsOnLaunch

The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.

Returns:

• (Types::PrivateDnsNameOptionsOnLaunch)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The current state of the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_arn ⇒ String

The Amazon Resource Name (ARN) of the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ String

The ID of the subnet.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the subnet.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The ID of the VPC the subnet is in.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 59224

class Subnet < Struct.new(
  :availability_zone,
  :availability_zone_id,
  :available_ip_address_count,
  :cidr_block,
  :default_for_az,
  :enable_lni_at_device_index,
  :map_public_ip_on_launch,
  :map_customer_owned_ip_on_launch,
  :customer_owned_ipv_4_pool,
  :state,
  :subnet_id,
  :vpc_id,
  :owner_id,
  :assign_ipv_6_address_on_creation,
  :ipv_6_cidr_block_association_set,
  :tags,
  :subnet_arn,
  :outpost_arn,
  :enable_dns_64,
  :ipv_6_native,
  :private_dns_name_options_on_launch)
  SENSITIVE = []
  include Aws::Structure
end