Class: Aws::EC2::Subnet

Inherits:

Resources::Resource

• Object
• Resources::Resource
• Aws::EC2::Subnet

Defined in:

(unknown)

Instance Attribute Summary

• #assign_ipv_6_address_on_creation ⇒ Boolean readonly

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

• #availability_zone ⇒ String readonly

  The Availability Zone of the subnet.

• #availability_zone_id ⇒ String readonly

  The AZ ID of the subnet.

• #available_ip_address_count ⇒ Integer readonly

  The number of unused private IPv4 addresses in the subnet.

• #cidr_block ⇒ String readonly

  The IPv4 CIDR block assigned to the subnet.

• #customer_owned_ipv_4_pool ⇒ String readonly

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

• #default_for_az ⇒ Boolean readonly

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

• #id ⇒ String readonly
• #ipv_6_cidr_block_association_set ⇒ Array<Types::SubnetIpv6CidrBlockAssociation> readonly

  Information about the IPv6 CIDR blocks associated with the subnet.

• #map_customer_owned_ip_on_launch ⇒ Boolean readonly

  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 readonly

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

• #outpost_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the Outpost.

• #owner_id ⇒ String readonly

  The ID of the AWS account that owns the subnet.

• #state ⇒ String readonly

  The current state of the subnet.

• #subnet_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the subnet.

• #subnet_id ⇒ String readonly

  The ID of the subnet.

• #tags ⇒ Array<Types::Tag> readonly

  Any tags assigned to the subnet.

• #vpc_id ⇒ String readonly

  The ID of the VPC the subnet is in.

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #create_instances(options = {}) ⇒ Array<Instance>
• #create_network_interface(options = {}) ⇒ NetworkInterface
• #create_tags(options = {}) ⇒ Array<Tag>
• #delete(options = {}) ⇒ Struct

  Deletes the specified subnet.

• #delete_tags(options = {}) ⇒ Array<Tag>
• #initialize ⇒ Object constructor
• #instances(options = {}) ⇒ Collection<Instance>

  Returns a Collection of Instance resources.

• #nat_gateways(options = {}) ⇒ Collection<NatGateway>

  Returns a Collection of NatGateway resources.

• #network_interfaces(options = {}) ⇒ Collection<NetworkInterface>

  Returns a Collection of NetworkInterface resources.

• #vpc ⇒ Vpc^?

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

• #initialize(id, options = {}) ⇒ Object

  Parameters:

  • id (String)

  Options Hash (options):

  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

• #initialize(options = {}) ⇒ Object

  Options Hash (options):

  • :id (required, String)
  • :client (Client) —

    When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#assign_ipv_6_address_on_creation ⇒ Boolean (readonly)

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

Returns:

• (Boolean) —

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

#availability_zone ⇒ String (readonly)

The Availability Zone of the subnet.

Returns:

• (String) —

  The Availability Zone of the subnet.

#availability_zone_id ⇒ String (readonly)

The AZ ID of the subnet.

Returns:

• (String) —

  The AZ ID of the subnet.

#available_ip_address_count ⇒ Integer (readonly)

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

Returns:

• (Integer) —

  The number of unused private IPv4 addresses in the subnet.

#cidr_block ⇒ String (readonly)

The IPv4 CIDR block assigned to the subnet.

Returns:

• (String) —

  The IPv4 CIDR block assigned to the subnet.

#customer_owned_ipv_4_pool ⇒ String (readonly)

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

Returns:

• (String) —

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

#default_for_az ⇒ Boolean (readonly)

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

Returns:

• (Boolean) —

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

#id ⇒ String (readonly)

Returns:

• (String)

#ipv_6_cidr_block_association_set ⇒ Array<Types::SubnetIpv6CidrBlockAssociation> (readonly)

Information about the IPv6 CIDR blocks associated with the subnet.

Returns:

• (Array<Types::SubnetIpv6CidrBlockAssociation>) —

  Information about the IPv6 CIDR blocks associated with the subnet.

#map_customer_owned_ip_on_launch ⇒ Boolean (readonly)

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

Returns:

• (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 (readonly)

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

Returns:

• (Boolean) —

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

#outpost_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the Outpost.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the Outpost.

#owner_id ⇒ String (readonly)

The ID of the AWS account that owns the subnet.

Returns:

• (String) —

  The ID of the AWS account that owns the subnet.

#state ⇒ String (readonly)

The current state of the subnet.

Possible values:

• pending
• available

Returns:

• (String) —

  The current state of the subnet.

#subnet_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the subnet.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the subnet.

#subnet_id ⇒ String (readonly)

The ID of the subnet.

Returns:

• (String) —

  The ID of the subnet.

#tags ⇒ Array<Types::Tag> (readonly)

Any tags assigned to the subnet.

Returns:

• (Array<Types::Tag>) —

  Any tags assigned to the subnet.

#vpc_id ⇒ String (readonly)

The ID of the VPC the subnet is in.

Returns:

• (String) —

  The ID of the VPC the subnet is in.

Instance Method Details

#create_instances(options = {}) ⇒ Array<Instance>

Examples:

Request syntax example with placeholder values

subnet.create_instances({
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1
        kms_key_id: "String",
        encrypted: false,
      },
      no_device: "String",
    },
  ],
  image_id: "ImageId",
  instance_type: "t1.micro", # accepts 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, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, 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, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r6g.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6gd.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, 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, hi1.4xlarge, hs1.8xlarge, 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, c6g.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6gd.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, f1.2xlarge, f1.4xlarge, f1.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, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, 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
  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: "String",
    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: "String",
  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: "String",
      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,
    },
  ],
  private_ip_address: "String",
  elastic_gpu_specification: [
    {
      type: "String", # required
    },
  ],
  elastic_inference_accelerators: [
    {
      type: "String", # required
      count: 1,
    },
  ],
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-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, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, 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
  },
  enclave_options: {
    enabled: false,
  },
})

Basic usage

instances = subnet.create_instances(options)
instances.map(&:id)
#=> ["instance-id", ...]

Options Hash (options):

• :block_device_mappings (Array<Types::BlockDeviceMapping>) —

  The block device mapping entries.

• :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 Elastic Compute Cloud 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 Elastic Compute Cloud 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 AWS 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 Elastic Compute Cloud 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 to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). 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) —

  This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.

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

• :cpu_options (Types::CpuOptionsRequest) —

  The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.

  You can\'t enable hibernation and AWS 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 AWS Nitro Enclaves. For more information, see What is AWS Nitro Enclaves? in the AWS Nitro Enclaves User Guide.

  You can\'t enable AWS Nitro Enclaves and hibernation on the same instance.

Returns:

• (Array<Instance>)

See Also:

• #instances
• Client#run_instances

#create_network_interface(options = {}) ⇒ NetworkInterface

Examples:

Request syntax example with placeholder values

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,
  interface_type: "efa", # accepts efa
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-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, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
})

Basic usage

networkinterface = subnet.create_network_interface(options)
networkinterface.id
#=> "networkinterface-id"

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.

• :interface_type (String) —

  Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

• :tag_specifications (Array<Types::TagSpecification>) —

  The tags to apply to the new network interface.

Returns:

• (NetworkInterface)

See Also:

• #network_interfaces
• Client#create_network_interface

#create_tags(options = {}) ⇒ Array<Tag>

Examples:

Request syntax example with placeholder values

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

Basic usage

tags = subnet.create_tags(options)
tags.map(&:value)
#=> ["tag-value", ...]

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:

• (Array<Tag>)

See Also:

• #delete_tags
• Client#create_tags

#delete(options = {}) ⇒ Struct

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

Examples:

Request syntax example with placeholder values

subnet.delete({
  dry_run: false,
})

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:

• (Struct) —

  Returns an empty response.

See Also:

• Client#delete_subnet

#delete_tags(options = {}) ⇒ Array<Tag>

Examples:

Request syntax example with placeholder values

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

Basic usage

tags = subnet.delete_tags(options)
tags.map(&:value)
#=> ["tag-value", ...]

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 AWS-generated tags (tags that have the aws: prefix).

Returns:

• (Array<Tag>)

See Also:

• #create_tags
• Client#delete_tags

#instances(options = {}) ⇒ Collection<Instance>

Returns a Collection of Instance resources. No API requests are made until you call an enumerable method on the collection. Client#describe_instances will be called multiple times until every Instance has been yielded.

Examples:

Request syntax example with placeholder values

subnet.instances({
  instance_ids: ["InstanceId"],
  dry_run: false,
  max_results: 1,
  next_token: "String",
})

Enumerating Instance resources.

subnet.instances.each do |instance|
  # yields each instance
end

Enumerating Instance resources with a limit.

subnet.instances.limit(10).each do |instance|
  # yields at most 10 instances
end

Batch operations callable on the returned collection

# calls Client#create_tags on each batch
subnet.instances.batch_create_tags

# calls Client#delete_tags on each batch
subnet.instances.batch_delete_tags!

# calls Client#monitor_instances on each batch
subnet.instances.batch_monitor

# calls Client#reboot_instances on each batch
subnet.instances.batch_reboot

# calls Client#start_instances on each batch
subnet.instances.batch_start

# calls Client#stop_instances on each batch
subnet.instances.batch_stop

# calls Client#terminate_instances on each batch
subnet.instances.batch_terminate!

# calls Client#unmonitor_instances on each batch
subnet.instances.batch_unmonitor

Options Hash (options):

• :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.

• :max_results (Integer) —

  The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

• :next_token (String) —

  The token to request the next page of results.

Returns:

• (Collection<Instance>)

See Also:

• #create_instances
• Client#describe_instances

#nat_gateways(options = {}) ⇒ Collection<NatGateway>

Returns a Collection of NatGateway resources. No API requests are made until you call an enumerable method on the collection. Client#describe_nat_gateways will be called multiple times until every NatGateway has been yielded.

Examples:

Request syntax example with placeholder values

subnet.nat_gateways({
  dry_run: false,
  max_results: 1,
  nat_gateway_ids: ["NatGatewayId"],
  next_token: "String",
})

Enumerating NatGateway resources.

subnet.nat_gateways.each do |natgateway|
  # yields each natgateway
end

Enumerating NatGateway resources with a limit.

subnet.nat_gateways.limit(10).each do |natgateway|
  # yields at most 10 nat_gateways
end

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.

• :max_results (Integer) —

  The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• :nat_gateway_ids (Array<String>) —

  One or more NAT gateway IDs.

• :next_token (String) —

  The token for the next page of results.

Returns:

• (Collection<NatGateway>)

See Also:

• Client#describe_nat_gateways

#network_interfaces(options = {}) ⇒ Collection<NetworkInterface>

Returns a Collection of NetworkInterface resources. No API requests are made until you call an enumerable method on the collection. Client#describe_network_interfaces will be called multiple times until every NetworkInterface has been yielded.

Examples:

Request syntax example with placeholder values

subnet.network_interfaces({
  dry_run: false,
  network_interface_ids: ["NetworkInterfaceId"],
  next_token: "String",
  max_results: 1,
})

Enumerating NetworkInterface resources.

subnet.network_interfaces.each do |networkinterface|
  # yields each networkinterface
end

Enumerating NetworkInterface resources with a limit.

subnet.network_interfaces.limit(10).each do |networkinterface|
  # yields at most 10 network_interfaces
end

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.

• :network_interface_ids (Array<String>) —

  One or more network interface IDs.

  Default: Describes all your network interfaces.

• :next_token (String) —

  The token to retrieve the next page of results.

• :max_results (Integer) —

  The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.

Returns:

• (Collection<NetworkInterface>)

See Also:

• #create_network_interface
• Client#describe_network_interfaces

#vpc ⇒ Vpc^?

Returns:

• (Vpc, nil)