Class: Aws::EC2::Resource

Inherits:

Resources::Resource

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

Defined in:

aws-sdk-resources/lib/aws-sdk-resources/services/ec2.rb

Overview

This class provides a resource oriented interface for Amazon EC2. To create a resource object:

resource = Aws::EC2::Resource.new

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass :client, a default client will be constructed.

client = Aws::EC2::Client.new(region: 'us-west-2')
resource = Aws::EC2::Resource.new(client: client)

Resource Resource Classes

Aws::EC2::Resource has the following resource classes:

Instance Attribute Summary

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary

• #classic_addresses(options = {}) ⇒ Collection<ClassicAddress>

  Returns a Collection of ClassicAddress resources.

• #create_dhcp_options(options = {}) ⇒ DhcpOptions
• #create_instances(options = {}) ⇒ Array<Instance>
• #create_internet_gateway(options = {}) ⇒ InternetGateway
• #create_key_pair(options = {}) ⇒ KeyPair
• #create_nat_gateway(options = {}) ⇒ NatGateway
• #create_network_acl(options = {}) ⇒ NetworkAcl
• #create_network_interface(options = {}) ⇒ NetworkInterface
• #create_placement_group(options = {}) ⇒ PlacementGroup
• #create_route_table(options = {}) ⇒ RouteTable
• #create_security_group(options = {}) ⇒ SecurityGroup
• #create_snapshot(options = {}) ⇒ Snapshot
• #create_subnet(options = {}) ⇒ Subnet
• #create_tags(options) ⇒ Struct

  Returns an empty response.

• #create_volume(options = {}) ⇒ Volume
• #create_vpc(options = {}) ⇒ Vpc
• #create_vpc_peering_connection(options = {}) ⇒ VpcPeeringConnection
• #delete_tags(options = {}) ⇒ Struct

  Deletes the specified set of tags from the specified set of resources.

  To list the current tags, use DescribeTags.

• #dhcp_options(id) ⇒ DhcpOptions
• #dhcp_options_sets(options = {}) ⇒ Collection<DhcpOptions>

  Returns a Collection of DhcpOptions resources.

• #disassociate_route_table(options = {}) ⇒ Struct

  Disassociates a subnet or gateway from a route table.

  After you perform this action, the subnet no longer uses the routes in the route table.

• #image(id) ⇒ Image
• #images(options = {}) ⇒ Collection<Image>

  Returns a Collection of Image resources.

• #import_key_pair(options = {}) ⇒ KeyPairInfo
• #initialize ⇒ Object constructor
• #instance(id) ⇒ Instance
• #instances(options = {}) ⇒ Collection<Instance>

  Returns a Collection of Instance resources.

• #internet_gateway(id) ⇒ InternetGateway
• #internet_gateways(options = {}) ⇒ Collection<InternetGateway>

  Returns a Collection of InternetGateway resources.

• #key_pair(name) ⇒ KeyPairInfo
• #key_pairs(options = {}) ⇒ Collection<KeyPairInfo>

  Returns a Collection of KeyPairInfo resources.

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

  Returns a Collection of NatGateway resources.

• #network_acl(id) ⇒ NetworkAcl
• #network_acls(options = {}) ⇒ Collection<NetworkAcl>

  Returns a Collection of NetworkAcl resources.

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

  Returns a Collection of NetworkInterface resources.

• #placement_group(name) ⇒ PlacementGroup
• #placement_groups(options = {}) ⇒ Collection<PlacementGroup>

  Returns a Collection of PlacementGroup resources.

• #register_image(options = {}) ⇒ Image
• #route_table(id) ⇒ RouteTable
• #route_table_association(id) ⇒ RouteTableAssociation
• #route_tables(options = {}) ⇒ Collection<RouteTable>

  Returns a Collection of RouteTable resources.

• #security_group(id) ⇒ SecurityGroup
• #security_groups(options = {}) ⇒ Collection<SecurityGroup>

  Returns a Collection of SecurityGroup resources.

• #snapshot(id) ⇒ Snapshot
• #snapshots(options = {}) ⇒ Collection<Snapshot>

  Returns a Collection of Snapshot resources.

• #subnet(id) ⇒ Subnet
• #subnets(options = {}) ⇒ Collection<Subnet>

  Returns a Collection of Subnet resources.

• #volume(id) ⇒ Volume
• #volumes(options = {}) ⇒ Collection<Volume>

  Returns a Collection of Volume resources.

• #vpc(id) ⇒ Vpc
• #vpc_addresses(options = {}) ⇒ Collection<VpcAddress>

  Returns a Collection of VpcAddress resources.

• #vpc_peering_connection(id) ⇒ VpcPeeringConnection
• #vpc_peering_connections(options = {}) ⇒ Collection<VpcPeeringConnection>

  Returns a Collection of VpcPeeringConnection resources.

• #vpcs(options = {}) ⇒ Collection<Vpc>

  Returns a Collection of Vpc resources.

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(options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

• #initialize(options = {}) ⇒ Object

  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):

  • :client (Client) —

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

Instance Method Details

#classic_addresses(options = {}) ⇒ Collection<ClassicAddress>

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

Examples:

Request syntax example with placeholder values

ec2.classic_addresses({
  public_ips: ["String"],
  allocation_ids: ["AllocationId"],
  dry_run: false,
})

Enumerating ClassicAddress resources.

ec2.classic_addresses.each do |classicaddress|
  # yields each classicaddress
end

Enumerating ClassicAddress resources with a limit.

ec2.classic_addresses.limit(10).each do |classicaddress|
  # yields at most 10 classic_addresses
end

Options Hash (options):

• :public_ips (Array<String>) —

  One or more Elastic IP addresses.

  Default: Describes all your Elastic IP addresses.

• :allocation_ids (Array<String>) —

  [EC2-VPC] Information about the allocation IDs.

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

• (Collection<ClassicAddress>)

See Also:

• Client#describe_addresses

#create_dhcp_options(options = {}) ⇒ DhcpOptions

Examples:

Request syntax example with placeholder values

ec2.create_dhcp_options({
  dhcp_configurations: [ # required
    {
      key: "String",
      values: ["String"],
    },
  ],
  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",
        },
      ],
    },
  ],
  dry_run: false,
})

Basic usage

dhcpoptions = ec2.create_dhcp_options(options)
dhcpoptions.id
#=> "dhcpoptions-id"

Options Hash (options):

• :dhcp_configurations (required, Array<Types::NewDhcpConfiguration>) —

  A DHCP configuration option.

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

  The tags to assign to the DHCP option.

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

• (DhcpOptions)

See Also:

• #dhcp_options
• #dhcp_options_sets
• Client#create_dhcp_options

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

Examples:

Request syntax example with placeholder values

ec2.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"],
  subnet_id: "SubnetId",
  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 = ec2.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.

• :subnet_id (String) —

  [EC2-VPC] The ID of the subnet to launch the instance into.

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

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

• #instance
• #instances
• Client#run_instances

#create_internet_gateway(options = {}) ⇒ InternetGateway

Examples:

Request syntax example with placeholder values

ec2.create_internet_gateway({
  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",
        },
      ],
    },
  ],
  dry_run: false,
})

Basic usage

internetgateway = ec2.create_internet_gateway(options)
internetgateway.id
#=> "internetgateway-id"

Options Hash (options):

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

  The tags to assign to the internet gateway.

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

• (InternetGateway)

See Also:

• #internet_gateway
• #internet_gateways
• Client#create_internet_gateway

#create_key_pair(options = {}) ⇒ KeyPair

Examples:

Request syntax example with placeholder values

ec2.create_key_pair({
  key_name: "String", # required
  dry_run: false,
  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

keypair = ec2.create_key_pair(options)
keypair.name
#=> "keypair-name"

Options Hash (options):

• :key_name (required, String) —

  A unique name for the key pair.

  Constraints: Up to 255 ASCII characters

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

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

  The tags to apply to the new key pair.

Returns:

• (KeyPair)

See Also:

• Client#create_key_pair

#create_nat_gateway(options = {}) ⇒ NatGateway

Examples:

Request syntax example with placeholder values

ec2.create_nat_gateway({
  allocation_id: "AllocationId", # required
  client_token: "String",
  dry_run: false,
  subnet_id: "SubnetId", # required
  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

natgateway = ec2.create_nat_gateway(options)
natgateway.id
#=> "natgateway-id"

Options Hash (options):

• :allocation_id (required, String) —

  The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

• :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 that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

  Constraint: Maximum 64 ASCII characters.

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

• :subnet_id (required, String) —

  The subnet in which to create the NAT gateway.

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

  The tags to assign to the NAT gateway.

Returns:

• (NatGateway)

See Also:

• #nat_gateway
• #nat_gateways
• Client#create_nat_gateway

#create_network_acl(options = {}) ⇒ NetworkAcl

Examples:

Request syntax example with placeholder values

ec2.create_network_acl({
  dry_run: false,
  vpc_id: "VpcId", # required
  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

networkacl = ec2.create_network_acl(options)
networkacl.id
#=> "networkacl-id"

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.

• :vpc_id (required, String) —

  The ID of the VPC.

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

  The tags to assign to the network ACL.

Returns:

• (NetworkAcl)

See Also:

• #network_acl
• #network_acls
• Client#create_network_acl

#create_network_interface(options = {}) ⇒ NetworkInterface

Examples:

Request syntax example with placeholder values

ec2.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
  subnet_id: "SubnetId", # required
  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 = ec2.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.

• :subnet_id (required, String) —

  The ID of the subnet to associate with the network interface.

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

  The tags to apply to the new network interface.

Returns:

• (NetworkInterface)

See Also:

• #network_interface
• #network_interfaces
• Client#create_network_interface

#create_placement_group(options = {}) ⇒ PlacementGroup

Examples:

Request syntax example with placeholder values

ec2.create_placement_group({
  dry_run: false,
  group_name: "String",
  strategy: "cluster", # accepts cluster, spread, partition
  partition_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",
        },
      ],
    },
  ],
})

Basic usage

placementgroup = ec2.create_placement_group(options)
placementgroup.name
#=> "placementgroup-name"

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.

• :group_name (String) —

  A name for the placement group. Must be unique within the scope of your account for the Region.

  Constraints: Up to 255 ASCII characters

• :strategy (String) —

  The placement strategy.

• :partition_count (Integer) —

  The number of partitions. Valid only when Strategy is set to partition.

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

  The tags to apply to the new placement group.

Returns:

• (PlacementGroup)

See Also:

• #placement_group
• #placement_groups
• Client#create_placement_group

#create_route_table(options = {}) ⇒ RouteTable

Examples:

Request syntax example with placeholder values

ec2.create_route_table({
  dry_run: false,
  vpc_id: "VpcId", # required
  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

routetable = ec2.create_route_table(options)
routetable.id
#=> "routetable-id"

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.

• :vpc_id (required, String) —

  The ID of the VPC.

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

  The tags to assign to the route table.

Returns:

• (RouteTable)

See Also:

• #route_table
• #route_tables
• Client#create_route_table

#create_security_group(options = {}) ⇒ SecurityGroup

Examples:

Request syntax example with placeholder values

ec2.create_security_group({
  description: "String", # required
  group_name: "String", # required
  vpc_id: "VpcId",
  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",
        },
      ],
    },
  ],
  dry_run: false,
})

Basic usage

securitygroup = ec2.create_security_group(options)
securitygroup.id
#=> "securitygroup-id"

Options Hash (options):

• :description (required, String) —

  A description for the security group. This is informational only.

  Constraints: Up to 255 characters in length

  Constraints for EC2-Classic: ASCII characters

  Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

• :group_name (required, String) —

  The name of the security group.

  Constraints: Up to 255 characters in length. Cannot start with sg-.

  Constraints for EC2-Classic: ASCII characters

  Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

• :vpc_id (String) —

  [EC2-VPC] The ID of the VPC. Required for EC2-VPC.

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

  The tags to assign to the security group.

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

• (SecurityGroup)

See Also:

• #security_group
• #security_groups
• Client#create_security_group

#create_snapshot(options = {}) ⇒ Snapshot

Examples:

Request syntax example with placeholder values

ec2.create_snapshot({
  description: "String",
  volume_id: "VolumeId", # required
  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",
        },
      ],
    },
  ],
  dry_run: false,
})

Basic usage

snapshot = ec2.create_snapshot(options)
snapshot.id
#=> "snapshot-id"

Options Hash (options):

• :description (String) —

  A description for the snapshot.

• :volume_id (required, String) —

  The ID of the EBS volume.

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

  The tags to apply to the snapshot during creation.

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

• (Snapshot)

See Also:

• #snapshot
• #snapshots
• Client#create_snapshot

#create_subnet(options = {}) ⇒ Subnet

Examples:

Request syntax example with placeholder values

ec2.create_subnet({
  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",
        },
      ],
    },
  ],
  availability_zone: "String",
  availability_zone_id: "String",
  cidr_block: "String", # required
  ipv_6_cidr_block: "String",
  outpost_arn: "String",
  vpc_id: "VpcId", # required
  dry_run: false,
})

Basic usage

subnet = ec2.create_subnet(options)
subnet.id
#=> "subnet-id"

Options Hash (options):

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

  The tags to assign to the subnet.

• :availability_zone (String) —

  The Availability Zone or Local Zone for the subnet.

  Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

  To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.

  To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

• :availability_zone_id (String) —

  The AZ ID or the Local Zone ID of the subnet.

• :cidr_block (required, String) —

  The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

• :ipv_6_cidr_block (String) —

  The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

• :outpost_arn (String) —

  The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

• :vpc_id (required, String) —

  The ID of the VPC.

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

• (Subnet)

See Also:

• #subnet
• #subnets
• Client#create_subnet

#create_tags(options) ⇒ Struct

Returns an empty response.

Examples:

Request syntax example with placeholder values

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

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.

• :resources (required, Array<String>) —

  The IDs of the resources, separated by spaces.

  Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

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

• (Struct) —

  Returns an empty response.

See Also:

• Client#create_tags

# File 'aws-sdk-resources/lib/aws-sdk-resources/services/ec2.rb', line 8

def create_tags(options)
  resp = @client.create_tags(options)
  tags = []
  options[:resources].each do |resource_id|
    options[:tags].each do |tag|
      tags << Tag.new(resource_id, tag[:key], tag[:value], client: @client)
    end
  end
  Resources::Batch.new(Tag, tags, response: resp)
end

#create_volume(options = {}) ⇒ Volume

Examples:

Request syntax example with placeholder values

ec2.create_volume({
  availability_zone: "String", # required
  encrypted: false,
  iops: 1,
  kms_key_id: "KmsKeyId",
  outpost_arn: "String",
  size: 1,
  snapshot_id: "SnapshotId",
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1
  dry_run: false,
  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",
        },
      ],
    },
  ],
  multi_attach_enabled: false,
})

Basic usage

volume = ec2.create_volume(options)
volume.id
#=> "volume-id"

Options Hash (options):

• :availability_zone (required, String) —

  The Availability Zone in which to create the volume.

• :encrypted (Boolean) —

  Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.

  Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

• :iops (Integer) —

  The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

  This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.

• :kms_key_id (String) —

  The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

  You can specify the CMK using any of the following:

  • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

• :outpost_arn (String) —

  The Amazon Resource Name (ARN) of the Outpost.

• :size (Integer) —

  The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

  Constraints: 1-16,384 for gp2, 4-16,384 for io1 and io2, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

  Default: If you\'re creating the volume from a snapshot and don\'t specify a volume size, the default is the snapshot size.

• :snapshot_id (String) —

  The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

• :volume_type (String) —

  The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

  Default: gp2

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

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

  The tags to apply to the volume during creation.

• :multi_attach_enabled (Boolean) —

  Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.

Returns:

• (Volume)

See Also:

• #volume
• #volumes
• Client#create_volume

#create_vpc(options = {}) ⇒ Vpc

Examples:

Request syntax example with placeholder values

ec2.create_vpc({
  cidr_block: "String", # required
  amazon_provided_ipv_6_cidr_block: false,
  ipv_6_pool: "Ipv6PoolEc2Id",
  ipv_6_cidr_block: "String",
  dry_run: false,
  instance_tenancy: "default", # accepts default, dedicated, host
  ipv_6_cidr_block_network_border_group: "String",
  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

vpc = ec2.create_vpc(options)
vpc.id
#=> "vpc-id"

Options Hash (options):

• :cidr_block (required, String) —

  The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

• :amazon_provided_ipv_6_cidr_block (Boolean) —

  Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.

• :ipv_6_pool (String) —

  The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

• :ipv_6_cidr_block (String) —

  The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

  To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

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

• :instance_tenancy (String) —

  The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

  Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

  Default: default

• :ipv_6_cidr_block_network_border_group (String) —

  The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

  You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

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

  The tags to assign to the VPC.

Returns:

• (Vpc)

See Also:

• #vpc
• #vpcs
• Client#create_vpc

#create_vpc_peering_connection(options = {}) ⇒ VpcPeeringConnection

Examples:

Request syntax example with placeholder values

ec2.create_vpc_peering_connection({
  dry_run: false,
  peer_owner_id: "String",
  peer_vpc_id: "String",
  vpc_id: "VpcId",
  peer_region: "String",
  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

vpcpeeringconnection = ec2.create_vpc_peering_connection(options)
vpcpeeringconnection.id
#=> "vpcpeeringconnection-id"

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.

• :peer_owner_id (String) —

  The AWS account ID of the owner of the accepter VPC.

  Default: Your AWS account ID

• :peer_vpc_id (String) —

  The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.

• :vpc_id (String) —

  The ID of the requester VPC. You must specify this parameter in the request.

• :peer_region (String) —

  The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

  Default: The Region in which you make the request.

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

  The tags to assign to the peering connection.

Returns:

• (VpcPeeringConnection)

See Also:

• #vpc_peering_connection
• #vpc_peering_connections
• Client#create_vpc_peering_connection

#delete_tags(options = {}) ⇒ Struct

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Examples:

Request syntax example with placeholder values

ec2.delete_tags({
  dry_run: false,
  resources: ["TaggableResourceId"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

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.

• :resources (required, Array<String>) —

  The IDs of the resources, separated by spaces.

  Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

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

• (Struct) —

  Returns an empty response.

See Also:

• Client#delete_tags

#dhcp_options(id) ⇒ DhcpOptions

Parameters:

• id (String) —

  The DhcpOptions#id identifier.

Returns:

• (DhcpOptions)

See Also:

• #create_dhcp_options
• #dhcp_options_sets

#dhcp_options_sets(options = {}) ⇒ Collection<DhcpOptions>

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

Examples:

Request syntax example with placeholder values

ec2.dhcp_options_sets({
  dhcp_options_ids: ["DhcpOptionsId"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Enumerating DhcpOptions resources.

ec2.dhcp_options_sets.each do |dhcpoptions|
  # yields each dhcpoptions
end

Enumerating DhcpOptions resources with a limit.

ec2.dhcp_options_sets.limit(10).each do |dhcpoptions|
  # yields at most 10 dhcp_options_sets
end

Options Hash (options):

• :dhcp_options_ids (Array<String>) —

  The IDs of one or more DHCP options sets.

  Default: Describes all your DHCP options sets.

• :filters (Array<Types::Filter>) —

  One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

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

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

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<DhcpOptions>)

See Also:

• #create_dhcp_options
• #dhcp_options
• Client#describe_dhcp_options

#disassociate_route_table(options = {}) ⇒ Struct

Disassociates a subnet or gateway from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

Examples:

Request syntax example with placeholder values

ec2.disassociate_route_table({
  association_id: "RouteTableAssociationId", # required
  dry_run: false,
})

Options Hash (options):

• :association_id (required, String) —

  The association ID representing the current association between the route table and subnet or gateway.

• :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#disassociate_route_table

#image(id) ⇒ Image

Parameters:

• id (String) —

  The Image#id identifier.

Returns:

• (Image)

See Also:

• #images
• #register_image

#images(options = {}) ⇒ Collection<Image>

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

Examples:

Request syntax example with placeholder values

ec2.images({
  executable_users: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  image_ids: ["ImageId"],
  owners: ["String"],
  dry_run: false,
})

Enumerating Image resources.

ec2.images.each do |image|
  # yields each image
end

Enumerating Image resources with a limit.

ec2.images.limit(10).each do |image|
  # yields at most 10 images
end

Options Hash (options):

• :executable_users (Array<String>) —

  Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

• :filters (Array<Types::Filter>) —

  The filters.

  • architecture - The image architecture (i386 | x86_64 | arm64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon 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.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | io2 | st1| sc1 | standard).

  • block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon | aws-marketplace). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk 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).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

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

  • virtualization-type - The virtualization type (paravirtual | hvm).

• :image_ids (Array<String>) —

  The image IDs.

  Default: Describes all images available to you.

• :owners (Array<String>) —

  Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.

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

• (Collection<Image>)

See Also:

• #image
• #register_image
• Client#describe_images

#import_key_pair(options = {}) ⇒ KeyPairInfo

Examples:

Request syntax example with placeholder values

ec2.import_key_pair({
  dry_run: false,
  key_name: "String", # required
  public_key_material: "data", # required
  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

keypairinfo = ec2.import_key_pair(options)
keypairinfo.name
#=> "keypairinfo-name"

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.

• :key_name (required, String) —

  A unique name for the key pair.

• :public_key_material (required, IO, String) —

  The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

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

  The tags to apply to the imported key pair.

Returns:

• (KeyPairInfo)

See Also:

• #key_pair
• #key_pairs
• Client#import_key_pair

#instance(id) ⇒ Instance

Parameters:

• id (String) —

  The Instance#id identifier.

Returns:

• (Instance)

See Also:

• #create_instances
• #instances

#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

ec2.instances({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  instance_ids: ["InstanceId"],
  dry_run: false,
  max_results: 1,
  next_token: "String",
})

Enumerating Instance resources.

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

Enumerating Instance resources with a limit.

ec2.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
ec2.instances.batch_create_tags

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

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

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

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

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

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

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

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.

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

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

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

  • owner-id - The AWS 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, AWS 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.

• :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
• #instance
• Client#describe_instances

#internet_gateway(id) ⇒ InternetGateway

Parameters:

• id (String) —

  The InternetGateway#id identifier.

Returns:

• (InternetGateway)

See Also:

• #create_internet_gateway
• #internet_gateways

#internet_gateways(options = {}) ⇒ Collection<InternetGateway>

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

Examples:

Request syntax example with placeholder values

ec2.internet_gateways({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  internet_gateway_ids: ["InternetGatewayId"],
  next_token: "String",
  max_results: 1,
})

Enumerating InternetGateway resources.

ec2.internet_gateways.each do |internetgateway|
  # yields each internetgateway
end

Enumerating InternetGateway resources with a limit.

ec2.internet_gateways.limit(10).each do |internetgateway|
  # yields at most 10 internet_gateways
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the AWS account that owns the internet gateway.

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

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

• :internet_gateway_ids (Array<String>) —

  One or more internet gateway IDs.

  Default: Describes all your internet gateways.

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<InternetGateway>)

See Also:

• #create_internet_gateway
• #internet_gateway
• Client#describe_internet_gateways

#key_pair(name) ⇒ KeyPairInfo

Parameters:

• name (String) —

  The KeyPairInfo#name identifier.

Returns:

• (KeyPairInfo)

See Also:

• #import_key_pair
• #key_pairs

#key_pairs(options = {}) ⇒ Collection<KeyPairInfo>

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

Examples:

Request syntax example with placeholder values

ec2.key_pairs({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  key_names: ["KeyPairName"],
  key_pair_ids: ["KeyPairId"],
  dry_run: false,
})

Enumerating KeyPairInfo resources.

ec2.key_pairs.each do |keypairinfo|
  # yields each keypairinfo
end

Enumerating KeyPairInfo resources with a limit.

ec2.key_pairs.limit(10).each do |keypairinfo|
  # yields at most 10 key_pairs
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  The filters.

  • key-pair-id - The ID of the key pair.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

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

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

• :key_names (Array<String>) —

  The key pair names.

  Default: Describes all your key pairs.

• :key_pair_ids (Array<String>) —

  The IDs of the key pairs.

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

• (Collection<KeyPairInfo>)

See Also:

• #import_key_pair
• #key_pair
• Client#describe_key_pairs

#nat_gateway(id) ⇒ NatGateway

Parameters:

• id (String) —

  The NatGateway#id identifier.

Returns:

• (NatGateway)

See Also:

• #create_nat_gateway
• #nat_gateways

#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

ec2.nat_gateways({
  dry_run: false,
  filter: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  nat_gateway_ids: ["NatGatewayId"],
  next_token: "String",
})

Enumerating NatGateway resources.

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

Enumerating NatGateway resources with a limit.

ec2.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.

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

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

• #create_nat_gateway
• #nat_gateway
• Client#describe_nat_gateways

#network_acl(id) ⇒ NetworkAcl

Parameters:

• id (String) —

  The NetworkAcl#id identifier.

Returns:

• (NetworkAcl)

See Also:

• #create_network_acl
• #network_acls

#network_acls(options = {}) ⇒ Collection<NetworkAcl>

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

Examples:

Request syntax example with placeholder values

ec2.network_acls({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  network_acl_ids: ["NetworkAclId"],
  next_token: "String",
  max_results: 1,
})

Enumerating NetworkAcl resources.

ec2.network_acls.each do |networkacl|
  # yields each networkacl
end

Enumerating NetworkAcl resources with a limit.

ec2.network_acls.limit(10).each do |networkacl|
  # yields at most 10 network_acls
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the AWS account that owns the network ACL.

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

• :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_acl_ids (Array<String>) —

  One or more network ACL IDs.

  Default: Describes all your network ACLs.

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<NetworkAcl>)

See Also:

• #create_network_acl
• #network_acl
• Client#describe_network_acls

#network_interface(id) ⇒ NetworkInterface

Parameters:

• id (String) —

  The NetworkInterface#id identifier.

Returns:

• (NetworkInterface)

See Also:

• #create_network_interface
• #network_interfaces

#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

ec2.network_interfaces({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  network_interface_ids: ["NetworkInterfaceId"],
  next_token: "String",
  max_results: 1,
})

Enumerating NetworkInterface resources.

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

Enumerating NetworkInterface resources with a limit.

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

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.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS 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 ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS 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.

• :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
• #network_interface
• Client#describe_network_interfaces

#placement_group(name) ⇒ PlacementGroup

Parameters:

• name (String) —

  The PlacementGroup#name identifier.

Returns:

• (PlacementGroup)

See Also:

• #create_placement_group
• #placement_groups

#placement_groups(options = {}) ⇒ Collection<PlacementGroup>

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

Examples:

Request syntax example with placeholder values

ec2.placement_groups({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  group_names: ["PlacementGroupName"],
  group_ids: ["PlacementGroupId"],
})

Enumerating PlacementGroup resources.

ec2.placement_groups.each do |placementgroup|
  # yields each placementgroup
end

Enumerating PlacementGroup resources with a limit.

ec2.placement_groups.limit(10).each do |placementgroup|
  # yields at most 10 placement_groups
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

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

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

• :group_names (Array<String>) —

  The names of the placement groups.

  Default: Describes all your placement groups, or only those otherwise specified.

• :group_ids (Array<String>) —

  The IDs of the placement groups.

Returns:

• (Collection<PlacementGroup>)

See Also:

• #create_placement_group
• #placement_group
• Client#describe_placement_groups

#register_image(options = {}) ⇒ Image

Examples:

Request syntax example with placeholder values

ec2.register_image({
  image_location: "String",
  architecture: "i386", # accepts i386, x86_64, arm64
  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",
    },
  ],
  description: "String",
  dry_run: false,
  ena_support: false,
  kernel_id: "KernelId",
  name: "String", # required
  billing_products: ["String"],
  ramdisk_id: "RamdiskId",
  root_device_name: "String",
  sriov_net_support: "String",
  virtualization_type: "String",
})

Basic usage

image = ec2.register_image(options)
image.id
#=> "image-id"

Options Hash (options):

• :image_location (String) —

  The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

• :architecture (String) —

  The architecture of the AMI.

  Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

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

  The block device mapping entries.

• :description (String) —

  A description for your AMI.

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

• :ena_support (Boolean) —

  Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

  This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

• :kernel_id (String) —

  The ID of the kernel.

• :name (required, String) —

  A name for your AMI.

  Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (\'), at-signs (@), or underscores(_)

• :billing_products (Array<String>) —

  The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

• :ramdisk_id (String) —

  The ID of the RAM disk.

• :root_device_name (String) —

  The device name of the root device volume (for example, /dev/sda1).

• :sriov_net_support (String) —

  Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

  There is no way to disable sriovNetSupport at this time.

  This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

• :virtualization_type (String) —

  The type of virtualization (hvm | paravirtual).

  Default: paravirtual

Returns:

• (Image)

See Also:

• #image
• #images
• Client#register_image

#route_table(id) ⇒ RouteTable

Parameters:

• id (String) —

  The Aws::EC2::RouteTable#id identifier.

Returns:

• (RouteTable)

See Also:

• #create_route_table
• #route_tables

#route_table_association(id) ⇒ RouteTableAssociation

Parameters:

• id (String) —

  The Aws::EC2::RouteTableAssociation#id identifier.

Returns:

• (RouteTableAssociation)

#route_tables(options = {}) ⇒ Collection<RouteTable>

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

Examples:

Request syntax example with placeholder values

ec2.route_tables({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  route_table_ids: ["RouteTableId"],
  next_token: "String",
  max_results: 1,
})

Enumerating Aws::EC2::RouteTable resources.

ec2.route_tables.each do |routetable|
  # yields each routetable
end

Enumerating Aws::EC2::RouteTable resources with a limit.

ec2.route_tables.limit(10).each do |routetable|
  # yields at most 10 route_tables
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.

  • owner-id - The ID of the AWS account that owns the route table.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.

  • route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.transit-gateway-id - The ID of a transit gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route\'s target isn\'t available (for example, the specified gateway isn\'t attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • 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 route table.

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

• :route_table_ids (Array<String>) —

  One or more route table IDs.

  Default: Describes all your route tables.

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<RouteTable>)

See Also:

• #create_route_table
• #route_table
• Client#describe_route_tables

#security_group(id) ⇒ SecurityGroup

Parameters:

• id (String) —

  The SecurityGroup#id identifier.

Returns:

• (SecurityGroup)

See Also:

• #create_security_group
• #security_groups

#security_groups(options = {}) ⇒ Collection<SecurityGroup>

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

Examples:

Request syntax example with placeholder values

ec2.security_groups({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  group_ids: ["String"],
  group_names: ["SecurityGroupName"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Enumerating SecurityGroup resources.

ec2.security_groups.each do |securitygroup|
  # yields each securitygroup
end

Enumerating SecurityGroup resources with a limit.

ec2.security_groups.limit(10).each do |securitygroup|
  # yields at most 10 security_groups
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • 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 specified when the security group was created.

• :group_ids (Array<String>) —

  The IDs of the security groups. Required for security groups in a nondefault VPC.

  Default: Describes all your security groups.

• :group_names (Array<String>) —

  [EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

  Default: Describes all your security groups.

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

• :next_token (String) —

  The token to request the next page of results.

• :max_results (Integer) —

  The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Returns:

• (Collection<SecurityGroup>)

See Also:

• #create_security_group
• #security_group
• Client#describe_security_groups

#snapshot(id) ⇒ Snapshot

Parameters:

• id (String) —

  The Snapshot#id identifier.

Returns:

• (Snapshot)

See Also:

• #create_snapshot
• #snapshots

#snapshots(options = {}) ⇒ Collection<Snapshot>

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

Examples:

Request syntax example with placeholder values

ec2.snapshots({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  owner_ids: ["String"],
  restorable_by_user_ids: ["String"],
  snapshot_ids: ["SnapshotId"],
  dry_run: false,
})

Enumerating Snapshot resources.

ec2.snapshots.each do |snapshot|
  # yields each snapshot
end

Enumerating Snapshot resources with a limit.

ec2.snapshots.limit(10).each do |snapshot|
  # yields at most 10 snapshots
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  The filters.

  • description - A description of the snapshot.

  • encrypted - Indicates whether the snapshot is encrypted (true | false)

  • owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

  • owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

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

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

• :max_results (Integer) —

  The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

• :next_token (String) —

  The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

• :owner_ids (Array<String>) —

  Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

• :restorable_by_user_ids (Array<String>) —

  The IDs of the AWS accounts that can create volumes from the snapshot.

• :snapshot_ids (Array<String>) —

  The snapshot IDs.

  Default: Describes the snapshots for which you have create volume permissions.

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

• (Collection<Snapshot>)

See Also:

• #create_snapshot
• #snapshot
• Client#describe_snapshots

#subnet(id) ⇒ Subnet

Parameters:

• id (String) —

  The Subnet#id identifier.

Returns:

• (Subnet)

See Also:

• #create_subnet
• #subnets

#subnets(options = {}) ⇒ Collection<Subnet>

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

Examples:

Request syntax example with placeholder values

ec2.subnets({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  subnet_ids: ["SubnetId"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Enumerating Subnet resources.

ec2.subnets.each do |subnet|
  # yields each subnet
end

Enumerating Subnet resources with a limit.

ec2.subnets.limit(10).each do |subnet|
  # yields at most 10 subnets
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet\'s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • owner-id - The ID of the AWS account that owns the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

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

• :subnet_ids (Array<String>) —

  One or more subnet IDs.

  Default: Describes all your subnets.

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

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<Subnet>)

See Also:

• #create_subnet
• #subnet
• Client#describe_subnets

#volume(id) ⇒ Volume

Parameters:

• id (String) —

  The Volume#id identifier.

Returns:

• (Volume)

See Also:

• #create_volume
• #volumes

#volumes(options = {}) ⇒ Collection<Volume>

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

Examples:

Request syntax example with placeholder values

ec2.volumes({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  volume_ids: ["VolumeId"],
  dry_run: false,
  max_results: 1,
  next_token: "String",
})

Enumerating Volume resources.

ec2.volumes.each do |volume|
  # yields each volume
end

Enumerating Volume resources with a limit.

ec2.volumes.limit(10).each do |volume|
  # yields at most 10 volumes
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  The filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - Indicates whether the volume is encrypted (true | false)

  • multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)

  • fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The state of the volume (creating | available | in-use | deleting | deleted | error).

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

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

• :volume_ids (Array<String>) —

  The volume IDs.

• :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 volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

• :next_token (String) —

  The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

• (Collection<Volume>)

See Also:

• #create_volume
• #volume
• Client#describe_volumes

#vpc(id) ⇒ Vpc

Parameters:

• id (String) —

  The Vpc#id identifier.

Returns:

• (Vpc)

See Also:

• #create_vpc
• #vpcs

#vpc_addresses(options = {}) ⇒ Collection<VpcAddress>

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

Examples:

Request syntax example with placeholder values

ec2.vpc_addresses({
  public_ips: ["String"],
  allocation_ids: ["AllocationId"],
  dry_run: false,
})

Enumerating VpcAddress resources.

ec2.vpc_addresses.each do |vpcaddress|
  # yields each vpcaddress
end

Enumerating VpcAddress resources with a limit.

ec2.vpc_addresses.limit(10).each do |vpcaddress|
  # yields at most 10 vpc_addresses
end

Options Hash (options):

• :public_ips (Array<String>) —

  One or more Elastic IP addresses.

  Default: Describes all your Elastic IP addresses.

• :allocation_ids (Array<String>) —

  [EC2-VPC] Information about the allocation IDs.

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

• (Collection<VpcAddress>)

See Also:

• Client#describe_addresses

#vpc_peering_connection(id) ⇒ VpcPeeringConnection

Parameters:

• id (String) —

  The VpcPeeringConnection#id identifier.

Returns:

• (VpcPeeringConnection)

See Also:

• #create_vpc_peering_connection
• #vpc_peering_connections

#vpc_peering_connections(options = {}) ⇒ Collection<VpcPeeringConnection>

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

Examples:

Request syntax example with placeholder values

ec2.vpc_peering_connections({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  vpc_peering_connection_ids: ["VpcPeeringConnectionId"],
  next_token: "String",
  max_results: 1,
})

Enumerating VpcPeeringConnection resources.

ec2.vpc_peering_connections.each do |vpcpeeringconnection|
  # yields each vpcpeeringconnection
end

Enumerating VpcPeeringConnection resources with a limit.

ec2.vpc_peering_connections.limit(10).each do |vpcpeeringconnection|
  # yields at most 10 vpc_peering_connections
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.

  • accepter-vpc-info.vpc-id - The ID of the accepter VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester\'s VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • 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-peering-connection-id - The ID of the VPC peering connection.

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

• :vpc_peering_connection_ids (Array<String>) —

  One or more VPC peering connection IDs.

  Default: Describes all your VPC peering connections.

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<VpcPeeringConnection>)

See Also:

• #create_vpc_peering_connection
• #vpc_peering_connection
• Client#describe_vpc_peering_connections

#vpcs(options = {}) ⇒ Collection<Vpc>

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

Examples:

Request syntax example with placeholder values

ec2.vpcs({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  vpc_ids: ["VpcId"],
  dry_run: false,
  next_token: "String",
  max_results: 1,
})

Enumerating Vpc resources.

ec2.vpcs.each do |vpc|
  # yields each vpc
end

Enumerating Vpc resources with a limit.

ec2.vpcs.limit(10).each do |vpc|
  # yields at most 10 vpcs
end

Options Hash (options):

• :filters (Array<Types::Filter>) —

  One or more filters.

  • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC\'s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

  • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

  • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • isDefault - Indicates whether the VPC is the default VPC.

  • owner-id - The ID of the AWS account that owns the VPC.

  • state - The state of the VPC (pending | available).

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

• :vpc_ids (Array<String>) —

  One or more VPC IDs.

  Default: Describes all your VPCs.

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

• :next_token (String) —

  The token for the next page of results.

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

Returns:

• (Collection<Vpc>)

See Also:

• #create_vpc
• #vpc
• Client#describe_vpcs