Class: Aws::EC2::Subnet

Inherits:

Object

Object
Aws::EC2::Subnet

show all

Defined in:: gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

#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.
#id ⇒ String (also: #subnet_id)
#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.
#tags ⇒ Array<Types::Tag>
Any tags assigned to the subnet.
#vpc_id ⇒ String
The ID of the VPC the subnet is in.

Actions collapse

#create_instances(options = {}) ⇒ Instance::Collection
#create_network_interface(options = {}) ⇒ NetworkInterface
#create_tags(options = {}) ⇒ Tag::Collection
#delete(options = {}) ⇒ EmptyStructure
#delete_tags(options = {}) ⇒ Tag::Collection

Associations collapse

#instances(options = {}) ⇒ Instance::Collection
#nat_gateways(options = {}) ⇒ NatGateway::Collection
#network_interfaces(options = {}) ⇒ NetworkInterface::Collection
#vpc ⇒ Vpc^?

Instance Method Summary collapse

#client ⇒ Client
#data ⇒ Types::Subnet
Returns the data for this Subnet.
#data_loaded? ⇒ Boolean
Returns true if this resource is loaded.
#initialize(*args) ⇒ Subnet constructor
A new instance of Subnet.
#load ⇒ self (also: #reload)
Loads, or reloads #data for the current Subnet.
#wait_until(options = {}) {|resource| ... } ⇒ Resource deprecated Deprecated.
Use [Aws::EC2::Client] #wait_until instead

Constructor Details

#initialize(id, options = {}) ⇒ `Subnet` #initialize(options = {}) ⇒ `Subnet`

Returns a new instance of Subnet.

Overloads:

#initialize(id, options = {}) ⇒ Subnet
Parameters:
- id (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ Subnet
Options Hash (options):
- :id (required, String)
- :client (Client)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method 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)



121
122
123

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 121

def assign_ipv_6_address_on_creation
  data[:assign_ipv_6_address_on_creation]
end

#availability_zone ⇒ `String`

The Availability Zone of the subnet.

Returns:

(String)



40
41
42

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 40

def availability_zone
  data[:availability_zone]
end

#availability_zone_id ⇒ `String`

The AZ ID of the subnet.

Returns:

(String)



46
47
48

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 46

def availability_zone_id
  data[:availability_zone_id]
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)



53
54
55

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 53

def available_ip_address_count
  data[:available_ip_address_count]
end

#cidr_block ⇒ `String`

The IPv4 CIDR block assigned to the subnet.

Returns:

(String)



59
60
61

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 59

def cidr_block
  data[:cidr_block]
end

#client ⇒ `Client`

Returns:

(Client)



174
175
176

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 174

def client
  @client
end

#create_instances(options = {}) ⇒ `Instance::Collection`

Examples:

Request syntax with placeholder values


instance = subnet.create_instances({
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "SnapshotId",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
        kms_key_id: "String",
        throughput: 1,
        outpost_arn: "String",
        encrypted: false,
      },
      no_device: "String",
    },
  ],
  image_id: "ImageId",
  instance_type: "a1.medium", # accepts a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6g.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gd.metal, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, c6i.large, c6i.xlarge, c6i.2xlarge, c6i.4xlarge, c6i.8xlarge, c6i.12xlarge, c6i.16xlarge, c6i.24xlarge, c6i.32xlarge, c6i.metal, cc1.4xlarge, cc2.8xlarge, cg1.4xlarge, cr1.8xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, dl1.24xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.xlarge, g4ad.2xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, g5.xlarge, g5.2xlarge, g5.4xlarge, g5.8xlarge, g5.12xlarge, g5.16xlarge, g5.24xlarge, g5.48xlarge, g5g.xlarge, g5g.2xlarge, g5g.4xlarge, g5g.8xlarge, g5g.16xlarge, g5g.metal, hi1.4xlarge, hpc6a.48xlarge, hs1.8xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, im4gn.large, im4gn.xlarge, im4gn.2xlarge, im4gn.4xlarge, im4gn.8xlarge, im4gn.16xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, is4gen.medium, is4gen.large, is4gen.xlarge, is4gen.2xlarge, is4gen.4xlarge, is4gen.8xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, m6a.large, m6a.xlarge, m6a.2xlarge, m6a.4xlarge, m6a.8xlarge, m6a.12xlarge, m6a.16xlarge, m6a.24xlarge, m6a.32xlarge, m6a.48xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, m6i.large, m6i.xlarge, m6i.2xlarge, m6i.4xlarge, m6i.8xlarge, m6i.12xlarge, m6i.16xlarge, m6i.24xlarge, m6i.32xlarge, m6i.metal, mac1.metal, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6g.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, r6gd.metal, r6i.large, r6i.xlarge, r6i.2xlarge, r6i.4xlarge, r6i.8xlarge, r6i.12xlarge, r6i.16xlarge, r6i.24xlarge, r6i.32xlarge, r6i.metal, t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, vt1.3xlarge, vt1.6xlarge, vt1.24xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, x2iezn.2xlarge, x2iezn.4xlarge, x2iezn.6xlarge, x2iezn.8xlarge, x2iezn.12xlarge, x2iezn.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, x2idn.16xlarge, x2idn.24xlarge, x2idn.32xlarge, x2iedn.xlarge, x2iedn.2xlarge, x2iedn.4xlarge, x2iedn.8xlarge, x2iedn.16xlarge, x2iedn.24xlarge, x2iedn.32xlarge, c6a.large, c6a.xlarge, c6a.2xlarge, c6a.4xlarge, c6a.8xlarge, c6a.12xlarge, c6a.16xlarge, c6a.24xlarge, c6a.32xlarge, c6a.48xlarge, c6a.metal, m6a.metal, i4i.large, i4i.xlarge, i4i.2xlarge, i4i.4xlarge, i4i.8xlarge, i4i.16xlarge, i4i.32xlarge, i4i.metal, x2idn.metal, x2iedn.metal, c7g.medium, c7g.large, c7g.xlarge, c7g.2xlarge, c7g.4xlarge, c7g.8xlarge, c7g.12xlarge, c7g.16xlarge
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  kernel_id: "KernelId",
  key_name: "KeyPairName",
  max_count: 1, # required
  min_count: 1, # required
  monitoring: {
    enabled: false, # required
  },
  placement: {
    availability_zone: "String",
    affinity: "String",
    group_name: "PlacementGroupName",
    partition_number: 1,
    host_id: "String",
    tenancy: "default", # accepts default, dedicated, host
    spread_domain: "String",
    host_resource_group_arn: "String",
  },
  ramdisk_id: "RamdiskId",
  security_group_ids: ["SecurityGroupId"],
  security_groups: ["SecurityGroupName"],
  user_data: "RunInstancesUserData",
  additional_info: "String",
  client_token: "String",
  disable_api_termination: false,
  dry_run: false,
  ebs_optimized: false,
  iam_instance_profile: {
    arn: "String",
    name: "String",
  },
  instance_initiated_shutdown_behavior: "stop", # accepts stop, terminate
  network_interfaces: [
    {
      associate_public_ip_address: false,
      delete_on_termination: false,
      description: "String",
      device_index: 1,
      groups: ["SecurityGroupId"],
      ipv_6_address_count: 1,
      ipv_6_addresses: [
        {
          ipv_6_address: "String",
        },
      ],
      network_interface_id: "NetworkInterfaceId",
      private_ip_address: "String",
      private_ip_addresses: [
        {
          primary: false,
          private_ip_address: "String",
        },
      ],
      secondary_private_ip_address_count: 1,
      subnet_id: "String",
      associate_carrier_ip_address: false,
      interface_type: "String",
      network_card_index: 1,
      ipv_4_prefixes: [
        {
          ipv_4_prefix: "String",
        },
      ],
      ipv_4_prefix_count: 1,
      ipv_6_prefixes: [
        {
          ipv_6_prefix: "String",
        },
      ],
      ipv_6_prefix_count: 1,
    },
  ],
  private_ip_address: "String",
  elastic_gpu_specification: [
    {
      type: "String", # required
    },
  ],
  elastic_inference_accelerators: [
    {
      type: "String", # required
      count: 1,
    },
  ],
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  launch_template: {
    launch_template_id: "LaunchTemplateId",
    launch_template_name: "String",
    version: "String",
  },
  instance_market_options: {
    market_type: "spot", # accepts spot
    spot_options: {
      max_price: "String",
      spot_instance_type: "one-time", # accepts one-time, persistent
      block_duration_minutes: 1,
      valid_until: Time.now,
      instance_interruption_behavior: "hibernate", # accepts hibernate, stop, terminate
    },
  },
  credit_specification: {
    cpu_credits: "String", # required
  },
  cpu_options: {
    core_count: 1,
    threads_per_core: 1,
  },
  capacity_reservation_specification: {
    capacity_reservation_preference: "open", # accepts open, none
    capacity_reservation_target: {
      capacity_reservation_id: "CapacityReservationId",
      capacity_reservation_resource_group_arn: "String",
    },
  },
  hibernation_options: {
    configured: false,
  },
  license_specifications: [
    {
      license_configuration_arn: "String",
    },
  ],
  metadata_options: {
    http_tokens: "optional", # accepts optional, required
    http_put_response_hop_limit: 1,
    http_endpoint: "disabled", # accepts disabled, enabled
    http_protocol_ipv_6: "disabled", # accepts disabled, enabled
    instance_metadata_tags: "disabled", # accepts disabled, enabled
  },
  enclave_options: {
    enabled: false,
  },
  private_dns_name_options: {
    hostname_type: "ip-name", # accepts ip-name, resource-name
    enable_resource_name_dns_a_record: false,
    enable_resource_name_dns_aaaa_record: false,
  },
  maintenance_options: {
    auto_recovery: "disabled", # accepts disabled, default
  },
  disable_api_stop: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:block_device_mappings (Array<Types::BlockDeviceMapping>) —
The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.
:image_id (String) —
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
:instance_type (String) —
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.

Default: m1.small
:ipv_6_address_count (Integer) —
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.
:ipv_6_addresses (Array<Types::InstanceIpv6Address>) —
[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.
:kernel_id (String) —
The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
:key_name (String) —
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
:max_count (required, Integer) —
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
:min_count (required, Integer) —
The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
:monitoring (Types::RunInstancesMonitoringEnabled) —
Specifies whether detailed monitoring is enabled for the instance.
:placement (Types::Placement) —
The placement for the instance.
:ramdisk_id (String) —
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
:security_group_ids (Array<String>) —
The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.
:security_groups (Array<String>) —
[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.
:user_data (String) —
The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
:additional_info (String) —
Reserved.
:client_token (String) —
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters
:disable_api_termination (Boolean) —
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false
:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:ebs_optimized (Boolean) —
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false
:iam_instance_profile (Types::IamInstanceProfileSpecification) —
The name or Amazon Resource Name (ARN) of an IAM instance profile.
:instance_initiated_shutdown_behavior (String) —
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop
:network_interfaces (Array<Types::InstanceNetworkInterfaceSpecification>) —
The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
:private_ip_address (String) —
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.
:elastic_gpu_specification (Array<Types::ElasticGpuSpecification>) —
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.
:elastic_inference_accelerators (Array<Types::ElasticInferenceAccelerator>) —
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

You cannot specify accelerators from different generations in the same request.
:tag_specifications (Array<Types::TagSpecification>) —
The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
:launch_template (Types::LaunchTemplateSpecification) —
The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.
:instance_market_options (Types::InstanceMarketOptionsRequest) —
The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
:credit_specification (Types::CreditSpecificationRequest) —
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

For T3 instances with host tenancy, only standard is supported.
:cpu_options (Types::CpuOptionsRequest) —
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
:capacity_reservation_specification (Types::CapacityReservationSpecification) —
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
:hibernation_options (Types::HibernationOptionsRequest) —
Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

You can't enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
:license_specifications (Array<Types::LicenseConfigurationRequest>) —
The license configurations.
:metadata_options (Types::InstanceMetadataOptionsRequest) —
The metadata options for the instance. For more information, see Instance metadata and user data.
:enclave_options (Types::EnclaveOptionsRequest) —
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
:private_dns_name_options (Types::PrivateDnsNameOptionsRequest) —
The options for the instance hostname. The default values are inherited from the subnet.
:maintenance_options (Types::InstanceMaintenanceOptionsRequest) —
The maintenance and recovery options for the instance.
:disable_api_stop (Boolean) —
Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

Returns:

(Instance::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 797

def create_instances(options = {})
  batch = []
  options = options.merge(subnet_id: @id)
  resp = @client.run_instances(options)
  resp.data.instances.each do |i|
    batch << Instance.new(
      id: i.instance_id,
      data: i,
      client: @client
    )
  end
  Instance::Collection.new([batch], size: batch.size)
end

#create_network_interface(options = {}) ⇒ `NetworkInterface`

Examples:

Request syntax with placeholder values


networkinterface = subnet.create_network_interface({
  description: "String",
  dry_run: false,
  groups: ["SecurityGroupId"],
  ipv_6_address_count: 1,
  ipv_6_addresses: [
    {
      ipv_6_address: "String",
    },
  ],
  private_ip_address: "String",
  private_ip_addresses: [
    {
      primary: false,
      private_ip_address: "String",
    },
  ],
  secondary_private_ip_address_count: 1,
  ipv_4_prefixes: [
    {
      ipv_4_prefix: "String",
    },
  ],
  ipv_4_prefix_count: 1,
  ipv_6_prefixes: [
    {
      ipv_6_prefix: "String",
    },
  ],
  ipv_6_prefix_count: 1,
  interface_type: "efa", # accepts efa, branch, trunk
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-endpoint, vpc-endpoint-service, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  client_token: "String",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:description (String) —
A description for the network interface.
:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:groups (Array<String>) —
The IDs of one or more security groups.
:ipv_6_address_count (Integer) —
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.
:ipv_6_addresses (Array<Types::InstanceIpv6Address>) —
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
:private_ip_address (String) —
The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
:private_ip_addresses (Array<Types::PrivateIpAddressSpecification>) —
One or more private IPv4 addresses.
:secondary_private_ip_address_count (Integer) —
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
:ipv_4_prefixes (Array<Types::Ipv4PrefixSpecificationRequest>) —
One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
:ipv_4_prefix_count (Integer) —
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
:ipv_6_prefixes (Array<Types::Ipv6PrefixSpecificationRequest>) —
One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
:ipv_6_prefix_count (Integer) —
The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
:interface_type (String) —
The type of network interface. The default is interface.

The only supported values are efa and trunk.
:tag_specifications (Array<Types::TagSpecification>) —
The tags to apply to the new network interface.
:client_token (String) —
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Returns:

(NetworkInterface)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 929

def create_network_interface(options = {})
  options = options.merge(subnet_id: @id)
  resp = @client.create_network_interface(options)
  NetworkInterface.new(
    id: resp.data.network_interface.network_interface_id,
    data: resp.data.network_interface,
    client: @client
  )
end

#create_tags(options = {}) ⇒ `Tag::Collection`

Examples:

Request syntax with placeholder values


tag = subnet.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:tags (required, Array<Types::Tag>) —
The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:

(Tag::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 961

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.create_tags(options)
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#customer_owned_ipv_4_pool ⇒ `String`

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

Returns:

(String)



95
96
97

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 95

def customer_owned_ipv_4_pool
  data[:customer_owned_ipv_4_pool]
end

#data ⇒ `Types::Subnet`

Returns the data for this Aws::EC2::Subnet. Calls Client#describe_subnets if #data_loaded? is false.

Returns:

(Types::Subnet) —
Returns the data for this Aws::EC2::Subnet. Calls Client#describe_subnets if #data_loaded? is false.

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 194

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



202
203
204

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 202

def data_loaded?
  !!@data
end

#default_for_az ⇒ `Boolean`

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

Returns:

(Boolean)



66
67
68

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 66

def default_for_az
  data[:default_for_az]
end

#delete(options = {}) ⇒ `EmptyStructure`

Examples:

Request syntax with placeholder values


subnet.delete({
  dry_run: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

(EmptyStructure)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1033

def delete(options = {})
  options = options.merge(subnet_id: @id)
  resp = @client.delete_subnet(options)
  resp.data
end

#delete_tags(options = {}) ⇒ `Tag::Collection`

Examples:

Request syntax with placeholder values


tag = subnet.delete_tags({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:tags (Array<Types::Tag>) —
The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

Constraints: Up to 1000 tags.

Returns:

(Tag::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1006

def delete_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.delete_tags(options)
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
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)



153
154
155

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 153

def enable_dns_64
  data[:enable_dns_64]
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)



74
75
76

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 74

def enable_lni_at_device_index
  data[:enable_lni_at_device_index]
end

#id ⇒ `String` Also known as: subnet_id

Returns:

(String)



33
34
35

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 33

def id
  @id
end

#instances(options = {}) ⇒ `Instance::Collection`

Examples:

Request syntax with placeholder values


instances = subnet.instances({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_ids: ["InstanceId"],
  dry_run: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:filters (Array<Types::Filter>) —
The filters.
- affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
- architecture - The instance architecture (i386 | x86_64 | arm64).
- availability-zone - The Availability Zone of the instance.
- block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
- block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
- block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
- block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
- block-device-mapping.volume-id - The volume ID of the EBS volume.
- capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
- client-token - The idempotency token you provided when you launched the instance.
- dns-name - The public DNS name of the instance.
- group-id - The ID of the security group for the instance. EC2-Classic only.
- group-name - The name of the security group for the instance. EC2-Classic only.
- hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
- host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
- hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
- iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
- image-id - The ID of the image used to launch the instance.
- instance-id - The ID of the instance.
- instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
- instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
- instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
- instance-type - The type of instance (for example, t2.micro).
- instance.group-id - The ID of the security group for the instance.
- instance.group-name - The name of the security group for the instance.
- ip-address - The public IPv4 address of the instance.
- kernel-id - The kernel ID.
- key-name - The name of the key pair used when the instance was launched.
- launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
- launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
- metadata-options.http-tokens - The metadata request authorization state (optional | required)
- metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
- metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
- monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
- network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
- network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
- network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
- network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
- network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
- network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
- network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
- network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
- network-interface.attachment.attachment-id - The ID of the interface attachment.
- network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
- network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
- network-interface.attachment.device-index - The device index to which the network interface is attached.
- network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
- network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
- network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
- network-interface.availability-zone - The Availability Zone for the network interface.
- network-interface.description - The description of the network interface.
- network-interface.group-id - The ID of a security group associated with the network interface.
- network-interface.group-name - The name of a security group associated with the network interface.
- network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
- network-interface.mac-address - The MAC address of the network interface.
- network-interface.network-interface-id - The ID of the network interface.
- network-interface.owner-id - The ID of the owner of the network interface.
- network-interface.private-dns-name - The private DNS name of the network interface.
- network-interface.requester-id - The requester ID for the network interface.
- network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
- network-interface.status - The status of the network interface (available) | in-use).
- network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
- network-interface.subnet-id - The ID of the subnet for the network interface.
- network-interface.vpc-id - The ID of the VPC for the network interface.
- outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- owner-id - The Amazon Web Services account ID of the instance owner.
- placement-group-name - The name of the placement group for the instance.
- placement-partition-number - The partition in which the instance is located.
- platform - The platform. To list only Windows instances, use windows.
- private-dns-name - The private IPv4 DNS name of the instance.
- private-ip-address - The private IPv4 address of the instance.
- product-code - The product code associated with the AMI used to launch the instance.
- product-code.type - The type of product code (devpay | marketplace).
- ramdisk-id - The RAM disk ID.
- reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
- requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
- reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
- root-device-name - The device name of the root device volume (for example, /dev/sda1).
- root-device-type - The type of the root device volume (ebs | instance-store).
- source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
- spot-instance-request-id - The ID of the Spot Instance request.
- state-reason-code - The reason code for the state change.
- state-reason-message - A message that describes the state change.
- subnet-id - The ID of the subnet for the instance.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
- tenancy - The tenancy of an instance (dedicated | default | host).
- virtualization-type - The virtualization type of the instance (paravirtual | hvm).
- vpc-id - The ID of the VPC that the instance is running in.
:instance_ids (Array<String>) —
The instance IDs.

Default: Describes all your instances.
:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

(Instance::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1347

def instances(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filters: [{
      name: "subnet-id",
      values: [@id]
    }])
    resp = @client.describe_instances(options)
    resp.each_page do |page|
      batch = []
      page.data.reservations.each do |r|
        r.instances.each do |i|
          batch << Instance.new(
            id: i.instance_id,
            data: i,
            client: @client
          )
        end
      end
      y.yield(batch)
    end
  end
  Instance::Collection.new(batches)
end

#ipv_6_cidr_block_association_set ⇒ `Array<Types::SubnetIpv6CidrBlockAssociation>`

Information about the IPv6 CIDR blocks associated with the subnet.

Returns:

(Array<Types::SubnetIpv6CidrBlockAssociation>)



127
128
129

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 127

def ipv_6_cidr_block_association_set
  data[:ipv_6_cidr_block_association_set]
end

#ipv_6_native ⇒ `Boolean`

Indicates whether this is an IPv6 only subnet.

Returns:

(Boolean)



159
160
161

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 159

def ipv_6_native
  data[:ipv_6_native]
end

#load ⇒ `self` Also known as: reload

Loads, or reloads #data for the current Aws::EC2::Subnet. Returns self making it possible to chain methods.

subnet.reload.data

Returns:

(self)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 184

def load
  resp = @client.describe_subnets(subnet_ids: [@id])
  @data = resp.subnets[0]
  self
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)



89
90
91

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 89

def map_customer_owned_ip_on_launch
  data[:map_customer_owned_ip_on_launch]
end

#map_public_ip_on_launch ⇒ `Boolean`

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

Returns:

(Boolean)



81
82
83

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 81

def map_public_ip_on_launch
  data[:map_public_ip_on_launch]
end

#nat_gateways(options = {}) ⇒ `NatGateway::Collection`

Examples:

Request syntax with placeholder values


nat_gateways = subnet.nat_gateways({
  dry_run: false,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  nat_gateway_ids: ["NatGatewayId"],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:filter (Array<Types::Filter>) —
One or more filters.
- nat-gateway-id - The ID of the NAT gateway.
- state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
- subnet-id - The ID of the subnet in which the NAT gateway resides.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- vpc-id - The ID of the VPC in which the NAT gateway resides.
:nat_gateway_ids (Array<String>) —
One or more NAT gateway IDs.

Returns:

(NatGateway::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1413

def nat_gateways(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filter: [{
      name: "subnet-id",
      values: [@id]
    }])
    resp = @client.describe_nat_gateways(options)
    resp.each_page do |page|
      batch = []
      page.data.nat_gateways.each do |n|
        batch << NatGateway.new(
          id: n.nat_gateway_id,
          data: n,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  NatGateway::Collection.new(batches)
end

#network_interfaces(options = {}) ⇒ `NetworkInterface::Collection`

Examples:

Request syntax with placeholder values


network_interfaces = subnet.network_interfaces({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  network_interface_ids: ["NetworkInterfaceId"],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:filters (Array<Types::Filter>) —
One or more filters.
- addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
- addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
- addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
- addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
- association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
- association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
- association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
- association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
- association.public-dns-name - The public DNS name for the network interface (IPv4).
- attachment.attachment-id - The ID of the interface attachment.
- attachment.attach-time - The time that the network interface was attached to an instance.
- attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
- attachment.device-index - The device index to which the network interface is attached.
- attachment.instance-id - The ID of the instance to which the network interface is attached.
- attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
- attachment.status - The status of the attachment (attaching | attached | detaching | detached).
- availability-zone - The Availability Zone of the network interface.
- description - The description of the network interface.
- group-id - The ID of a security group associated with the network interface.
- group-name - The name of a security group associated with the network interface.
- ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
- interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
- mac-address - The MAC address of the network interface.
- network-interface-id - The ID of the network interface.
- owner-id - The Amazon Web Services account ID of the network interface owner.
- private-ip-address - The private IPv4 address or addresses of the network interface.
- private-dns-name - The private DNS name of the network interface (IPv4).
- requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
- requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
- source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
- status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
- subnet-id - The ID of the subnet for the network interface.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- vpc-id - The ID of the VPC for the network interface.
:dry_run (Boolean) —
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
:network_interface_ids (Array<String>) —
One or more network interface IDs.

Default: Describes all your network interfaces.

Returns:

(NetworkInterface::Collection)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1575

def network_interfaces(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filters: [{
      name: "subnet-id",
      values: [@id]
    }])
    resp = @client.describe_network_interfaces(options)
    resp.each_page do |page|
      batch = []
      page.data.network_interfaces.each do |n|
        batch << NetworkInterface.new(
          id: n.network_interface_id,
          data: n,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  NetworkInterface::Collection.new(batches)
end

#outpost_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Outpost.

Returns:

(String)



145
146
147

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 145

def outpost_arn
  data[:outpost_arn]
end

#owner_id ⇒ `String`

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

Returns:

(String)



113
114
115

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 113

def owner_id
  data[:owner_id]
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)



167
168
169

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 167

def private_dns_name_options_on_launch
  data[:private_dns_name_options_on_launch]
end

#state ⇒ `String`

The current state of the subnet.

Returns:

(String)



101
102
103

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 101

def state
  data[:state]
end

#subnet_arn ⇒ `String`

The Amazon Resource Name (ARN) of the subnet.

Returns:

(String)



139
140
141

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 139

def subnet_arn
  data[:subnet_arn]
end

#tags ⇒ `Array<Types::Tag>`

Any tags assigned to the subnet.

Returns:

(Array<Types::Tag>)



133
134
135

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 133

def tags
  data[:tags]
end

#vpc ⇒ `Vpc`^?

Returns:

(Vpc, nil)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 1598

def vpc
  if data[:vpc_id]
    Vpc.new(
      id: data[:vpc_id],
      client: @client
    )
  else
    nil
  end
end

#vpc_id ⇒ `String`

The ID of the VPC the subnet is in.

Returns:

(String)



107
108
109

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 107

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —
Maximum number of
:delay (Integer) — default: 10 —
Delay between each
:before_attempt (Proc) — default: nil —
Callback
:before_wait (Proc) — default: nil —
Callback

Yield Parameters:

resource (Resource) —
to be used in the waiting condition.

Returns:

(Resource) —
if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —
Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —
Raised when the resource does not

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/subnet.rb', line 286

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

Class: Aws::EC2::Subnet

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Subnet #initialize(options = {}) ⇒ Subnet

Instance Method Details

#assign_ipv_6_address_on_creation ⇒ Boolean

#availability_zone ⇒ String

#availability_zone_id ⇒ String

#available_ip_address_count ⇒ Integer

#cidr_block ⇒ String

#client ⇒ Client

#create_instances(options = {}) ⇒ Instance::Collection

#create_network_interface(options = {}) ⇒ NetworkInterface

#create_tags(options = {}) ⇒ Tag::Collection

#customer_owned_ipv_4_pool ⇒ String

#data ⇒ Types::Subnet

#data_loaded? ⇒ Boolean

#default_for_az ⇒ Boolean

#delete(options = {}) ⇒ EmptyStructure

#delete_tags(options = {}) ⇒ Tag::Collection

#enable_dns_64 ⇒ Boolean

#enable_lni_at_device_index ⇒ Integer

#id ⇒ String Also known as: subnet_id

#instances(options = {}) ⇒ Instance::Collection

#ipv_6_cidr_block_association_set ⇒ Array<Types::SubnetIpv6CidrBlockAssociation>

#ipv_6_native ⇒ Boolean

#load ⇒ self Also known as: reload

#map_customer_owned_ip_on_launch ⇒ Boolean

#map_public_ip_on_launch ⇒ Boolean

#nat_gateways(options = {}) ⇒ NatGateway::Collection

#network_interfaces(options = {}) ⇒ NetworkInterface::Collection

#outpost_arn ⇒ String

#owner_id ⇒ String

#private_dns_name_options_on_launch ⇒ Types::PrivateDnsNameOptionsOnLaunch

#state ⇒ String

#subnet_arn ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc ⇒ Vpc?

#vpc_id ⇒ String

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Basic Usage

Example

Configuration

Callbacks

Handling Errors

#initialize(id, options = {}) ⇒ `Subnet` #initialize(options = {}) ⇒ `Subnet`

#assign_ipv_6_address_on_creation ⇒ `Boolean`

#availability_zone ⇒ `String`

#availability_zone_id ⇒ `String`

#available_ip_address_count ⇒ `Integer`

#cidr_block ⇒ `String`

#client ⇒ `Client`

#create_instances(options = {}) ⇒ `Instance::Collection`

#create_network_interface(options = {}) ⇒ `NetworkInterface`

#create_tags(options = {}) ⇒ `Tag::Collection`

#customer_owned_ipv_4_pool ⇒ `String`

#data ⇒ `Types::Subnet`

#data_loaded? ⇒ `Boolean`

#default_for_az ⇒ `Boolean`

#delete(options = {}) ⇒ `EmptyStructure`

#delete_tags(options = {}) ⇒ `Tag::Collection`

#enable_dns_64 ⇒ `Boolean`

#enable_lni_at_device_index ⇒ `Integer`

#id ⇒ `String` Also known as: subnet_id

#instances(options = {}) ⇒ `Instance::Collection`

#ipv_6_cidr_block_association_set ⇒ `Array<Types::SubnetIpv6CidrBlockAssociation>`

#ipv_6_native ⇒ `Boolean`

#load ⇒ `self` Also known as: reload

#map_customer_owned_ip_on_launch ⇒ `Boolean`

#map_public_ip_on_launch ⇒ `Boolean`

#nat_gateways(options = {}) ⇒ `NatGateway::Collection`

#network_interfaces(options = {}) ⇒ `NetworkInterface::Collection`

#outpost_arn ⇒ `String`

#owner_id ⇒ `String`

#private_dns_name_options_on_launch ⇒ `Types::PrivateDnsNameOptionsOnLaunch`

#state ⇒ `String`

#subnet_arn ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#vpc ⇒ `Vpc`^?

#vpc_id ⇒ `String`

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`