You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::EC2::Client
- Defined in:
- (unknown)
Overview
An API client for Amazon Elastic Compute Cloud. To construct a client, you need to configure a :region
and :credentials
.
ec2 = Aws::EC2::Client.new(
region: region_name,
credentials: credentials,
# ...
)
See #initialize for a full list of supported configuration options.
Region
You can configure a default region in the following locations:
ENV['AWS_REGION']
Aws.config[:region]
Go here for a list of supported regions.
Credentials
Default credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID']
andENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
- The shared credentials ini file at
~/.aws/credentials
(more information) - From an instance profile when running on EC2
You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id
and
:secret_access_key
:
# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))
Aws::EC2::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
Constructor collapse
-
#initialize(options = {}) ⇒ Aws::EC2::Client
constructor
Constructs an API client.
API Operations collapse
-
#accept_reserved_instances_exchange_quote(options = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
.
-
#accept_transit_gateway_peering_attachment(options = {}) ⇒ Types::AcceptTransitGatewayPeeringAttachmentResult
Accepts a transit gateway peering attachment request.
-
#accept_transit_gateway_vpc_attachment(options = {}) ⇒ Types::AcceptTransitGatewayVpcAttachmentResult
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the
pendingAcceptance
state. -
#accept_vpc_endpoint_connections(options = {}) ⇒ Types::AcceptVpcEndpointConnectionsResult
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
.
-
#accept_vpc_peering_connection(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
Accept a VPC peering connection request.
-
#advertise_byoip_cidr(options = {}) ⇒ Types::AdvertiseByoipCidrResult
Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS.
-
#allocate_address(options = {}) ⇒ Types::AllocateAddressResult
Allocates an Elastic IP address to your AWS account.
-
#allocate_hosts(options = {}) ⇒ Types::AllocateHostsResult
Allocates a Dedicated Host to your account.
-
#apply_security_groups_to_client_vpn_target_network(options = {}) ⇒ Types::ApplySecurityGroupsToClientVpnTargetNetworkResult
Applies a security group to the association between the target network and the Client VPN endpoint.
-
#assign_ipv_6_addresses(options = {}) ⇒ Types::AssignIpv6AddressesResult
Assigns one or more IPv6 addresses to the specified network interface.
-
#assign_private_ip_addresses(options = {}) ⇒ Types::AssignPrivateIpAddressesResult
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range.
-
#associate_address(options = {}) ⇒ Types::AssociateAddressResult
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface.
-
#associate_client_vpn_target_network(options = {}) ⇒ Types::AssociateClientVpnTargetNetworkResult
Associates a target network with a Client VPN endpoint.
-
#associate_dhcp_options(options = {}) ⇒ Struct
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options.
-
#associate_enclave_certificate_iam_role(options = {}) ⇒ Types::AssociateEnclaveCertificateIamRoleResult
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate.
-
#associate_iam_instance_profile(options = {}) ⇒ Types::AssociateIamInstanceProfileResult
Associates an IAM instance profile with a running or stopped instance.
-
#associate_route_table(options = {}) ⇒ Types::AssociateRouteTableResult
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC.
-
#associate_subnet_cidr_block(options = {}) ⇒ Types::AssociateSubnetCidrBlockResult
Associates a CIDR block with your subnet.
-
#associate_transit_gateway_multicast_domain(options = {}) ⇒ Types::AssociateTransitGatewayMulticastDomainResult
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource.
-
#associate_transit_gateway_route_table(options = {}) ⇒ Types::AssociateTransitGatewayRouteTableResult
Associates the specified attachment with the specified transit gateway route table.
-
#associate_vpc_cidr_block(options = {}) ⇒ Types::AssociateVpcCidrBlockResult
Associates a CIDR block with your VPC.
-
#attach_classic_link_vpc(options = {}) ⇒ Types::AttachClassicLinkVpcResult
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups.
-
#attach_internet_gateway(options = {}) ⇒ Struct
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.
-
#attach_network_interface(options = {}) ⇒ Types::AttachNetworkInterfaceResult
Attaches a network interface to an instance.
.
-
#attach_volume(options = {}) ⇒ Types::VolumeAttachment
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption.
-
#attach_vpn_gateway(options = {}) ⇒ Types::AttachVpnGatewayResult
Attaches a virtual private gateway to a VPC.
-
#authorize_client_vpn_ingress(options = {}) ⇒ Types::AuthorizeClientVpnIngressResult
Adds an ingress authorization rule to a Client VPN endpoint.
-
#authorize_security_group_egress(options = {}) ⇒ Struct
[VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP).
-
#authorize_security_group_ingress(options = {}) ⇒ Struct
Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP).
-
#bundle_instance(options = {}) ⇒ Types::BundleInstanceResult
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled.
-
#cancel_bundle_task(options = {}) ⇒ Types::CancelBundleTaskResult
Cancels a bundling operation for an instance store-backed Windows instance.
.
-
#cancel_capacity_reservation(options = {}) ⇒ Types::CancelCapacityReservationResult
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to
cancelled
.Instances running in the reserved capacity continue running until you stop them.
-
#cancel_conversion_task(options = {}) ⇒ Struct
Cancels an active conversion task.
-
#cancel_export_task(options = {}) ⇒ Struct
Cancels an active export task.
-
#cancel_import_task(options = {}) ⇒ Types::CancelImportTaskResult
Cancels an in-process import virtual machine or import snapshot task.
.
-
#cancel_reserved_instances_listing(options = {}) ⇒ Types::CancelReservedInstancesListingResult
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
. -
#cancel_spot_fleet_requests(options = {}) ⇒ Types::CancelSpotFleetRequestsResponse
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances.
-
#cancel_spot_instance_requests(options = {}) ⇒ Types::CancelSpotInstanceRequestsResult
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
-
#confirm_product_instance(options = {}) ⇒ Types::ConfirmProductInstanceResult
Determines whether a product code is associated with an instance.
-
#copy_fpga_image(options = {}) ⇒ Types::CopyFpgaImageResult
Copies the specified Amazon FPGA Image (AFI) to the current Region.
.
-
#copy_image(options = {}) ⇒ Types::CopyImageResult
Initiates the copy of an AMI from the specified source Region to the current Region.
-
#copy_snapshot(options = {}) ⇒ Types::CopySnapshotResult
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.
-
#create_capacity_reservation(options = {}) ⇒ Types::CreateCapacityReservationResult
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration.
-
#create_carrier_gateway(options = {}) ⇒ Types::CreateCarrierGatewayResult
Creates a carrier gateway.
-
#create_client_vpn_endpoint(options = {}) ⇒ Types::CreateClientVpnEndpointResult
Creates a Client VPN endpoint.
-
#create_client_vpn_route(options = {}) ⇒ Types::CreateClientVpnRouteResult
Adds a route to a network to a Client VPN endpoint.
-
#create_customer_gateway(options = {}) ⇒ Types::CreateCustomerGatewayResult
Provides information to AWS about your VPN customer gateway device.
-
#create_default_subnet(options = {}) ⇒ Types::CreateDefaultSubnetResult
Creates a default subnet with a size
/20
IPv4 CIDR block in the specified Availability Zone in your default VPC. -
#create_default_vpc(options = {}) ⇒ Types::CreateDefaultVpcResult
Creates a default VPC with a size
/16
IPv4 CIDR block and a default subnet in each Availability Zone. -
#create_dhcp_options(options = {}) ⇒ Types::CreateDhcpOptionsResult
Creates a set of DHCP options for your VPC.
-
#create_egress_only_internet_gateway(options = {}) ⇒ Types::CreateEgressOnlyInternetGatewayResult
[IPv6 only] Creates an egress-only internet gateway for your VPC.
-
#create_fleet(options = {}) ⇒ Types::CreateFleetResult
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
. -
#create_flow_logs(options = {}) ⇒ Types::CreateFlowLogsResult
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
-
#create_fpga_image(options = {}) ⇒ Types::CreateFpgaImageResult
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous.
-
#create_image(options = {}) ⇒ Types::CreateImageResult
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes.
-
#create_instance_export_task(options = {}) ⇒ Types::CreateInstanceExportTaskResult
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
. -
#create_internet_gateway(options = {}) ⇒ Types::CreateInternetGatewayResult
Creates an internet gateway for use with a VPC.
-
#create_key_pair(options = {}) ⇒ Types::KeyPair
Creates a 2048-bit RSA key pair with the specified name.
-
#create_launch_template(options = {}) ⇒ Types::CreateLaunchTemplateResult
Creates a launch template.
-
#create_launch_template_version(options = {}) ⇒ Types::CreateLaunchTemplateVersionResult
Creates a new version for a launch template.
-
#create_local_gateway_route(options = {}) ⇒ Types::CreateLocalGatewayRouteResult
Creates a static route for the specified local gateway route table.
.
-
#create_local_gateway_route_table_vpc_association(options = {}) ⇒ Types::CreateLocalGatewayRouteTableVpcAssociationResult
Associates the specified VPC with the specified local gateway route table.
.
-
#create_managed_prefix_list(options = {}) ⇒ Types::CreateManagedPrefixListResult
Creates a managed prefix list.
-
#create_nat_gateway(options = {}) ⇒ Types::CreateNatGatewayResult
Creates a NAT gateway in the specified public subnet.
-
#create_network_acl(options = {}) ⇒ Types::CreateNetworkAclResult
Creates a network ACL in a VPC.
-
#create_network_acl_entry(options = {}) ⇒ Struct
Creates an entry (a rule) in a network ACL with the specified rule number.
-
#create_network_interface(options = {}) ⇒ Types::CreateNetworkInterfaceResult
Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
. -
#create_network_interface_permission(options = {}) ⇒ Types::CreateNetworkInterfacePermissionResult
Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single AWS account only, and only one account at a time.
. -
#create_placement_group(options = {}) ⇒ Types::CreatePlacementGroupResult
Creates a placement group in which to launch instances.
-
#create_reserved_instances_listing(options = {}) ⇒ Types::CreateReservedInstancesListingResult
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace.
-
#create_route(options = {}) ⇒ Types::CreateRouteResult
Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match.
-
#create_route_table(options = {}) ⇒ Types::CreateRouteTableResult
Creates a route table for the specified VPC.
-
#create_security_group(options = {}) ⇒ Types::CreateSecurityGroupResult
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic.
-
#create_snapshot(options = {}) ⇒ Types::Snapshot
Creates a snapshot of an EBS volume and stores it in Amazon S3.
-
#create_snapshots(options = {}) ⇒ Types::CreateSnapshotsResult
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3.
-
#create_spot_datafeed_subscription(options = {}) ⇒ Types::CreateSpotDatafeedSubscriptionResult
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs.
-
#create_subnet(options = {}) ⇒ Types::CreateSubnetResult
Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet.
-
#create_tags(options = {}) ⇒ Struct
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources.
-
#create_traffic_mirror_filter(options = {}) ⇒ Types::CreateTrafficMirrorFilterResult
Creates a Traffic Mirror filter.
A Traffic Mirror filter is a set of rules that defines the traffic to mirror.
By default, no traffic is mirrored.
-
#create_traffic_mirror_filter_rule(options = {}) ⇒ Types::CreateTrafficMirrorFilterRuleResult
Creates a Traffic Mirror filter rule.
-
#create_traffic_mirror_session(options = {}) ⇒ Types::CreateTrafficMirrorSessionResult
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target.
-
#create_traffic_mirror_target(options = {}) ⇒ Types::CreateTrafficMirrorTargetResult
Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic.
-
#create_transit_gateway(options = {}) ⇒ Types::CreateTransitGatewayResult
Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks.
-
#create_transit_gateway_multicast_domain(options = {}) ⇒ Types::CreateTransitGatewayMulticastDomainResult
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain.
-
#create_transit_gateway_peering_attachment(options = {}) ⇒ Types::CreateTransitGatewayPeeringAttachmentResult
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).
-
#create_transit_gateway_prefix_list_reference(options = {}) ⇒ Types::CreateTransitGatewayPrefixListReferenceResult
Creates a reference (route) to a prefix list in a specified transit gateway route table.
.
-
#create_transit_gateway_route(options = {}) ⇒ Types::CreateTransitGatewayRouteResult
Creates a static route for the specified transit gateway route table.
.
-
#create_transit_gateway_route_table(options = {}) ⇒ Types::CreateTransitGatewayRouteTableResult
Creates a route table for the specified transit gateway.
.
-
#create_transit_gateway_vpc_attachment(options = {}) ⇒ Types::CreateTransitGatewayVpcAttachmentResult
Attaches the specified VPC to the specified transit gateway.
If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.
To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.
. -
#create_volume(options = {}) ⇒ Types::Volume
Creates an EBS volume that can be attached to an instance in the same Availability Zone.
-
#create_vpc(options = {}) ⇒ Types::CreateVpcResult
Creates a VPC with the specified IPv4 CIDR block.
-
#create_vpc_endpoint(options = {}) ⇒ Types::CreateVpcEndpointResult
Creates a VPC endpoint for a specified service.
-
#create_vpc_endpoint_connection_notification(options = {}) ⇒ Types::CreateVpcEndpointConnectionNotificationResult
Creates a connection notification for a specified VPC endpoint or VPC endpoint service.
-
#create_vpc_endpoint_service_configuration(options = {}) ⇒ Types::CreateVpcEndpointServiceConfigurationResult
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect.
To create an endpoint service configuration, you must first create one of the following for your service:
-
#create_vpc_peering_connection(options = {}) ⇒ Types::CreateVpcPeeringConnectionResult
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection.
-
#create_vpn_connection(options = {}) ⇒ Types::CreateVpnConnectionResult
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway.
-
#create_vpn_connection_route(options = {}) ⇒ Struct
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
#create_vpn_gateway(options = {}) ⇒ Types::CreateVpnGatewayResult
Creates a virtual private gateway.
-
#delete_carrier_gateway(options = {}) ⇒ Types::DeleteCarrierGatewayResult
Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route.
-
#delete_client_vpn_endpoint(options = {}) ⇒ Types::DeleteClientVpnEndpointResult
Deletes the specified Client VPN endpoint.
-
#delete_client_vpn_route(options = {}) ⇒ Types::DeleteClientVpnRouteResult
Deletes a route from a Client VPN endpoint.
-
#delete_customer_gateway(options = {}) ⇒ Struct
Deletes the specified customer gateway.
-
#delete_dhcp_options(options = {}) ⇒ Struct
Deletes the specified set of DHCP options.
-
#delete_egress_only_internet_gateway(options = {}) ⇒ Types::DeleteEgressOnlyInternetGatewayResult
Deletes an egress-only internet gateway.
.
-
#delete_fleets(options = {}) ⇒ Types::DeleteFleetsResult
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances.
-
#delete_flow_logs(options = {}) ⇒ Types::DeleteFlowLogsResult
Deletes one or more flow logs.
.
-
#delete_fpga_image(options = {}) ⇒ Types::DeleteFpgaImageResult
Deletes the specified Amazon FPGA Image (AFI).
.
-
#delete_internet_gateway(options = {}) ⇒ Struct
Deletes the specified internet gateway.
-
#delete_key_pair(options = {}) ⇒ Struct
Deletes the specified key pair, by removing the public key from Amazon EC2.
.
-
#delete_launch_template(options = {}) ⇒ Types::DeleteLaunchTemplateResult
Deletes a launch template.
-
#delete_launch_template_versions(options = {}) ⇒ Types::DeleteLaunchTemplateVersionsResult
Deletes one or more versions of a launch template.
-
#delete_local_gateway_route(options = {}) ⇒ Types::DeleteLocalGatewayRouteResult
Deletes the specified route from the specified local gateway route table.
.
-
#delete_local_gateway_route_table_vpc_association(options = {}) ⇒ Types::DeleteLocalGatewayRouteTableVpcAssociationResult
Deletes the specified association between a VPC and local gateway route table.
.
-
#delete_managed_prefix_list(options = {}) ⇒ Types::DeleteManagedPrefixListResult
Deletes the specified managed prefix list.
-
#delete_nat_gateway(options = {}) ⇒ Types::DeleteNatGatewayResult
Deletes the specified NAT gateway.
-
#delete_network_acl(options = {}) ⇒ Struct
Deletes the specified network ACL.
-
#delete_network_acl_entry(options = {}) ⇒ Struct
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
.
-
#delete_network_interface(options = {}) ⇒ Struct
Deletes the specified network interface.
-
#delete_network_interface_permission(options = {}) ⇒ Types::DeleteNetworkInterfacePermissionResult
Deletes a permission for a network interface.
-
#delete_placement_group(options = {}) ⇒ Struct
Deletes the specified placement group.
-
#delete_queued_reserved_instances(options = {}) ⇒ Types::DeleteQueuedReservedInstancesResult
Deletes the queued purchases for the specified Reserved Instances.
.
-
#delete_route(options = {}) ⇒ Struct
Deletes the specified route from the specified route table.
.
-
#delete_route_table(options = {}) ⇒ Struct
Deletes the specified route table.
-
#delete_security_group(options = {}) ⇒ Struct
Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with
.InvalidGroup.InUse
in EC2-Classic orDependencyViolation
in EC2-VPC. -
#delete_snapshot(options = {}) ⇒ Struct
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot.
-
#delete_spot_datafeed_subscription(options = {}) ⇒ Struct
Deletes the data feed for Spot Instances.
.
-
#delete_subnet(options = {}) ⇒ Struct
Deletes the specified subnet.
-
#delete_tags(options = {}) ⇒ Struct
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags.
-
#delete_traffic_mirror_filter(options = {}) ⇒ Types::DeleteTrafficMirrorFilterResult
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
. -
#delete_traffic_mirror_filter_rule(options = {}) ⇒ Types::DeleteTrafficMirrorFilterRuleResult
Deletes the specified Traffic Mirror rule.
.
-
#delete_traffic_mirror_session(options = {}) ⇒ Types::DeleteTrafficMirrorSessionResult
Deletes the specified Traffic Mirror session.
.
-
#delete_traffic_mirror_target(options = {}) ⇒ Types::DeleteTrafficMirrorTargetResult
Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
. -
#delete_transit_gateway(options = {}) ⇒ Types::DeleteTransitGatewayResult
Deletes the specified transit gateway.
.
-
#delete_transit_gateway_multicast_domain(options = {}) ⇒ Types::DeleteTransitGatewayMulticastDomainResult
Deletes the specified transit gateway multicast domain.
.
-
#delete_transit_gateway_peering_attachment(options = {}) ⇒ Types::DeleteTransitGatewayPeeringAttachmentResult
Deletes a transit gateway peering attachment.
.
-
#delete_transit_gateway_prefix_list_reference(options = {}) ⇒ Types::DeleteTransitGatewayPrefixListReferenceResult
Deletes a reference (route) to a prefix list in a specified transit gateway route table.
.
-
#delete_transit_gateway_route(options = {}) ⇒ Types::DeleteTransitGatewayRouteResult
Deletes the specified route from the specified transit gateway route table.
.
-
#delete_transit_gateway_route_table(options = {}) ⇒ Types::DeleteTransitGatewayRouteTableResult
Deletes the specified transit gateway route table.
-
#delete_transit_gateway_vpc_attachment(options = {}) ⇒ Types::DeleteTransitGatewayVpcAttachmentResult
Deletes the specified VPC attachment.
.
-
#delete_volume(options = {}) ⇒ Struct
Deletes the specified EBS volume.
-
#delete_vpc(options = {}) ⇒ Struct
Deletes the specified VPC.
-
#delete_vpc_endpoint_connection_notifications(options = {}) ⇒ Types::DeleteVpcEndpointConnectionNotificationsResult
Deletes one or more VPC endpoint connection notifications.
.
-
#delete_vpc_endpoint_service_configurations(options = {}) ⇒ Types::DeleteVpcEndpointServiceConfigurationsResult
Deletes one or more VPC endpoint service configurations in your account.
-
#delete_vpc_endpoints(options = {}) ⇒ Types::DeleteVpcEndpointsResult
Deletes one or more specified VPC endpoints.
-
#delete_vpc_peering_connection(options = {}) ⇒ Types::DeleteVpcPeeringConnectionResult
Deletes a VPC peering connection.
-
#delete_vpn_connection(options = {}) ⇒ Struct
Deletes the specified VPN connection.
If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection.
-
#delete_vpn_connection_route(options = {}) ⇒ Struct
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway.
-
#delete_vpn_gateway(options = {}) ⇒ Struct
Deletes the specified virtual private gateway.
-
#deprovision_byoip_cidr(options = {}) ⇒ Types::DeprovisionByoipCidrResult
Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.
. -
#deregister_image(options = {}) ⇒ Struct
Deregisters the specified AMI.
-
#deregister_instance_event_notification_attributes(options = {}) ⇒ Types::DeregisterInstanceEventNotificationAttributesResult
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
.
-
#deregister_transit_gateway_multicast_group_members(options = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupMembersResult
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
.
-
#deregister_transit_gateway_multicast_group_sources(options = {}) ⇒ Types::DeregisterTransitGatewayMulticastGroupSourcesResult
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
.
-
#describe_account_attributes(options = {}) ⇒ Types::DescribeAccountAttributesResult
Describes attributes of your AWS account.
-
#describe_addresses(options = {}) ⇒ Types::DescribeAddressesResult
Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.
-
#describe_aggregate_id_format(options = {}) ⇒ Types::DescribeAggregateIdFormatResult
Describes the longer ID format settings for all resource types in a specific Region.
-
#describe_availability_zones(options = {}) ⇒ Types::DescribeAvailabilityZonesResult
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you.
-
#describe_bundle_tasks(options = {}) ⇒ Types::DescribeBundleTasksResult
Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time.
-
#describe_byoip_cidrs(options = {}) ⇒ Types::DescribeByoipCidrsResult
Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.
To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.
. -
#describe_capacity_reservations(options = {}) ⇒ Types::DescribeCapacityReservationsResult
Describes one or more of your Capacity Reservations.
-
#describe_carrier_gateways(options = {}) ⇒ Types::DescribeCarrierGatewaysResult
Describes one or more of your carrier gateways.
.
-
#describe_classic_link_instances(options = {}) ⇒ Types::DescribeClassicLinkInstancesResult
Describes one or more of your linked EC2-Classic instances.
-
#describe_client_vpn_authorization_rules(options = {}) ⇒ Types::DescribeClientVpnAuthorizationRulesResult
Describes the authorization rules for a specified Client VPN endpoint.
.
-
#describe_client_vpn_connections(options = {}) ⇒ Types::DescribeClientVpnConnectionsResult
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
.
-
#describe_client_vpn_endpoints(options = {}) ⇒ Types::DescribeClientVpnEndpointsResult
Describes one or more Client VPN endpoints in the account.
.
-
#describe_client_vpn_routes(options = {}) ⇒ Types::DescribeClientVpnRoutesResult
Describes the routes for the specified Client VPN endpoint.
.
-
#describe_client_vpn_target_networks(options = {}) ⇒ Types::DescribeClientVpnTargetNetworksResult
Describes the target networks associated with the specified Client VPN endpoint.
.
-
#describe_coip_pools(options = {}) ⇒ Types::DescribeCoipPoolsResult
Describes the specified customer-owned address pools or all of your customer-owned address pools.
.
-
#describe_conversion_tasks(options = {}) ⇒ Types::DescribeConversionTasksResult
Describes the specified conversion tasks or all your conversion tasks.
-
#describe_customer_gateways(options = {}) ⇒ Types::DescribeCustomerGatewaysResult
Describes one or more of your VPN customer gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
. -
#describe_dhcp_options(options = {}) ⇒ Types::DescribeDhcpOptionsResult
Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
. -
#describe_egress_only_internet_gateways(options = {}) ⇒ Types::DescribeEgressOnlyInternetGatewaysResult
Describes one or more of your egress-only internet gateways.
.
-
#describe_elastic_gpus(options = {}) ⇒ Types::DescribeElasticGpusResult
Describes the Elastic Graphics accelerator associated with your instances.
-
#describe_export_image_tasks(options = {}) ⇒ Types::DescribeExportImageTasksResult
Describes the specified export image tasks or all of your export image tasks.
.
-
#describe_export_tasks(options = {}) ⇒ Types::DescribeExportTasksResult
Describes the specified export instance tasks or all of your export instance tasks.
.
-
#describe_fast_snapshot_restores(options = {}) ⇒ Types::DescribeFastSnapshotRestoresResult
Describes the state of fast snapshot restores for your snapshots.
.
-
#describe_fleet_history(options = {}) ⇒ Types::DescribeFleetHistoryResult
Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described.
-
#describe_fleet_instances(options = {}) ⇒ Types::DescribeFleetInstancesResult
Describes the running instances for the specified EC2 Fleet.
.
-
#describe_fleets(options = {}) ⇒ Types::DescribeFleetsResult
Describes the specified EC2 Fleets or all of your EC2 Fleets.
.
-
#describe_flow_logs(options = {}) ⇒ Types::DescribeFlowLogsResult
Describes one or more flow logs.
-
#describe_fpga_image_attribute(options = {}) ⇒ Types::DescribeFpgaImageAttributeResult
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
.
-
#describe_fpga_images(options = {}) ⇒ Types::DescribeFpgaImagesResult
Describes the Amazon FPGA Images (AFIs) available to you.
-
#describe_host_reservation_offerings(options = {}) ⇒ Types::DescribeHostReservationOfferingsResult
Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts.
-
#describe_host_reservations(options = {}) ⇒ Types::DescribeHostReservationsResult
Describes reservations that are associated with Dedicated Hosts in your account.
.
-
#describe_hosts(options = {}) ⇒ Types::DescribeHostsResult
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using.
-
#describe_iam_instance_profile_associations(options = {}) ⇒ Types::DescribeIamInstanceProfileAssociationsResult
Describes your IAM instance profile associations.
.
-
#describe_id_format(options = {}) ⇒ Types::DescribeIdFormatResult
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs.
-
#describe_identity_id_format(options = {}) ⇒ Types::DescribeIdentityIdFormatResult
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user.
-
#describe_image_attribute(options = {}) ⇒ Types::ImageAttribute
Describes the specified attribute of the specified AMI.
-
#describe_images(options = {}) ⇒ Types::DescribeImagesResult
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results.
-
#describe_import_image_tasks(options = {}) ⇒ Types::DescribeImportImageTasksResult
Displays details about an import virtual machine or import snapshot tasks that are already created.
.
-
#describe_import_snapshot_tasks(options = {}) ⇒ Types::DescribeImportSnapshotTasksResult
Describes your import snapshot tasks.
.
-
#describe_instance_attribute(options = {}) ⇒ Types::InstanceAttribute
Describes the specified attribute of the specified instance.
-
#describe_instance_credit_specifications(options = {}) ⇒ Types::DescribeInstanceCreditSpecificationsResult
Describes the credit option for CPU usage of the specified burstable performance instances.
-
#describe_instance_event_notification_attributes(options = {}) ⇒ Types::DescribeInstanceEventNotificationAttributesResult
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
.
-
#describe_instance_status(options = {}) ⇒ Types::DescribeInstanceStatusResult
Describes the status of the specified instances or all of your instances.
-
#describe_instance_type_offerings(options = {}) ⇒ Types::DescribeInstanceTypeOfferingsResult
Returns a list of all instance types offered.
-
#describe_instance_types(options = {}) ⇒ Types::DescribeInstanceTypesResult
Describes the details of the instance types that are offered in a location.
-
#describe_instances(options = {}) ⇒ Types::DescribeInstancesResult
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances.
-
#describe_internet_gateways(options = {}) ⇒ Types::DescribeInternetGatewaysResult
Describes one or more of your internet gateways.
.
-
#describe_ipv_6_pools(options = {}) ⇒ Types::DescribeIpv6PoolsResult
Describes your IPv6 address pools.
.
-
#describe_key_pairs(options = {}) ⇒ Types::DescribeKeyPairsResult
Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
. -
#describe_launch_template_versions(options = {}) ⇒ Types::DescribeLaunchTemplateVersionsResult
Describes one or more versions of a specified launch template.
-
#describe_launch_templates(options = {}) ⇒ Types::DescribeLaunchTemplatesResult
Describes one or more launch templates.
.
-
#describe_local_gateway_route_table_virtual_interface_group_associations(options = {}) ⇒ Types::DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult
Describes the associations between virtual interface groups and local gateway route tables.
.
-
#describe_local_gateway_route_table_vpc_associations(options = {}) ⇒ Types::DescribeLocalGatewayRouteTableVpcAssociationsResult
Describes the specified associations between VPCs and local gateway route tables.
.
-
#describe_local_gateway_route_tables(options = {}) ⇒ Types::DescribeLocalGatewayRouteTablesResult
Describes one or more local gateway route tables.
-
#describe_local_gateway_virtual_interface_groups(options = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfaceGroupsResult
Describes the specified local gateway virtual interface groups.
.
-
#describe_local_gateway_virtual_interfaces(options = {}) ⇒ Types::DescribeLocalGatewayVirtualInterfacesResult
Describes the specified local gateway virtual interfaces.
.
-
#describe_local_gateways(options = {}) ⇒ Types::DescribeLocalGatewaysResult
Describes one or more local gateways.
-
#describe_managed_prefix_lists(options = {}) ⇒ Types::DescribeManagedPrefixListsResult
Describes your managed prefix lists and any AWS-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
. -
#describe_moving_addresses(options = {}) ⇒ Types::DescribeMovingAddressesResult
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform.
-
#describe_nat_gateways(options = {}) ⇒ Types::DescribeNatGatewaysResult
Describes one or more of your NAT gateways.
.
-
#describe_network_acls(options = {}) ⇒ Types::DescribeNetworkAclsResult
Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
. -
#describe_network_interface_attribute(options = {}) ⇒ Types::DescribeNetworkInterfaceAttributeResult
Describes a network interface attribute.
-
#describe_network_interface_permissions(options = {}) ⇒ Types::DescribeNetworkInterfacePermissionsResult
Describes the permissions for your network interfaces.
-
#describe_network_interfaces(options = {}) ⇒ Types::DescribeNetworkInterfacesResult
Describes one or more of your network interfaces.
.
-
#describe_placement_groups(options = {}) ⇒ Types::DescribePlacementGroupsResult
Describes the specified placement groups or all of your placement groups.
-
#describe_prefix_lists(options = {}) ⇒ Types::DescribePrefixListsResult
Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.
We recommend that you use DescribeManagedPrefixLists instead.
. -
#describe_principal_id_format(options = {}) ⇒ Types::DescribePrincipalIdFormatResult
Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.
-
#describe_public_ipv_4_pools(options = {}) ⇒ Types::DescribePublicIpv4PoolsResult
Describes the specified IPv4 address pools.
.
-
#describe_regions(options = {}) ⇒ Types::DescribeRegionsResult
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.
For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.
. -
#describe_reserved_instances(options = {}) ⇒ Types::DescribeReservedInstancesResult
Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
. -
#describe_reserved_instances_listings(options = {}) ⇒ Types::DescribeReservedInstancesListingsResult
Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity.
-
#describe_reserved_instances_modifications(options = {}) ⇒ Types::DescribeReservedInstancesModificationsResult
Describes the modifications made to your Reserved Instances.
-
#describe_reserved_instances_offerings(options = {}) ⇒ Types::DescribeReservedInstancesOfferingsResult
Describes Reserved Instance offerings that are available for purchase.
-
#describe_route_tables(options = {}) ⇒ Types::DescribeRouteTablesResult
Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table.
-
#describe_scheduled_instance_availability(options = {}) ⇒ Types::DescribeScheduledInstanceAvailabilityResult
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance.
-
#describe_scheduled_instances(options = {}) ⇒ Types::DescribeScheduledInstancesResult
Describes the specified Scheduled Instances or all your Scheduled Instances.
.
-
#describe_security_group_references(options = {}) ⇒ Types::DescribeSecurityGroupReferencesResult
[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
.
-
#describe_security_groups(options = {}) ⇒ Types::DescribeSecurityGroupsResult
Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC.
-
#describe_snapshot_attribute(options = {}) ⇒ Types::DescribeSnapshotAttributeResult
Describes the specified attribute of the specified snapshot.
-
#describe_snapshots(options = {}) ⇒ Types::DescribeSnapshotsResult
Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
-
public: The owner of the snapshot granted create volume permissions for the snapshot to the
all
group.
-
-
#describe_spot_datafeed_subscription(options = {}) ⇒ Types::DescribeSpotDatafeedSubscriptionResult
Describes the data feed for Spot Instances.
-
#describe_spot_fleet_instances(options = {}) ⇒ Types::DescribeSpotFleetInstancesResponse
Describes the running instances for the specified Spot Fleet.
.
-
#describe_spot_fleet_request_history(options = {}) ⇒ Types::DescribeSpotFleetRequestHistoryResponse
Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described.
-
#describe_spot_fleet_requests(options = {}) ⇒ Types::DescribeSpotFleetRequestsResponse
Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
. -
#describe_spot_instance_requests(options = {}) ⇒ Types::DescribeSpotInstanceRequestsResult
Describes the specified Spot Instance requests.
You can use
DescribeSpotInstanceRequests
to find a running Spot Instance by examining the response. -
#describe_spot_price_history(options = {}) ⇒ Types::DescribeSpotPriceHistoryResult
Describes the Spot price history.
-
#describe_stale_security_groups(options = {}) ⇒ Types::DescribeStaleSecurityGroupsResult
[VPC only] Describes the stale security group rules for security groups in a specified VPC.
-
#describe_subnets(options = {}) ⇒ Types::DescribeSubnetsResult
Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
. -
#describe_tags(options = {}) ⇒ Types::DescribeTagsResult
Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
. -
#describe_traffic_mirror_filters(options = {}) ⇒ Types::DescribeTrafficMirrorFiltersResult
Describes one or more Traffic Mirror filters.
.
-
#describe_traffic_mirror_sessions(options = {}) ⇒ Types::DescribeTrafficMirrorSessionsResult
Describes one or more Traffic Mirror sessions.
-
#describe_traffic_mirror_targets(options = {}) ⇒ Types::DescribeTrafficMirrorTargetsResult
Information about one or more Traffic Mirror targets.
.
-
#describe_transit_gateway_attachments(options = {}) ⇒ Types::DescribeTransitGatewayAttachmentsResult
Describes one or more attachments between resources and transit gateways.
-
#describe_transit_gateway_multicast_domains(options = {}) ⇒ Types::DescribeTransitGatewayMulticastDomainsResult
Describes one or more transit gateway multicast domains.
.
-
#describe_transit_gateway_peering_attachments(options = {}) ⇒ Types::DescribeTransitGatewayPeeringAttachmentsResult
Describes your transit gateway peering attachments.
.
-
#describe_transit_gateway_route_tables(options = {}) ⇒ Types::DescribeTransitGatewayRouteTablesResult
Describes one or more transit gateway route tables.
-
#describe_transit_gateway_vpc_attachments(options = {}) ⇒ Types::DescribeTransitGatewayVpcAttachmentsResult
Describes one or more VPC attachments.
-
#describe_transit_gateways(options = {}) ⇒ Types::DescribeTransitGatewaysResult
Describes one or more transit gateways.
-
#describe_volume_attribute(options = {}) ⇒ Types::DescribeVolumeAttributeResult
Describes the specified attribute of the specified volume.
-
#describe_volume_status(options = {}) ⇒ Types::DescribeVolumeStatusResult
Describes the status of the specified volumes.
-
#describe_volumes(options = {}) ⇒ Types::DescribeVolumesResult
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable.
-
#describe_volumes_modifications(options = {}) ⇒ Types::DescribeVolumesModificationsResult
Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null.
-
#describe_vpc_attribute(options = {}) ⇒ Types::DescribeVpcAttributeResult
Describes the specified attribute of the specified VPC.
-
#describe_vpc_classic_link(options = {}) ⇒ Types::DescribeVpcClassicLinkResult
Describes the ClassicLink status of one or more VPCs.
.
-
#describe_vpc_classic_link_dns_support(options = {}) ⇒ Types::DescribeVpcClassicLinkDnsSupportResult
Describes the ClassicLink DNS support status of one or more VPCs.
-
#describe_vpc_endpoint_connection_notifications(options = {}) ⇒ Types::DescribeVpcEndpointConnectionNotificationsResult
Describes the connection notifications for VPC endpoints and VPC endpoint services.
.
-
#describe_vpc_endpoint_connections(options = {}) ⇒ Types::DescribeVpcEndpointConnectionsResult
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
.
-
#describe_vpc_endpoint_service_configurations(options = {}) ⇒ Types::DescribeVpcEndpointServiceConfigurationsResult
Describes the VPC endpoint service configurations in your account (your services).
.
-
#describe_vpc_endpoint_service_permissions(options = {}) ⇒ Types::DescribeVpcEndpointServicePermissionsResult
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
.
-
#describe_vpc_endpoint_services(options = {}) ⇒ Types::DescribeVpcEndpointServicesResult
Describes available services to which you can create a VPC endpoint.
When the service provider and the consumer have different accounts multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones.
-
#describe_vpc_endpoints(options = {}) ⇒ Types::DescribeVpcEndpointsResult
Describes one or more of your VPC endpoints.
.
-
#describe_vpc_peering_connections(options = {}) ⇒ Types::DescribeVpcPeeringConnectionsResult
Describes one or more of your VPC peering connections.
.
-
#describe_vpcs(options = {}) ⇒ Types::DescribeVpcsResult
Describes one or more of your VPCs.
.
-
#describe_vpn_connections(options = {}) ⇒ Types::DescribeVpnConnectionsResult
Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
. -
#describe_vpn_gateways(options = {}) ⇒ Types::DescribeVpnGatewaysResult
Describes one or more of your virtual private gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
. -
#detach_classic_link_vpc(options = {}) ⇒ Types::DetachClassicLinkVpcResult
Unlinks (detaches) a linked EC2-Classic instance from a VPC.
-
#detach_internet_gateway(options = {}) ⇒ Struct
Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC.
-
#detach_network_interface(options = {}) ⇒ Struct
Detaches a network interface from an instance.
.
-
#detach_volume(options = {}) ⇒ Types::VolumeAttachment
Detaches an EBS volume from an instance.
-
#detach_vpn_gateway(options = {}) ⇒ Struct
Detaches a virtual private gateway from a VPC.
-
#disable_ebs_encryption_by_default(options = {}) ⇒ Types::DisableEbsEncryptionByDefaultResult
Disables EBS encryption by default for your account in the current Region.
After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.
Disabling encryption by default does not change the encryption status of your existing volumes.
For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
. -
#disable_fast_snapshot_restores(options = {}) ⇒ Types::DisableFastSnapshotRestoresResult
Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
.
-
#disable_transit_gateway_route_table_propagation(options = {}) ⇒ Types::DisableTransitGatewayRouteTablePropagationResult
Disables the specified resource attachment from propagating routes to the specified propagation route table.
.
-
#disable_vgw_route_propagation(options = {}) ⇒ Struct
Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
.
-
#disable_vpc_classic_link(options = {}) ⇒ Types::DisableVpcClassicLinkResult
Disables ClassicLink for a VPC.
-
#disable_vpc_classic_link_dns_support(options = {}) ⇒ Types::DisableVpcClassicLinkDnsSupportResult
Disables ClassicLink DNS support for a VPC.
-
#disassociate_address(options = {}) ⇒ Struct
Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.
-
#disassociate_client_vpn_target_network(options = {}) ⇒ Types::DisassociateClientVpnTargetNetworkResult
Disassociates a target network from the specified Client VPN endpoint.
-
#disassociate_enclave_certificate_iam_role(options = {}) ⇒ Types::DisassociateEnclaveCertificateIamRoleResult
Disassociates an IAM role from an AWS Certificate Manager (ACM) certificate.
-
#disassociate_iam_instance_profile(options = {}) ⇒ Types::DisassociateIamInstanceProfileResult
Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
. -
#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.
-
#disassociate_subnet_cidr_block(options = {}) ⇒ Types::DisassociateSubnetCidrBlockResult
Disassociates a CIDR block from a subnet.
-
#disassociate_transit_gateway_multicast_domain(options = {}) ⇒ Types::DisassociateTransitGatewayMulticastDomainResult
Disassociates the specified subnets from the transit gateway multicast domain.
-
#disassociate_transit_gateway_route_table(options = {}) ⇒ Types::DisassociateTransitGatewayRouteTableResult
Disassociates a resource attachment from a transit gateway route table.
.
-
#disassociate_vpc_cidr_block(options = {}) ⇒ Types::DisassociateVpcCidrBlockResult
Disassociates a CIDR block from a VPC.
-
#enable_ebs_encryption_by_default(options = {}) ⇒ Types::EnableEbsEncryptionByDefaultResult
Enables EBS encryption by default for your account in the current Region.
After you enable encryption by default, the EBS volumes that you create are are always encrypted, either using the default CMK or the CMK that you specified when you created each volume.
-
#enable_fast_snapshot_restores(options = {}) ⇒ Types::EnableFastSnapshotRestoresResult
Enables fast snapshot restores for the specified snapshots in the specified Availability Zones.
You get the full benefit of fast snapshot restores after they enter the
enabled
state. -
#enable_transit_gateway_route_table_propagation(options = {}) ⇒ Types::EnableTransitGatewayRouteTablePropagationResult
Enables the specified attachment to propagate routes to the specified propagation route table.
.
-
#enable_vgw_route_propagation(options = {}) ⇒ Struct
Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
.
-
#enable_volume_io(options = {}) ⇒ Struct
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
.
-
#enable_vpc_classic_link(options = {}) ⇒ Types::EnableVpcClassicLinkResult
Enables a VPC for ClassicLink.
-
#enable_vpc_classic_link_dns_support(options = {}) ⇒ Types::EnableVpcClassicLinkDnsSupportResult
Enables a VPC to support DNS hostname resolution for ClassicLink.
-
#export_client_vpn_client_certificate_revocation_list(options = {}) ⇒ Types::ExportClientVpnClientCertificateRevocationListResult
Downloads the client certificate revocation list for the specified Client VPN endpoint.
.
-
#export_client_vpn_client_configuration(options = {}) ⇒ Types::ExportClientVpnClientConfigurationResult
Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint.
-
#export_image(options = {}) ⇒ Types::ExportImageResult
Exports an Amazon Machine Image (AMI) to a VM file.
-
#export_transit_gateway_routes(options = {}) ⇒ Types::ExportTransitGatewayRoutesResult
Exports routes from the specified transit gateway route table to the specified S3 bucket.
-
#get_associated_enclave_certificate_iam_roles(options = {}) ⇒ Types::GetAssociatedEnclaveCertificateIamRolesResult
Returns the IAM roles that are associated with the specified AWS Certificate Manager (ACM) certificate.
-
#get_associated_ipv_6_pool_cidrs(options = {}) ⇒ Types::GetAssociatedIpv6PoolCidrsResult
Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
.
-
#get_capacity_reservation_usage(options = {}) ⇒ Types::GetCapacityReservationUsageResult
Gets usage information about a Capacity Reservation.
-
#get_coip_pool_usage(options = {}) ⇒ Types::GetCoipPoolUsageResult
Describes the allocations from the specified customer-owned address pool.
.
-
#get_console_output(options = {}) ⇒ Types::GetConsoleOutputResult
Gets the console output for the specified instance.
-
#get_console_screenshot(options = {}) ⇒ Types::GetConsoleScreenshotResult
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
. -
#get_default_credit_specification(options = {}) ⇒ Types::GetDefaultCreditSpecificationResult
Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
. -
#get_ebs_default_kms_key_id(options = {}) ⇒ Types::GetEbsDefaultKmsKeyIdResult
Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
-
#get_ebs_encryption_by_default(options = {}) ⇒ Types::GetEbsEncryptionByDefaultResult
Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
. -
#get_groups_for_capacity_reservation(options = {}) ⇒ Types::GetGroupsForCapacityReservationResult
Lists the resource groups to which a Capacity Reservation has been added.
.
-
#get_host_reservation_purchase_preview(options = {}) ⇒ Types::GetHostReservationPurchasePreviewResult
Preview a reservation purchase with configurations that match those of your Dedicated Host.
-
#get_launch_template_data(options = {}) ⇒ Types::GetLaunchTemplateDataResult
Retrieves the configuration data of the specified instance.
-
#get_managed_prefix_list_associations(options = {}) ⇒ Types::GetManagedPrefixListAssociationsResult
Gets information about the resources that are associated with the specified managed prefix list.
.
-
#get_managed_prefix_list_entries(options = {}) ⇒ Types::GetManagedPrefixListEntriesResult
Gets information about the entries for a specified managed prefix list.
.
-
#get_password_data(options = {}) ⇒ Types::GetPasswordDataResult
Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the
EC2Config
service orEC2Launch
scripts (Windows Server 2016 and later). -
#get_reserved_instances_exchange_quote(options = {}) ⇒ Types::GetReservedInstancesExchangeQuoteResult
Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance.
-
#get_transit_gateway_attachment_propagations(options = {}) ⇒ Types::GetTransitGatewayAttachmentPropagationsResult
Lists the route tables to which the specified resource attachment propagates routes.
.
-
#get_transit_gateway_multicast_domain_associations(options = {}) ⇒ Types::GetTransitGatewayMulticastDomainAssociationsResult
Gets information about the associations for the transit gateway multicast domain.
.
-
#get_transit_gateway_prefix_list_references(options = {}) ⇒ Types::GetTransitGatewayPrefixListReferencesResult
Gets information about the prefix list references in a specified transit gateway route table.
.
-
#get_transit_gateway_route_table_associations(options = {}) ⇒ Types::GetTransitGatewayRouteTableAssociationsResult
Gets information about the associations for the specified transit gateway route table.
.
-
#get_transit_gateway_route_table_propagations(options = {}) ⇒ Types::GetTransitGatewayRouteTablePropagationsResult
Gets information about the route table propagations for the specified transit gateway route table.
.
-
#import_client_vpn_client_certificate_revocation_list(options = {}) ⇒ Types::ImportClientVpnClientCertificateRevocationListResult
Uploads a client certificate revocation list to the specified Client VPN endpoint.
-
#import_image(options = {}) ⇒ Types::ImportImageResult
Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).
-
#import_instance(options = {}) ⇒ Types::ImportInstanceResult
Creates an import instance task using metadata from the specified disk image.
-
#import_key_pair(options = {}) ⇒ Types::ImportKeyPairResult
Imports the public key from an RSA key pair that you created with a third-party tool.
-
#import_snapshot(options = {}) ⇒ Types::ImportSnapshotResult
Imports a disk into an EBS snapshot.
.
-
#import_volume(options = {}) ⇒ Types::ImportVolumeResult
Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
For information about the import manifest referenced by this API action, see VM Import Manifest.
. -
#modify_availability_zone_group(options = {}) ⇒ Types::ModifyAvailabilityZoneGroupResult
Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for
.GroupName
. -
#modify_capacity_reservation(options = {}) ⇒ Types::ModifyCapacityReservationResult
Modifies a Capacity Reservation's capacity and the conditions under which it is to be released.
-
#modify_client_vpn_endpoint(options = {}) ⇒ Types::ModifyClientVpnEndpointResult
Modifies the specified Client VPN endpoint.
-
#modify_default_credit_specification(options = {}) ⇒ Types::ModifyDefaultCreditSpecificationResult
Modifies the default credit option for CPU usage of burstable performance instances.
-
#modify_ebs_default_kms_key_id(options = {}) ⇒ Types::ModifyEbsDefaultKmsKeyIdResult
Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.
AWS creates a unique AWS managed CMK in each Region for use with encryption by default.
-
#modify_fleet(options = {}) ⇒ Types::ModifyFleetResult
Modifies the specified EC2 Fleet.
You can only modify an EC2 Fleet request of type
maintain
.While the EC2 Fleet is being modified, it is in the
modifying
state.To scale up your EC2 Fleet, increase its target capacity.
-
#modify_fpga_image_attribute(options = {}) ⇒ Types::ModifyFpgaImageAttributeResult
Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
.
-
#modify_hosts(options = {}) ⇒ Types::ModifyHostsResult
Modify the auto-placement setting of a Dedicated Host.
-
#modify_id_format(options = {}) ⇒ Struct
Modifies the ID format for the specified resource on a per-Region basis.
-
#modify_identity_id_format(options = {}) ⇒ Struct
Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account.
-
#modify_image_attribute(options = {}) ⇒ Struct
Modifies the specified attribute of the specified AMI.
-
#modify_instance_attribute(options = {}) ⇒ Struct
Modifies the specified attribute of the specified instance.
-
#modify_instance_capacity_reservation_attributes(options = {}) ⇒ Types::ModifyInstanceCapacityReservationAttributesResult
Modifies the Capacity Reservation settings for a stopped instance.
-
#modify_instance_credit_specification(options = {}) ⇒ Types::ModifyInstanceCreditSpecificationResult
Modifies the credit option for CPU usage on a running or stopped burstable performance instance.
-
#modify_instance_event_start_time(options = {}) ⇒ Types::ModifyInstanceEventStartTimeResult
Modifies the start time for a scheduled Amazon EC2 instance event.
.
-
#modify_instance_metadata_options(options = {}) ⇒ Types::ModifyInstanceMetadataOptionsResult
Modify the instance metadata parameters on a running or stopped instance.
-
#modify_instance_placement(options = {}) ⇒ Types::ModifyInstancePlacementResult
Modifies the placement attributes for a specified instance.
-
#modify_launch_template(options = {}) ⇒ Types::ModifyLaunchTemplateResult
Modifies a launch template.
-
#modify_managed_prefix_list(options = {}) ⇒ Types::ModifyManagedPrefixListResult
Modifies the specified managed prefix list.
Adding or removing entries in a prefix list creates a new version of the prefix list.
-
#modify_network_interface_attribute(options = {}) ⇒ Struct
Modifies the specified network interface attribute.
-
#modify_reserved_instances(options = {}) ⇒ Types::ModifyReservedInstancesResult
Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.
-
#modify_snapshot_attribute(options = {}) ⇒ Struct
Adds or removes permission settings for the specified snapshot.
-
#modify_spot_fleet_request(options = {}) ⇒ Types::ModifySpotFleetRequestResponse
Modifies the specified Spot Fleet request.
You can only modify a Spot Fleet request of type
maintain
.While the Spot Fleet request is being modified, it is in the
modifying
state.To scale up your Spot Fleet, increase its target capacity.
-
#modify_subnet_attribute(options = {}) ⇒ Struct
Modifies a subnet attribute.
-
#modify_traffic_mirror_filter_network_services(options = {}) ⇒ Types::ModifyTrafficMirrorFilterNetworkServicesResult
Allows or restricts mirroring network services.
By default, Amazon DNS network services are not eligible for Traffic Mirror.
-
#modify_traffic_mirror_filter_rule(options = {}) ⇒ Types::ModifyTrafficMirrorFilterRuleResult
Modifies the specified Traffic Mirror rule.
DestinationCidrBlock
andSourceCidrBlock
must both be an IPv4 range or an IPv6 range. -
#modify_traffic_mirror_session(options = {}) ⇒ Types::ModifyTrafficMirrorSessionResult
Modifies a Traffic Mirror session.
.
-
#modify_transit_gateway(options = {}) ⇒ Types::ModifyTransitGatewayResult
Modifies the specified transit gateway.
-
#modify_transit_gateway_prefix_list_reference(options = {}) ⇒ Types::ModifyTransitGatewayPrefixListReferenceResult
Modifies a reference (route) to a prefix list in a specified transit gateway route table.
.
-
#modify_transit_gateway_vpc_attachment(options = {}) ⇒ Types::ModifyTransitGatewayVpcAttachmentResult
Modifies the specified VPC attachment.
.
-
#modify_volume(options = {}) ⇒ Types::ModifyVolumeResult
You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity.
-
#modify_volume_attribute(options = {}) ⇒ Struct
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption.
-
#modify_vpc_attribute(options = {}) ⇒ Struct
Modifies the specified attribute of the specified VPC.
.
-
#modify_vpc_endpoint(options = {}) ⇒ Types::ModifyVpcEndpointResult
Modifies attributes of a specified VPC endpoint.
-
#modify_vpc_endpoint_connection_notification(options = {}) ⇒ Types::ModifyVpcEndpointConnectionNotificationResult
Modifies a connection notification for VPC endpoint or VPC endpoint service.
-
#modify_vpc_endpoint_service_configuration(options = {}) ⇒ Types::ModifyVpcEndpointServiceConfigurationResult
Modifies the attributes of your VPC endpoint service configuration.
-
#modify_vpc_endpoint_service_permissions(options = {}) ⇒ Types::ModifyVpcEndpointServicePermissionsResult
Modifies the permissions for your VPC endpoint service.
-
#modify_vpc_peering_connection_options(options = {}) ⇒ Types::ModifyVpcPeeringConnectionOptionsResult
Modifies the VPC peering connection options on one side of a VPC peering connection.
-
#modify_vpc_tenancy(options = {}) ⇒ Types::ModifyVpcTenancyResult
Modifies the instance tenancy attribute of the specified VPC.
-
#modify_vpn_connection(options = {}) ⇒ Types::ModifyVpnConnectionResult
Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection.
-
#modify_vpn_connection_options(options = {}) ⇒ Types::ModifyVpnConnectionOptionsResult
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change.
-
#modify_vpn_tunnel_certificate(options = {}) ⇒ Types::ModifyVpnTunnelCertificateResult
Modifies the VPN tunnel endpoint certificate.
.
-
#modify_vpn_tunnel_options(options = {}) ⇒ Types::ModifyVpnTunnelOptionsResult
Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection.
-
#monitor_instances(options = {}) ⇒ Types::MonitorInstancesResult
Enables detailed monitoring for a running instance.
-
#move_address_to_vpc(options = {}) ⇒ Types::MoveAddressToVpcResult
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.
-
#provision_byoip_cidr(options = {}) ⇒ Types::ProvisionByoipCidrResult
Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.
-
#purchase_host_reservation(options = {}) ⇒ Types::PurchaseHostReservationResult
Purchase a reservation with configurations that match those of your Dedicated Host.
-
#purchase_reserved_instances_offering(options = {}) ⇒ Types::PurchaseReservedInstancesOfferingResult
Purchases a Reserved Instance for use with your account.
-
#purchase_scheduled_instances(options = {}) ⇒ Types::PurchaseScheduledInstancesResult
Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term.
-
#reboot_instances(options = {}) ⇒ Struct
Requests a reboot of the specified instances.
-
#register_image(options = {}) ⇒ Types::RegisterImageResult
Registers an AMI.
-
#register_instance_event_notification_attributes(options = {}) ⇒ Types::RegisterInstanceEventNotificationAttributesResult
Registers a set of tag keys to include in scheduled event notifications for your resources.
-
#register_transit_gateway_multicast_group_members(options = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupMembersResult
Registers members (network interfaces) with the transit gateway multicast group.
-
#register_transit_gateway_multicast_group_sources(options = {}) ⇒ Types::RegisterTransitGatewayMulticastGroupSourcesResult
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic.
-
#reject_transit_gateway_peering_attachment(options = {}) ⇒ Types::RejectTransitGatewayPeeringAttachmentResult
Rejects a transit gateway peering attachment request.
.
-
#reject_transit_gateway_vpc_attachment(options = {}) ⇒ Types::RejectTransitGatewayVpcAttachmentResult
Rejects a request to attach a VPC to a transit gateway.
The VPC attachment must be in the
pendingAcceptance
state. -
#reject_vpc_endpoint_connections(options = {}) ⇒ Types::RejectVpcEndpointConnectionsResult
Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
.
-
#reject_vpc_peering_connection(options = {}) ⇒ Types::RejectVpcPeeringConnectionResult
Rejects a VPC peering connection request.
-
#release_address(options = {}) ⇒ Struct
Releases the specified Elastic IP address.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with.
-
#release_hosts(options = {}) ⇒ Types::ReleaseHostsResult
When you no longer want to use an On-Demand Dedicated Host it can be released.
-
#replace_iam_instance_profile_association(options = {}) ⇒ Types::ReplaceIamInstanceProfileAssociationResult
Replaces an IAM instance profile for the specified running instance.
-
#replace_network_acl_association(options = {}) ⇒ Types::ReplaceNetworkAclAssociationResult
Changes which network ACL a subnet is associated with.
-
#replace_network_acl_entry(options = {}) ⇒ Struct
Replaces an entry (rule) in a network ACL.
-
#replace_route(options = {}) ⇒ Struct
Replaces an existing route within a route table in a VPC.
-
#replace_route_table_association(options = {}) ⇒ Types::ReplaceRouteTableAssociationResult
Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC.
-
#replace_transit_gateway_route(options = {}) ⇒ Types::ReplaceTransitGatewayRouteResult
Replaces the specified route in the specified transit gateway route table.
.
-
#report_instance_status(options = {}) ⇒ Struct
Submits feedback about the status of an instance.
-
#request_spot_fleet(options = {}) ⇒ Types::RequestSpotFleetResponse
Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity.
-
#request_spot_instances(options = {}) ⇒ Types::RequestSpotInstancesResult
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
. -
#reset_ebs_default_kms_key_id(options = {}) ⇒ Types::ResetEbsDefaultKmsKeyIdResult
Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.
After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume.
-
#reset_fpga_image_attribute(options = {}) ⇒ Types::ResetFpgaImageAttributeResult
Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value.
-
#reset_image_attribute(options = {}) ⇒ Struct
Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
-
#reset_instance_attribute(options = {}) ⇒ Struct
Resets an attribute of an instance to its default value.
-
#reset_network_interface_attribute(options = {}) ⇒ Struct
Resets a network interface attribute.
-
#reset_snapshot_attribute(options = {}) ⇒ Struct
Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing snapshots in the Amazon Elastic Compute Cloud User Guide.
. -
#restore_address_to_classic(options = {}) ⇒ Types::RestoreAddressToClassicResult
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.
-
#restore_managed_prefix_list_version(options = {}) ⇒ Types::RestoreManagedPrefixListVersionResult
Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
.
-
#revoke_client_vpn_ingress(options = {}) ⇒ Types::RevokeClientVpnIngressResult
Removes an ingress authorization rule from a Client VPN endpoint.
-
#revoke_security_group_egress(options = {}) ⇒ Types::RevokeSecurityGroupEgressResult
[VPC only] Removes the specified egress rules from a security group for EC2-VPC.
-
#revoke_security_group_ingress(options = {}) ⇒ Types::RevokeSecurityGroupIngressResult
Removes the specified ingress rules from a security group.
-
#run_instances(options = {}) ⇒ Types::Reservation
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options.
-
#run_scheduled_instances(options = {}) ⇒ Types::RunScheduledInstancesResult
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period.
-
#search_local_gateway_routes(options = {}) ⇒ Types::SearchLocalGatewayRoutesResult
Searches for routes in the specified local gateway route table.
.
-
#search_transit_gateway_multicast_groups(options = {}) ⇒ Types::SearchTransitGatewayMulticastGroupsResult
Searches one or more transit gateway multicast groups and returns the group membership information.
.
-
#search_transit_gateway_routes(options = {}) ⇒ Types::SearchTransitGatewayRoutesResult
Searches for routes in the specified transit gateway route table.
.
-
#send_diagnostic_interrupt(options = {}) ⇒ Struct
Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances).
-
#start_instances(options = {}) ⇒ Types::StartInstancesResult
Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started.
-
#start_vpc_endpoint_service_private_dns_verification(options = {}) ⇒ Types::StartVpcEndpointServicePrivateDnsVerificationResult
Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.
The service provider must successfully perform the verification before the consumer can use the name to access the service.
Before the service provider runs this command, they must add a record to the DNS server.
-
#stop_instances(options = {}) ⇒ Types::StopInstancesResult
Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites.
-
#terminate_client_vpn_connections(options = {}) ⇒ Types::TerminateClientVpnConnectionsResult
Terminates active Client VPN endpoint connections.
-
#terminate_instances(options = {}) ⇒ Types::TerminateInstancesResult
Shuts down the specified instances.
-
#unassign_ipv_6_addresses(options = {}) ⇒ Types::UnassignIpv6AddressesResult
Unassigns one or more IPv6 addresses from a network interface.
.
-
#unassign_private_ip_addresses(options = {}) ⇒ Struct
Unassigns one or more secondary private IP addresses from a network interface.
.
-
#unmonitor_instances(options = {}) ⇒ Types::UnmonitorInstancesResult
Disables detailed monitoring for a running instance.
-
#update_security_group_rule_descriptions_egress(options = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsEgressResult
[VPC only] Updates the description of an egress (outbound) security group rule.
-
#update_security_group_rule_descriptions_ingress(options = {}) ⇒ Types::UpdateSecurityGroupRuleDescriptionsIngressResult
Updates the description of an ingress (inbound) security group rule.
-
#withdraw_byoip_cidr(options = {}) ⇒ Types::WithdrawByoipCidrResult
Stops advertising an address range that is provisioned as an address pool.
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays.
.
Instance Method Summary collapse
-
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
-
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
Methods inherited from Seahorse::Client::Base
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options = {}) ⇒ Aws::EC2::Client
Constructs an API client.
Instance Method Details
#accept_reserved_instances_exchange_quote(options = {}) ⇒ Types::AcceptReservedInstancesExchangeQuoteResult
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
#accept_transit_gateway_peering_attachment(options = {}) ⇒ Types::AcceptTransitGatewayPeeringAttachmentResult
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance
state.
#accept_transit_gateway_vpc_attachment(options = {}) ⇒ Types::AcceptTransitGatewayVpcAttachmentResult
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the pendingAcceptance
state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.
#accept_vpc_endpoint_connections(options = {}) ⇒ Types::AcceptVpcEndpointConnectionsResult
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
#accept_vpc_peering_connection(options = {}) ⇒ Types::AcceptVpcPeeringConnectionResult
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance
state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
#advertise_byoip_cidr(options = {}) ⇒ Types::AdvertiseByoipCidrResult
Advertises an IPv4 or IPv6 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.
It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
#allocate_address(options = {}) ⇒ Types::AllocateAddressResult
Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
#allocate_hosts(options = {}) ⇒ Types::AllocateHostsResult
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
#apply_security_groups_to_client_vpn_target_network(options = {}) ⇒ Types::ApplySecurityGroupsToClientVpnTargetNetworkResult
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
#assign_ipv_6_addresses(options = {}) ⇒ Types::AssignIpv6AddressesResult
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
#assign_private_ip_addresses(options = {}) ⇒ Types::AssignPrivateIpAddressesResult
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s
in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
#associate_address(options = {}) ⇒ Types::AssociateAddressResult
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
#associate_client_vpn_target_network(options = {}) ⇒ Types::AssociateClientVpnTargetNetworkResult
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that's associated with it.
#associate_dhcp_options(options = {}) ⇒ Struct
Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
#associate_enclave_certificate_iam_role(options = {}) ⇒ Types::AssociateEnclaveCertificateIamRoleResult
Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see AWS Certificate Manager for Nitro Enclaves in the AWS Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, places the certificate, certificate chain, and encrypted private key in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS-managed KMS customer master (CMK) that has an attached attestation-based CMK policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject
on the Amazon S3 bucket returned by the command. To enable the IAM role to access the AWS KMS CMK, you must grant it permission to call kms:Decrypt
on AWS KMS CMK returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the AWS Nitro Enclaves User Guide.
#associate_iam_instance_profile(options = {}) ⇒ Types::AssociateIamInstanceProfileResult
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
#associate_route_table(options = {}) ⇒ Types::AssociateRouteTableResult
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
#associate_subnet_cidr_block(options = {}) ⇒ Types::AssociateSubnetCidrBlockResult
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
#associate_transit_gateway_multicast_domain(options = {}) ⇒ Types::AssociateTransitGatewayMulticastDomainResult
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
#associate_transit_gateway_route_table(options = {}) ⇒ Types::AssociateTransitGatewayRouteTableResult
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
#associate_vpc_cidr_block(options = {}) ⇒ Types::AssociateVpcCidrBlockResult
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
#attach_classic_link_vpc(options = {}) ⇒ Types::AttachClassicLinkVpcResult
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running
state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.
After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
#attach_internet_gateway(options = {}) ⇒ Struct
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
#attach_network_interface(options = {}) ⇒ Types::AttachNetworkInterfaceResult
Attaches a network interface to an instance.
#attach_volume(options = {}) ⇒ Types::VolumeAttachment
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
After you attach an EBS volume, you must make it available. For more information, see Making an EBS volume available for use.
If a volume has an AWS Marketplace product code:
-
The volume can be attached only to a stopped instance.
-
AWS Marketplace product codes are copied from the volume to the instance.
-
You must be subscribed to the product.
-
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attaching Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
#attach_vpn_gateway(options = {}) ⇒ Types::AttachVpnGatewayResult
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
#authorize_client_vpn_ingress(options = {}) ⇒ Types::AuthorizeClientVpnIngressResult
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.
#authorize_security_group_egress(options = {}) ⇒ Struct
[VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
#authorize_security_group_ingress(options = {}) ⇒ Struct
Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group limits, see Amazon VPC Limits.
#bundle_instance(options = {}) ⇒ Types::BundleInstanceResult
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
#cancel_bundle_task(options = {}) ⇒ Types::CancelBundleTaskResult
Cancels a bundling operation for an instance store-backed Windows instance.
#cancel_capacity_reservation(options = {}) ⇒ Types::CancelCapacityReservationResult
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled
.
Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
#cancel_conversion_task(options = {}) ⇒ Struct
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
#cancel_export_task(options = {}) ⇒ Struct
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
#cancel_import_task(options = {}) ⇒ Types::CancelImportTaskResult
Cancels an in-process import virtual machine or import snapshot task.
#cancel_reserved_instances_listing(options = {}) ⇒ Types::CancelReservedInstancesListingResult
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
#cancel_spot_fleet_requests(options = {}) ⇒ Types::CancelSpotFleetRequestsResponse
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating
state. Otherwise, the Spot Fleet request enters the cancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.
#cancel_spot_instance_requests(options = {}) ⇒ Types::CancelSpotInstanceRequestsResult
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
#confirm_product_instance(options = {}) ⇒ Types::ConfirmProductInstanceResult
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
#copy_fpga_image(options = {}) ⇒ Types::CopyFpgaImageResult
Copies the specified Amazon FPGA Image (AFI) to the current Region.
#copy_image(options = {}) ⇒ Types::CopyImageResult
Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted
during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
#copy_snapshot(options = {}) ⇒ Types::CopySnapshotResult
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
#create_capacity_reservation(options = {}) ⇒ Types::CreateCapacityReservationResult
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.
#create_carrier_gateway(options = {}) ⇒ Types::CreateCarrierGatewayResult
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.
#create_client_vpn_endpoint(options = {}) ⇒ Types::CreateClientVpnEndpointResult
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
#create_client_vpn_route(options = {}) ⇒ Types::CreateClientVpnRouteResult
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
#create_customer_gateway(options = {}) ⇒ Types::CreateCustomerGatewayResult
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 4-byte ASN numbers in the range of 1 - 2147483647, with the exception of the following:
-
7224 - reserved in the
us-east-1
Region -
9059 - reserved in the
eu-west-1
Region -
17943 - reserved in the
ap-southeast-1
Region -
10124 - reserved in the
ap-northeast-1
Region
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. Identical requests return information about the existing customer gateway and do not create new customer gateways.
#create_default_subnet(options = {}) ⇒ Types::CreateDefaultSubnetResult
Creates a default subnet with a size /20
IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.
#create_default_vpc(options = {}) ⇒ Types::CreateDefaultVpcResult
Creates a default VPC with a size /16
IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
#create_dhcp_options(options = {}) ⇒ Types::CreateDhcpOptionsResult
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
-
domain-name-servers
- The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified indomain-name
, you must setdomain-name-servers
to a custom DNS server. -
domain-name
- If you're using AmazonProvidedDNS inus-east-1
, specifyec2.internal
. If you're using AmazonProvidedDNS in another Region, specifyregion.compute.internal
(for example,ap-northeast-1.compute.internal
). Otherwise, specify a domain name (for example,ExampleCompany.com
). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name. -
ntp-servers
- The IP addresses of up to four Network Time Protocol (NTP) servers. -
netbios-name-servers
- The IP addresses of up to four NetBIOS name servers. -
netbios-node-type
- The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers
option either to AmazonProvidedDNS
or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
#create_egress_only_internet_gateway(options = {}) ⇒ Types::CreateEgressOnlyInternetGatewayResult
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
#create_fleet(options = {}) ⇒ Types::CreateFleetResult
Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
#create_flow_logs(options = {}) ⇒ Types::CreateFlowLogsResult
Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
#create_fpga_image(options = {}) ⇒ Types::CreateFpgaImageResult
Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.
#create_image(options = {}) ⇒ Types::CreateImageResult
Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
#create_instance_export_task(options = {}) ⇒ Types::CreateInstanceExportTaskResult
Exports a running or stopped instance to an Amazon S3 bucket.
For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.
#create_internet_gateway(options = {}) ⇒ Types::CreateInternetGatewayResult
Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.
For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
#create_key_pair(options = {}) ⇒ Types::KeyPair
Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
#create_launch_template(options = {}) ⇒ Types::CreateLaunchTemplateResult
Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.
#create_launch_template_version(options = {}) ⇒ Types::CreateLaunchTemplateVersionResult
Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
For more information, see Managing launch template versionsin the Amazon Elastic Compute Cloud User Guide.