@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonEC2Client extends AmazonWebServiceClient implements AmazonEC2
Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.
To learn more, see the following resources:
Amazon EC2: AmazonEC2 product page, Amazon EC2 documentation
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
Amazon VPC: Amazon VPC product page, Amazon VPC documentation
AWS VPN: AWS VPN product page, AWS VPN documentation
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonEC2Client()
Deprecated.
|
AmazonEC2Client(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonEC2ClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonEC2Client(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonEC2Client(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion@Deprecated public AmazonEC2Client()
AmazonEC2ClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonEC2Client(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonEC2Client(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonEC2ClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonEC2Client(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonEC2Client(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon EC2 (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonEC2ClientBuilder builder()
public AcceptReservedInstancesExchangeQuoteResult acceptReservedInstancesExchangeQuote(AcceptReservedInstancesExchangeQuoteRequest request)
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
acceptReservedInstancesExchangeQuote in interface AmazonEC2acceptReservedInstancesExchangeQuoteRequest - Contains the parameters for accepting the quote.public AcceptTransitGatewayPeeringAttachmentResult acceptTransitGatewayPeeringAttachment(AcceptTransitGatewayPeeringAttachmentRequest request)
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance state.
acceptTransitGatewayPeeringAttachment in interface AmazonEC2acceptTransitGatewayPeeringAttachmentRequest - public AcceptTransitGatewayVpcAttachmentResult acceptTransitGatewayVpcAttachment(AcceptTransitGatewayVpcAttachmentRequest request)
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.
acceptTransitGatewayVpcAttachment in interface AmazonEC2acceptTransitGatewayVpcAttachmentRequest - public AcceptVpcEndpointConnectionsResult acceptVpcEndpointConnections(AcceptVpcEndpointConnectionsRequest request)
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
acceptVpcEndpointConnections in interface AmazonEC2acceptVpcEndpointConnectionsRequest - public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest request)
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.
acceptVpcPeeringConnection in interface AmazonEC2acceptVpcPeeringConnectionRequest - public AcceptVpcPeeringConnectionResult acceptVpcPeeringConnection()
AmazonEC2acceptVpcPeeringConnection in interface AmazonEC2AmazonEC2.acceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest)public AdvertiseByoipCidrResult advertiseByoipCidr(AdvertiseByoipCidrRequest request)
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.
advertiseByoipCidr in interface AmazonEC2advertiseByoipCidrRequest - public AllocateAddressResult allocateAddress(AllocateAddressRequest request)
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.
allocateAddress in interface AmazonEC2allocateAddressRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AllocateAddressRequest request = new AllocateAddressRequest().withDomain("vpc");
AllocateAddressResult response = client.allocateAddress(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AllocateAddressRequest request = new AllocateAddressRequest();
AllocateAddressResult response = client.allocateAddress(request);public AllocateAddressResult allocateAddress()
AmazonEC2allocateAddress in interface AmazonEC2AmazonEC2.allocateAddress(AllocateAddressRequest)public AllocateHostsResult allocateHosts(AllocateHostsRequest request)
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.
allocateHosts in interface AmazonEC2allocateHostsRequest - public ApplySecurityGroupsToClientVpnTargetNetworkResult applySecurityGroupsToClientVpnTargetNetwork(ApplySecurityGroupsToClientVpnTargetNetworkRequest request)
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.
applySecurityGroupsToClientVpnTargetNetwork in interface AmazonEC2applySecurityGroupsToClientVpnTargetNetworkRequest - public AssignIpv6AddressesResult assignIpv6Addresses(AssignIpv6AddressesRequest request)
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.
assignIpv6Addresses in interface AmazonEC2assignIpv6AddressesRequest - public AssignPrivateIpAddressesResult assignPrivateIpAddresses(AssignPrivateIpAddressesRequest request)
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.
assignPrivateIpAddresses in interface AmazonEC2assignPrivateIpAddressesRequest - Contains the parameters for AssignPrivateIpAddresses.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssignPrivateIpAddressesRequest request = new AssignPrivateIpAddressesRequest().withNetworkInterfaceId("eni-e5aa89a3").withPrivateIpAddresses(
"10.0.0.82");
AssignPrivateIpAddressesResult response = client.assignPrivateIpAddresses(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssignPrivateIpAddressesRequest request = new AssignPrivateIpAddressesRequest().withNetworkInterfaceId("eni-e5aa89a3")
.withSecondaryPrivateIpAddressCount(2);
AssignPrivateIpAddressesResult response = client.assignPrivateIpAddresses(request);public AssociateAddressResult associateAddress(AssociateAddressRequest request)
Associates an Elastic IP address 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.
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.
associateAddress in interface AmazonEC2associateAddressRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateAddressRequest request = new AssociateAddressRequest().withAllocationId("eipalloc-64d5890a").withInstanceId("i-0b263919b6498b123");
AssociateAddressResult response = client.associateAddress(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateAddressRequest request = new AssociateAddressRequest().withAllocationId("eipalloc-64d5890a").withNetworkInterfaceId("eni-1a2b3c4d");
AssociateAddressResult response = client.associateAddress(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateAddressRequest request = new AssociateAddressRequest().withInstanceId("i-07ffe74c7330ebf53").withPublicIp("198.51.100.0");
AssociateAddressResult response = client.associateAddress(request);public AssociateClientVpnTargetNetworkResult associateClientVpnTargetNetwork(AssociateClientVpnTargetNetworkRequest request)
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.
associateClientVpnTargetNetwork in interface AmazonEC2associateClientVpnTargetNetworkRequest - public AssociateDhcpOptionsResult associateDhcpOptions(AssociateDhcpOptionsRequest request)
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.
associateDhcpOptions in interface AmazonEC2associateDhcpOptionsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateDhcpOptionsRequest request = new AssociateDhcpOptionsRequest().withDhcpOptionsId("dopt-d9070ebb").withVpcId("vpc-a01106c2");
AssociateDhcpOptionsResult response = client.associateDhcpOptions(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateDhcpOptionsRequest request = new AssociateDhcpOptionsRequest().withDhcpOptionsId("default").withVpcId("vpc-a01106c2");
AssociateDhcpOptionsResult response = client.associateDhcpOptions(request);public AssociateIamInstanceProfileResult associateIamInstanceProfile(AssociateIamInstanceProfileRequest request)
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
associateIamInstanceProfile in interface AmazonEC2associateIamInstanceProfileRequest - public AssociateRouteTableResult associateRouteTable(AssociateRouteTableRequest request)
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.
associateRouteTable in interface AmazonEC2associateRouteTableRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AssociateRouteTableRequest request = new AssociateRouteTableRequest().withRouteTableId("rtb-22574640").withSubnetId("subnet-9d4a7b6");
AssociateRouteTableResult response = client.associateRouteTable(request);public AssociateSubnetCidrBlockResult associateSubnetCidrBlock(AssociateSubnetCidrBlockRequest request)
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.
associateSubnetCidrBlock in interface AmazonEC2associateSubnetCidrBlockRequest - public AssociateTransitGatewayMulticastDomainResult associateTransitGatewayMulticastDomain(AssociateTransitGatewayMulticastDomainRequest request)
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.
associateTransitGatewayMulticastDomain in interface AmazonEC2associateTransitGatewayMulticastDomainRequest - public AssociateTransitGatewayRouteTableResult associateTransitGatewayRouteTable(AssociateTransitGatewayRouteTableRequest request)
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
associateTransitGatewayRouteTable in interface AmazonEC2associateTransitGatewayRouteTableRequest - public AssociateVpcCidrBlockResult associateVpcCidrBlock(AssociateVpcCidrBlockRequest request)
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.
associateVpcCidrBlock in interface AmazonEC2associateVpcCidrBlockRequest - public AttachClassicLinkVpcResult attachClassicLinkVpc(AttachClassicLinkVpcRequest request)
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.
attachClassicLinkVpc in interface AmazonEC2attachClassicLinkVpcRequest - public AttachInternetGatewayResult attachInternetGateway(AttachInternetGatewayRequest request)
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.
attachInternetGateway in interface AmazonEC2attachInternetGatewayRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AttachInternetGatewayRequest request = new AttachInternetGatewayRequest().withInternetGatewayId("igw-c0a643a9").withVpcId("vpc-a01106c2");
AttachInternetGatewayResult response = client.attachInternetGateway(request);public AttachNetworkInterfaceResult attachNetworkInterface(AttachNetworkInterfaceRequest request)
Attaches a network interface to an instance.
attachNetworkInterface in interface AmazonEC2attachNetworkInterfaceRequest - Contains the parameters for AttachNetworkInterface.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AttachNetworkInterfaceRequest request = new AttachNetworkInterfaceRequest().withDeviceIndex(1).withInstanceId("i-1234567890abcdef0")
.withNetworkInterfaceId("eni-e5aa89a3");
AttachNetworkInterfaceResult response = client.attachNetworkInterface(request);public AttachVolumeResult attachVolume(AttachVolumeRequest request)
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.
attachVolume in interface AmazonEC2attachVolumeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
AttachVolumeRequest request = new AttachVolumeRequest().withDevice("/dev/sdf").withInstanceId("i-01474ef662b89480")
.withVolumeId("vol-1234567890abcdef0");
AttachVolumeResult response = client.attachVolume(request);public AttachVpnGatewayResult attachVpnGateway(AttachVpnGatewayRequest request)
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.
attachVpnGateway in interface AmazonEC2attachVpnGatewayRequest - Contains the parameters for AttachVpnGateway.public AuthorizeClientVpnIngressResult authorizeClientVpnIngress(AuthorizeClientVpnIngressRequest request)
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.
authorizeClientVpnIngress in interface AmazonEC2authorizeClientVpnIngressRequest - public AuthorizeSecurityGroupEgressResult authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest request)
[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.
authorizeSecurityGroupEgress in interface AmazonEC2authorizeSecurityGroupEgressRequest - public AuthorizeSecurityGroupIngressResult authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest request)
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.
authorizeSecurityGroupIngress in interface AmazonEC2authorizeSecurityGroupIngressRequest - public BundleInstanceResult bundleInstance(BundleInstanceRequest request)
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.
bundleInstance in interface AmazonEC2bundleInstanceRequest - Contains the parameters for BundleInstance.public CancelBundleTaskResult cancelBundleTask(CancelBundleTaskRequest request)
Cancels a bundling operation for an instance store-backed Windows instance.
cancelBundleTask in interface AmazonEC2cancelBundleTaskRequest - Contains the parameters for CancelBundleTask.public CancelCapacityReservationResult cancelCapacityReservation(CancelCapacityReservationRequest request)
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.
cancelCapacityReservation in interface AmazonEC2cancelCapacityReservationRequest - public CancelConversionTaskResult cancelConversionTask(CancelConversionTaskRequest request)
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.
cancelConversionTask in interface AmazonEC2cancelConversionTaskRequest - public CancelExportTaskResult cancelExportTask(CancelExportTaskRequest request)
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.
cancelExportTask in interface AmazonEC2cancelExportTaskRequest - public CancelImportTaskResult cancelImportTask(CancelImportTaskRequest request)
Cancels an in-process import virtual machine or import snapshot task.
cancelImportTask in interface AmazonEC2cancelImportTaskRequest - public CancelImportTaskResult cancelImportTask()
AmazonEC2cancelImportTask in interface AmazonEC2AmazonEC2.cancelImportTask(CancelImportTaskRequest)public CancelReservedInstancesListingResult cancelReservedInstancesListing(CancelReservedInstancesListingRequest request)
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.
cancelReservedInstancesListing in interface AmazonEC2cancelReservedInstancesListingRequest - Contains the parameters for CancelReservedInstancesListing.public CancelSpotFleetRequestsResult cancelSpotFleetRequests(CancelSpotFleetRequestsRequest request)
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.
cancelSpotFleetRequests in interface AmazonEC2cancelSpotFleetRequestsRequest - Contains the parameters for CancelSpotFleetRequests.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CancelSpotFleetRequestsRequest request = new CancelSpotFleetRequestsRequest().withSpotFleetRequestIds("sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE")
.withTerminateInstances(true);
CancelSpotFleetRequestsResult response = client.cancelSpotFleetRequests(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CancelSpotFleetRequestsRequest request = new CancelSpotFleetRequestsRequest().withSpotFleetRequestIds("sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE")
.withTerminateInstances(false);
CancelSpotFleetRequestsResult response = client.cancelSpotFleetRequests(request);public CancelSpotInstanceRequestsResult cancelSpotInstanceRequests(CancelSpotInstanceRequestsRequest request)
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
cancelSpotInstanceRequests in interface AmazonEC2cancelSpotInstanceRequestsRequest - Contains the parameters for CancelSpotInstanceRequests.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CancelSpotInstanceRequestsRequest request = new CancelSpotInstanceRequestsRequest().withSpotInstanceRequestIds("sir-08b93456");
CancelSpotInstanceRequestsResult response = client.cancelSpotInstanceRequests(request);public ConfirmProductInstanceResult confirmProductInstance(ConfirmProductInstanceRequest request)
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.
confirmProductInstance in interface AmazonEC2confirmProductInstanceRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
ConfirmProductInstanceRequest request = new ConfirmProductInstanceRequest().withInstanceId("i-1234567890abcdef0").withProductCode("774F4FF8");
ConfirmProductInstanceResult response = client.confirmProductInstance(request);public CopyFpgaImageResult copyFpgaImage(CopyFpgaImageRequest request)
Copies the specified Amazon FPGA Image (AFI) to the current Region.
copyFpgaImage in interface AmazonEC2copyFpgaImageRequest - public CopyImageResult copyImage(CopyImageRequest request)
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.
copyImage in interface AmazonEC2copyImageRequest - Contains the parameters for CopyImage.public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
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.
copySnapshot in interface AmazonEC2copySnapshotRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CopySnapshotRequest request = new CopySnapshotRequest().withDescription("This is my copied snapshot.").withDestinationRegion("us-east-1")
.withSourceRegion("us-west-2").withSourceSnapshotId("snap-066877671789bd71b");
CopySnapshotResult response = client.copySnapshot(request);public CreateCapacityReservationResult createCapacityReservation(CreateCapacityReservationRequest request)
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.
createCapacityReservation in interface AmazonEC2createCapacityReservationRequest - public CreateClientVpnEndpointResult createClientVpnEndpoint(CreateClientVpnEndpointRequest request)
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.
createClientVpnEndpoint in interface AmazonEC2createClientVpnEndpointRequest - public CreateClientVpnRouteResult createClientVpnRoute(CreateClientVpnRouteRequest request)
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.
createClientVpnRoute in interface AmazonEC2createClientVpnRouteRequest - public CreateCustomerGatewayResult createCustomerGateway(CreateCustomerGatewayRequest request)
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 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is
reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-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.
createCustomerGateway in interface AmazonEC2createCustomerGatewayRequest - Contains the parameters for CreateCustomerGateway.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateCustomerGatewayRequest request = new CreateCustomerGatewayRequest().withBgpAsn(65534).withPublicIp("12.1.2.3").withType("ipsec.1");
CreateCustomerGatewayResult response = client.createCustomerGateway(request);public CreateDefaultSubnetResult createDefaultSubnet(CreateDefaultSubnetRequest request)
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.
createDefaultSubnet in interface AmazonEC2createDefaultSubnetRequest - public CreateDefaultVpcResult createDefaultVpc(CreateDefaultVpcRequest request)
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.
createDefaultVpc in interface AmazonEC2createDefaultVpcRequest - public CreateDhcpOptionsResult createDhcpOptions(CreateDhcpOptionsRequest request)
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 in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify
ec2.internal. If you're using AmazonProvidedDNS in another Region, specify
region.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.
createDhcpOptions in interface AmazonEC2createDhcpOptionsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateDhcpOptionsRequest request = new CreateDhcpOptionsRequest().withDhcpConfigurations(new DhcpConfiguration().withKey("domain-name-servers")
.withValues("10.2.5.1", "10.2.5.2"));
CreateDhcpOptionsResult response = client.createDhcpOptions(request);public CreateEgressOnlyInternetGatewayResult createEgressOnlyInternetGateway(CreateEgressOnlyInternetGatewayRequest request)
[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.
createEgressOnlyInternetGateway in interface AmazonEC2createEgressOnlyInternetGatewayRequest - public CreateFleetResult createFleet(CreateFleetRequest request)
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.
createFleet in interface AmazonEC2createFleetRequest - public CreateFlowLogsResult createFlowLogs(CreateFlowLogsRequest request)
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.
createFlowLogs in interface AmazonEC2createFlowLogsRequest - public CreateFpgaImageResult createFpgaImage(CreateFpgaImageRequest request)
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.
createFpgaImage in interface AmazonEC2createFpgaImageRequest - public CreateImageResult createImage(CreateImageRequest request)
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.
createImage in interface AmazonEC2createImageRequest - public CreateInstanceExportTaskResult createInstanceExportTask(CreateInstanceExportTaskRequest request)
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.
createInstanceExportTask in interface AmazonEC2createInstanceExportTaskRequest - public CreateInternetGatewayResult createInternetGateway(CreateInternetGatewayRequest request)
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.
createInternetGateway in interface AmazonEC2createInternetGatewayRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); CreateInternetGatewayRequest request = new CreateInternetGatewayRequest(); CreateInternetGatewayResult response = client.createInternetGateway(request);
public CreateInternetGatewayResult createInternetGateway()
AmazonEC2createInternetGateway in interface AmazonEC2AmazonEC2.createInternetGateway(CreateInternetGatewayRequest)public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
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.
createKeyPair in interface AmazonEC2createKeyPairRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateKeyPairRequest request = new CreateKeyPairRequest().withKeyName("my-key-pair");
CreateKeyPairResult response = client.createKeyPair(request);public CreateLaunchTemplateResult createLaunchTemplate(CreateLaunchTemplateRequest request)
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.
createLaunchTemplate in interface AmazonEC2createLaunchTemplateRequest - public CreateLaunchTemplateVersionResult createLaunchTemplateVersion(CreateLaunchTemplateVersionRequest request)
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.
createLaunchTemplateVersion in interface AmazonEC2createLaunchTemplateVersionRequest - public CreateLocalGatewayRouteResult createLocalGatewayRoute(CreateLocalGatewayRouteRequest request)
Creates a static route for the specified local gateway route table.
createLocalGatewayRoute in interface AmazonEC2createLocalGatewayRouteRequest - public CreateLocalGatewayRouteTableVpcAssociationResult createLocalGatewayRouteTableVpcAssociation(CreateLocalGatewayRouteTableVpcAssociationRequest request)
Associates the specified VPC with the specified local gateway route table.
createLocalGatewayRouteTableVpcAssociation in interface AmazonEC2createLocalGatewayRouteTableVpcAssociationRequest - public CreateManagedPrefixListResult createManagedPrefixList(CreateManagedPrefixListRequest request)
Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.
You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.
createManagedPrefixList in interface AmazonEC2createManagedPrefixListRequest - public CreateNatGatewayResult createNatGateway(CreateNatGatewayRequest request)
Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.
createNatGateway in interface AmazonEC2createNatGatewayRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateNatGatewayRequest request = new CreateNatGatewayRequest().withAllocationId("eipalloc-37fc1a52").withSubnetId("subnet-1a2b3c4d");
CreateNatGatewayResult response = client.createNatGateway(request);public CreateNetworkAclResult createNetworkAcl(CreateNetworkAclRequest request)
Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
createNetworkAcl in interface AmazonEC2createNetworkAclRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateNetworkAclRequest request = new CreateNetworkAclRequest().withVpcId("vpc-a01106c2");
CreateNetworkAclResult response = client.createNetworkAcl(request);public CreateNetworkAclEntryResult createNetworkAclEntry(CreateNetworkAclEntryRequest request)
Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.
We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.
After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.
For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
createNetworkAclEntry in interface AmazonEC2createNetworkAclEntryRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateNetworkAclEntryRequest request = new CreateNetworkAclEntryRequest().withCidrBlock("0.0.0.0/0").withEgress(false).withNetworkAclId("acl-5fb85d36")
.withPortRange(new PortRange().withFrom(53).withTo(53)).withProtocol("udp").withRuleAction("allow").withRuleNumber(100);
CreateNetworkAclEntryResult response = client.createNetworkAclEntry(request);public CreateNetworkInterfaceResult createNetworkInterface(CreateNetworkInterfaceRequest request)
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.
createNetworkInterface in interface AmazonEC2createNetworkInterfaceRequest - Contains the parameters for CreateNetworkInterface.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateNetworkInterfaceRequest request = new CreateNetworkInterfaceRequest().withDescription("my network interface").withGroups("sg-903004f8")
.withPrivateIpAddress("10.0.2.17").withSubnetId("subnet-9d4a7b6c");
CreateNetworkInterfaceResult response = client.createNetworkInterface(request);public CreateNetworkInterfacePermissionResult createNetworkInterfacePermission(CreateNetworkInterfacePermissionRequest request)
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.
createNetworkInterfacePermission in interface AmazonEC2createNetworkInterfacePermissionRequest - Contains the parameters for CreateNetworkInterfacePermission.public CreatePlacementGroupResult createPlacementGroup(CreatePlacementGroupRequest request)
Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that
benefit from low network latency, high network throughput. A spread placement group places instances
on distinct hardware. A partition placement group places groups of instances in different
partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
createPlacementGroup in interface AmazonEC2createPlacementGroupRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreatePlacementGroupRequest request = new CreatePlacementGroupRequest().withGroupName("my-cluster").withStrategy("cluster");
CreatePlacementGroupResult response = client.createPlacementGroup(request);public CreateReservedInstancesListingResult createReservedInstancesListing(CreateReservedInstancesListingRequest request)
Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
createReservedInstancesListing in interface AmazonEC2createReservedInstancesListingRequest - Contains the parameters for CreateReservedInstancesListing.public CreateRouteResult createRoute(CreateRouteRequest request)
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. For example, traffic is
destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list
covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where
to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
createRoute in interface AmazonEC2createRouteRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateRouteRequest request = new CreateRouteRequest().withDestinationCidrBlock("0.0.0.0/0").withGatewayId("igw-c0a643a9")
.withRouteTableId("rtb-22574640");
CreateRouteResult response = client.createRoute(request);public CreateRouteTableResult createRouteTable(CreateRouteTableRequest request)
Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
createRouteTable in interface AmazonEC2createRouteTableRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateRouteTableRequest request = new CreateRouteTableRequest().withVpcId("vpc-a01106c2");
CreateRouteTableResult response = client.createRouteTable(request);public CreateSecurityGroupResult createSecurityGroup(CreateSecurityGroupRequest request)
Creates a security group.
A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.
For more information about VPC security group limits, see Amazon VPC Limits.
createSecurityGroup in interface AmazonEC2createSecurityGroupRequest - public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been
written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been
cached by any applications or the operating system. If you can pause any file systems on the volume long enough
to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume,
you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume
to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is
pending.
To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
createSnapshot in interface AmazonEC2createSnapshotRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateSnapshotRequest request = new CreateSnapshotRequest().withDescription("This is my root volume snapshot.").withVolumeId("vol-1234567890abcdef0");
CreateSnapshotResult response = client.createSnapshot(request);public CreateSnapshotsResult createSnapshots(CreateSnapshotsRequest request)
Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.
createSnapshots in interface AmazonEC2createSnapshotsRequest - public CreateSpotDatafeedSubscriptionResult createSpotDatafeedSubscription(CreateSpotDatafeedSubscriptionRequest request)
Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
createSpotDatafeedSubscription in interface AmazonEC2createSpotDatafeedSubscriptionRequest - Contains the parameters for CreateSpotDatafeedSubscription.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateSpotDatafeedSubscriptionRequest request = new CreateSpotDatafeedSubscriptionRequest().withBucket("my-s3-bucket").withPrefix("spotdata");
CreateSpotDatafeedSubscriptionResult response = client.createSpotDatafeedSubscription(request);public CreateSubnetResult createSubnet(CreateSubnetRequest request)
Creates a subnet in a specified VPC.
You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.
When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.
For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
createSubnet in interface AmazonEC2createSubnetRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateSubnetRequest request = new CreateSubnetRequest().withCidrBlock("10.0.1.0/24").withVpcId("vpc-a01106c2");
CreateSubnetResult response = client.createSubnet(request);public CreateTagsResult createTags(CreateTagsRequest request)
Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.
createTags in interface AmazonEC2createTagsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateTagsRequest request = new CreateTagsRequest().withResources("ami-78a54011").withTags(new Tag().withKey("Stack").withValue("production"));
CreateTagsResult response = client.createTags(request);public CreateTrafficMirrorFilterResult createTrafficMirrorFilter(CreateTrafficMirrorFilterRequest request)
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. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.
createTrafficMirrorFilter in interface AmazonEC2createTrafficMirrorFilterRequest - public CreateTrafficMirrorFilterRuleResult createTrafficMirrorFilterRule(CreateTrafficMirrorFilterRuleRequest request)
Creates a Traffic Mirror filter rule.
A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.
You need the Traffic Mirror filter ID when you create the rule.
createTrafficMirrorFilterRule in interface AmazonEC2createTrafficMirrorFilterRuleRequest - public CreateTrafficMirrorSessionResult createTrafficMirrorSession(CreateTrafficMirrorSessionRequest request)
Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
createTrafficMirrorSession in interface AmazonEC2createTrafficMirrorSessionRequest - public CreateTrafficMirrorTargetResult createTrafficMirrorTarget(CreateTrafficMirrorTargetRequest request)
Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, or a Network Load Balancer.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
createTrafficMirrorTarget in interface AmazonEC2createTrafficMirrorTargetRequest - public CreateTransitGatewayResult createTransitGateway(CreateTransitGatewayRequest request)
Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After
the transit gateway enters the available state, you can attach your VPCs and VPN connections to the
transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
createTransitGateway in interface AmazonEC2createTransitGatewayRequest - public CreateTransitGatewayMulticastDomainResult createTransitGatewayMulticastDomain(CreateTransitGatewayMulticastDomainRequest request)
Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
createTransitGatewayMulticastDomain in interface AmazonEC2createTransitGatewayMulticastDomainRequest - public CreateTransitGatewayPeeringAttachmentResult createTransitGatewayPeeringAttachment(CreateTransitGatewayPeeringAttachmentRequest request)
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
createTransitGatewayPeeringAttachment in interface AmazonEC2createTransitGatewayPeeringAttachmentRequest - public CreateTransitGatewayRouteResult createTransitGatewayRoute(CreateTransitGatewayRouteRequest request)
Creates a static route for the specified transit gateway route table.
createTransitGatewayRoute in interface AmazonEC2createTransitGatewayRouteRequest - public CreateTransitGatewayRouteTableResult createTransitGatewayRouteTable(CreateTransitGatewayRouteTableRequest request)
Creates a route table for the specified transit gateway.
createTransitGatewayRouteTable in interface AmazonEC2createTransitGatewayRouteTableRequest - public CreateTransitGatewayVpcAttachmentResult createTransitGatewayVpcAttachment(CreateTransitGatewayVpcAttachmentRequest request)
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.
createTransitGatewayVpcAttachment in interface AmazonEC2createTransitGatewayVpcAttachmentRequest - public CreateVolumeResult createVolume(CreateVolumeRequest request)
Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
createVolume in interface AmazonEC2createVolumeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateVolumeRequest request = new CreateVolumeRequest().withAvailabilityZone("us-east-1a").withSize(80).withVolumeType("gp2");
CreateVolumeResult response = client.createVolume(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateVolumeRequest request = new CreateVolumeRequest().withAvailabilityZone("us-east-1a").withIops(1000).withSnapshotId("snap-066877671789bd71b")
.withVolumeType("io1");
CreateVolumeResult response = client.createVolume(request);public CreateVpcResult createVpc(CreateVpcRequest request)
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an IPv6 CIDR block for the VPC. You can request an Amazon-provided IPv6 CIDR block from Amazon's pool of IPv6 addresses, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.
createVpc in interface AmazonEC2createVpcRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
CreateVpcRequest request = new CreateVpcRequest().withCidrBlock("10.0.0.0/16");
CreateVpcResult response = client.createVpc(request);public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
A gateway endpoint serves as a target for a route in your route table for traffic destined for the
AWS service. You can specify an endpoint policy to attach to the endpoint, which will control access to the
service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for
communicating with the specified service. You can specify the subnets in which to create an endpoint, and the
security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported services.
createVpcEndpoint in interface AmazonEC2createVpcEndpointRequest - Contains the parameters for CreateVpcEndpoint.public CreateVpcEndpointConnectionNotificationResult createVpcEndpointConnectionNotification(CreateVpcEndpointConnectionNotificationRequest request)
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
createVpcEndpointConnectionNotification in interface AmazonEC2createVpcEndpointConnectionNotificationRequest - public CreateVpcEndpointServiceConfigurationResult createVpcEndpointServiceConfiguration(CreateVpcEndpointServiceConfigurationRequest request)
Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.
To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.
If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
createVpcEndpointServiceConfiguration in interface AmazonEC2createVpcEndpointServiceConfigurationRequest - public CreateVpcPeeringConnectionResult createVpcPeeringConnection(CreateVpcPeeringConnectionRequest request)
Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering
connection has a status of failed.
createVpcPeeringConnection in interface AmazonEC2createVpcPeeringConnectionRequest - public CreateVpcPeeringConnectionResult createVpcPeeringConnection()
AmazonEC2createVpcPeeringConnection in interface AmazonEC2AmazonEC2.createVpcPeeringConnection(CreateVpcPeeringConnectionRequest)public CreateVpnConnectionResult createVpnConnection(CreateVpnConnectionRequest request)
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported
connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnConnection in interface AmazonEC2createVpnConnectionRequest - Contains the parameters for CreateVpnConnection.public CreateVpnConnectionRouteResult createVpnConnectionRoute(CreateVpnConnectionRouteRequest request)
Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnConnectionRoute in interface AmazonEC2createVpnConnectionRouteRequest - Contains the parameters for CreateVpnConnectionRoute.public CreateVpnGatewayResult createVpnGateway(CreateVpnGatewayRequest request)
Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
createVpnGateway in interface AmazonEC2createVpnGatewayRequest - Contains the parameters for CreateVpnGateway.public DeleteClientVpnEndpointResult deleteClientVpnEndpoint(DeleteClientVpnEndpointRequest request)
Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
deleteClientVpnEndpoint in interface AmazonEC2deleteClientVpnEndpointRequest - public DeleteClientVpnRouteResult deleteClientVpnRoute(DeleteClientVpnRouteRequest request)
Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.
deleteClientVpnRoute in interface AmazonEC2deleteClientVpnRouteRequest - public DeleteCustomerGatewayResult deleteCustomerGateway(DeleteCustomerGatewayRequest request)
Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
deleteCustomerGateway in interface AmazonEC2deleteCustomerGatewayRequest - Contains the parameters for DeleteCustomerGateway.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteCustomerGatewayRequest request = new DeleteCustomerGatewayRequest().withCustomerGatewayId("cgw-0e11f167");
DeleteCustomerGatewayResult response = client.deleteCustomerGateway(request);public DeleteDhcpOptionsResult deleteDhcpOptions(DeleteDhcpOptionsRequest request)
Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
deleteDhcpOptions in interface AmazonEC2deleteDhcpOptionsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteDhcpOptionsRequest request = new DeleteDhcpOptionsRequest().withDhcpOptionsId("dopt-d9070ebb");
DeleteDhcpOptionsResult response = client.deleteDhcpOptions(request);public DeleteEgressOnlyInternetGatewayResult deleteEgressOnlyInternetGateway(DeleteEgressOnlyInternetGatewayRequest request)
Deletes an egress-only internet gateway.
deleteEgressOnlyInternetGateway in interface AmazonEC2deleteEgressOnlyInternetGatewayRequest - public DeleteFleetsResult deleteFleets(DeleteFleetsRequest request)
Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also
terminate its instances. If you terminate the instances, the EC2 Fleet enters the
deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state,
and the instances continue to run until they are interrupted or you terminate them manually.
deleteFleets in interface AmazonEC2deleteFleetsRequest - public DeleteFlowLogsResult deleteFlowLogs(DeleteFlowLogsRequest request)
Deletes one or more flow logs.
deleteFlowLogs in interface AmazonEC2deleteFlowLogsRequest - public DeleteFpgaImageResult deleteFpgaImage(DeleteFpgaImageRequest request)
Deletes the specified Amazon FPGA Image (AFI).
deleteFpgaImage in interface AmazonEC2deleteFpgaImageRequest - public DeleteInternetGatewayResult deleteInternetGateway(DeleteInternetGatewayRequest request)
Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
deleteInternetGateway in interface AmazonEC2deleteInternetGatewayRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteInternetGatewayRequest request = new DeleteInternetGatewayRequest().withInternetGatewayId("igw-c0a643a9");
DeleteInternetGatewayResult response = client.deleteInternetGateway(request);public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
Deletes the specified key pair, by removing the public key from Amazon EC2.
deleteKeyPair in interface AmazonEC2deleteKeyPairRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteKeyPairRequest request = new DeleteKeyPairRequest().withKeyName("my-key-pair");
DeleteKeyPairResult response = client.deleteKeyPair(request);public DeleteLaunchTemplateResult deleteLaunchTemplate(DeleteLaunchTemplateRequest request)
Deletes a launch template. Deleting a launch template deletes all of its versions.
deleteLaunchTemplate in interface AmazonEC2deleteLaunchTemplateRequest - public DeleteLaunchTemplateVersionsResult deleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest request)
Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
deleteLaunchTemplateVersions in interface AmazonEC2deleteLaunchTemplateVersionsRequest - public DeleteLocalGatewayRouteResult deleteLocalGatewayRoute(DeleteLocalGatewayRouteRequest request)
Deletes the specified route from the specified local gateway route table.
deleteLocalGatewayRoute in interface AmazonEC2deleteLocalGatewayRouteRequest - public DeleteLocalGatewayRouteTableVpcAssociationResult deleteLocalGatewayRouteTableVpcAssociation(DeleteLocalGatewayRouteTableVpcAssociationRequest request)
Deletes the specified association between a VPC and local gateway route table.
deleteLocalGatewayRouteTableVpcAssociation in interface AmazonEC2deleteLocalGatewayRouteTableVpcAssociationRequest - public DeleteManagedPrefixListResult deleteManagedPrefixList(DeleteManagedPrefixListRequest request)
Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
deleteManagedPrefixList in interface AmazonEC2deleteManagedPrefixListRequest - public DeleteNatGatewayResult deleteNatGateway(DeleteNatGatewayRequest request)
Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.
deleteNatGateway in interface AmazonEC2deleteNatGatewayRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteNatGatewayRequest request = new DeleteNatGatewayRequest().withNatGatewayId("nat-04ae55e711cec5680");
DeleteNatGatewayResult response = client.deleteNatGateway(request);public DeleteNetworkAclResult deleteNetworkAcl(DeleteNetworkAclRequest request)
Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.
deleteNetworkAcl in interface AmazonEC2deleteNetworkAclRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteNetworkAclRequest request = new DeleteNetworkAclRequest().withNetworkAclId("acl-5fb85d36");
DeleteNetworkAclResult response = client.deleteNetworkAcl(request);public DeleteNetworkAclEntryResult deleteNetworkAclEntry(DeleteNetworkAclEntryRequest request)
Deletes the specified ingress or egress entry (rule) from the specified network ACL.
deleteNetworkAclEntry in interface AmazonEC2deleteNetworkAclEntryRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteNetworkAclEntryRequest request = new DeleteNetworkAclEntryRequest().withEgress(true).withNetworkAclId("acl-5fb85d36").withRuleNumber(100);
DeleteNetworkAclEntryResult response = client.deleteNetworkAclEntry(request);public DeleteNetworkInterfaceResult deleteNetworkInterface(DeleteNetworkInterfaceRequest request)
Deletes the specified network interface. You must detach the network interface before you can delete it.
deleteNetworkInterface in interface AmazonEC2deleteNetworkInterfaceRequest - Contains the parameters for DeleteNetworkInterface.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteNetworkInterfaceRequest request = new DeleteNetworkInterfaceRequest().withNetworkInterfaceId("eni-e5aa89a3");
DeleteNetworkInterfaceResult response = client.deleteNetworkInterface(request);public DeleteNetworkInterfacePermissionResult deleteNetworkInterfacePermission(DeleteNetworkInterfacePermissionRequest request)
Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.
deleteNetworkInterfacePermission in interface AmazonEC2deleteNetworkInterfacePermissionRequest - Contains the parameters for DeleteNetworkInterfacePermission.public DeletePlacementGroupResult deletePlacementGroup(DeletePlacementGroupRequest request)
Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
deletePlacementGroup in interface AmazonEC2deletePlacementGroupRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeletePlacementGroupRequest request = new DeletePlacementGroupRequest().withGroupName("my-cluster");
DeletePlacementGroupResult response = client.deletePlacementGroup(request);public DeleteQueuedReservedInstancesResult deleteQueuedReservedInstances(DeleteQueuedReservedInstancesRequest request)
Deletes the queued purchases for the specified Reserved Instances.
deleteQueuedReservedInstances in interface AmazonEC2deleteQueuedReservedInstancesRequest - public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
Deletes the specified route from the specified route table.
deleteRoute in interface AmazonEC2deleteRouteRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteRouteRequest request = new DeleteRouteRequest().withDestinationCidrBlock("0.0.0.0/0").withRouteTableId("rtb-22574640");
DeleteRouteResult response = client.deleteRoute(request);public DeleteRouteTableResult deleteRouteTable(DeleteRouteTableRequest request)
Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.
deleteRouteTable in interface AmazonEC2deleteRouteTableRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteRouteTableRequest request = new DeleteRouteTableRequest().withRouteTableId("rtb-22574640");
DeleteRouteTableResult response = client.deleteRouteTable(request);public DeleteSecurityGroupResult deleteSecurityGroup(DeleteSecurityGroupRequest request)
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 or
DependencyViolation in EC2-VPC.
deleteSecurityGroup in interface AmazonEC2deleteSecurityGroupRequest - public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
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. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
deleteSnapshot in interface AmazonEC2deleteSnapshotRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteSnapshotRequest request = new DeleteSnapshotRequest().withSnapshotId("snap-1234567890abcdef0");
DeleteSnapshotResult response = client.deleteSnapshot(request);public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest request)
Deletes the data feed for Spot Instances.
deleteSpotDatafeedSubscription in interface AmazonEC2deleteSpotDatafeedSubscriptionRequest - Contains the parameters for DeleteSpotDatafeedSubscription.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); DeleteSpotDatafeedSubscriptionRequest request = new DeleteSpotDatafeedSubscriptionRequest(); DeleteSpotDatafeedSubscriptionResult response = client.deleteSpotDatafeedSubscription(request);
public DeleteSpotDatafeedSubscriptionResult deleteSpotDatafeedSubscription()
AmazonEC2deleteSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.deleteSpotDatafeedSubscription(DeleteSpotDatafeedSubscriptionRequest)public DeleteSubnetResult deleteSubnet(DeleteSubnetRequest request)
Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
deleteSubnet in interface AmazonEC2deleteSubnetRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteSubnetRequest request = new DeleteSubnetRequest().withSubnetId("subnet-9d4a7b6c");
DeleteSubnetResult response = client.deleteSubnet(request);public DeleteTagsResult deleteTags(DeleteTagsRequest request)
Deletes the specified set of tags from the specified set of resources.
To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
deleteTags in interface AmazonEC2deleteTagsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteTagsRequest request = new DeleteTagsRequest().withResources("ami-78a54011").withTags(new Tag().withKey("Stack").withValue("test"));
DeleteTagsResult response = client.deleteTags(request);public DeleteTrafficMirrorFilterResult deleteTrafficMirrorFilter(DeleteTrafficMirrorFilterRequest request)
Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
deleteTrafficMirrorFilter in interface AmazonEC2deleteTrafficMirrorFilterRequest - public DeleteTrafficMirrorFilterRuleResult deleteTrafficMirrorFilterRule(DeleteTrafficMirrorFilterRuleRequest request)
Deletes the specified Traffic Mirror rule.
deleteTrafficMirrorFilterRule in interface AmazonEC2deleteTrafficMirrorFilterRuleRequest - public DeleteTrafficMirrorSessionResult deleteTrafficMirrorSession(DeleteTrafficMirrorSessionRequest request)
Deletes the specified Traffic Mirror session.
deleteTrafficMirrorSession in interface AmazonEC2deleteTrafficMirrorSessionRequest - public DeleteTrafficMirrorTargetResult deleteTrafficMirrorTarget(DeleteTrafficMirrorTargetRequest request)
Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
deleteTrafficMirrorTarget in interface AmazonEC2deleteTrafficMirrorTargetRequest - public DeleteTransitGatewayResult deleteTransitGateway(DeleteTransitGatewayRequest request)
Deletes the specified transit gateway.
deleteTransitGateway in interface AmazonEC2deleteTransitGatewayRequest - public DeleteTransitGatewayMulticastDomainResult deleteTransitGatewayMulticastDomain(DeleteTransitGatewayMulticastDomainRequest request)
Deletes the specified transit gateway multicast domain.
deleteTransitGatewayMulticastDomain in interface AmazonEC2deleteTransitGatewayMulticastDomainRequest - public DeleteTransitGatewayPeeringAttachmentResult deleteTransitGatewayPeeringAttachment(DeleteTransitGatewayPeeringAttachmentRequest request)
Deletes a transit gateway peering attachment.
deleteTransitGatewayPeeringAttachment in interface AmazonEC2deleteTransitGatewayPeeringAttachmentRequest - public DeleteTransitGatewayRouteResult deleteTransitGatewayRoute(DeleteTransitGatewayRouteRequest request)
Deletes the specified route from the specified transit gateway route table.
deleteTransitGatewayRoute in interface AmazonEC2deleteTransitGatewayRouteRequest - public DeleteTransitGatewayRouteTableResult deleteTransitGatewayRouteTable(DeleteTransitGatewayRouteTableRequest request)
Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
deleteTransitGatewayRouteTable in interface AmazonEC2deleteTransitGatewayRouteTableRequest - public DeleteTransitGatewayVpcAttachmentResult deleteTransitGatewayVpcAttachment(DeleteTransitGatewayVpcAttachmentRequest request)
Deletes the specified VPC attachment.
deleteTransitGatewayVpcAttachment in interface AmazonEC2deleteTransitGatewayVpcAttachmentRequest - public DeleteVolumeResult deleteVolume(DeleteVolumeRequest request)
Deletes the specified EBS volume. The volume must be in the available state (not attached to an
instance).
The volume can remain in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
deleteVolume in interface AmazonEC2deleteVolumeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteVolumeRequest request = new DeleteVolumeRequest().withVolumeId("vol-049df61146c4d7901");
DeleteVolumeResult response = client.deleteVolume(request);public DeleteVpcResult deleteVpc(DeleteVpcRequest request)
Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.
deleteVpc in interface AmazonEC2deleteVpcRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DeleteVpcRequest request = new DeleteVpcRequest().withVpcId("vpc-a01106c2");
DeleteVpcResult response = client.deleteVpc(request);public DeleteVpcEndpointConnectionNotificationsResult deleteVpcEndpointConnectionNotifications(DeleteVpcEndpointConnectionNotificationsRequest request)
Deletes one or more VPC endpoint connection notifications.
deleteVpcEndpointConnectionNotifications in interface AmazonEC2deleteVpcEndpointConnectionNotificationsRequest - public DeleteVpcEndpointServiceConfigurationsResult deleteVpcEndpointServiceConfigurations(DeleteVpcEndpointServiceConfigurationsRequest request)
Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service
configuration, you must reject any Available or PendingAcceptance interface endpoint
connections that are attached to the service.
deleteVpcEndpointServiceConfigurations in interface AmazonEC2deleteVpcEndpointServiceConfigurationsRequest - public DeleteVpcEndpointsResult deleteVpcEndpoints(DeleteVpcEndpointsRequest request)
Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces.
deleteVpcEndpoints in interface AmazonEC2deleteVpcEndpointsRequest - Contains the parameters for DeleteVpcEndpoints.public DeleteVpcPeeringConnectionResult deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest request)
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can
delete the VPC peering connection if it's in the active state. The owner of the requester VPC can
delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering
connection that's in the failed state.
deleteVpcPeeringConnection in interface AmazonEC2deleteVpcPeeringConnectionRequest - public DeleteVpnConnectionResult deleteVpnConnection(DeleteVpnConnectionRequest request)
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. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID.
For certificate-based authentication, delete all AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection.
deleteVpnConnection in interface AmazonEC2deleteVpnConnectionRequest - Contains the parameters for DeleteVpnConnection.public DeleteVpnConnectionRouteResult deleteVpnConnectionRoute(DeleteVpnConnectionRouteRequest request)
Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
deleteVpnConnectionRoute in interface AmazonEC2deleteVpnConnectionRouteRequest - Contains the parameters for DeleteVpnConnectionRoute.public DeleteVpnGatewayResult deleteVpnGateway(DeleteVpnGatewayRequest request)
Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.
deleteVpnGateway in interface AmazonEC2deleteVpnGatewayRequest - Contains the parameters for DeleteVpnGateway.public DeprovisionByoipCidrResult deprovisionByoipCidr(DeprovisionByoipCidrRequest request)
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.
deprovisionByoipCidr in interface AmazonEC2deprovisionByoipCidrRequest - public DeregisterImageResult deregisterImage(DeregisterImageRequest request)
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
deregisterImage in interface AmazonEC2deregisterImageRequest - Contains the parameters for DeregisterImage.public DeregisterInstanceEventNotificationAttributesResult deregisterInstanceEventNotificationAttributes(DeregisterInstanceEventNotificationAttributesRequest request)
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
deregisterInstanceEventNotificationAttributes in interface AmazonEC2deregisterInstanceEventNotificationAttributesRequest - public DeregisterTransitGatewayMulticastGroupMembersResult deregisterTransitGatewayMulticastGroupMembers(DeregisterTransitGatewayMulticastGroupMembersRequest request)
Deregisters the specified members (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupMembers in interface AmazonEC2deregisterTransitGatewayMulticastGroupMembersRequest - public DeregisterTransitGatewayMulticastGroupSourcesResult deregisterTransitGatewayMulticastGroupSources(DeregisterTransitGatewayMulticastGroupSourcesRequest request)
Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
deregisterTransitGatewayMulticastGroupSources in interface AmazonEC2deregisterTransitGatewayMulticastGroupSourcesRequest - public DescribeAccountAttributesResult describeAccountAttributes(DescribeAccountAttributesRequest request)
Describes attributes of your AWS account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and
EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your
actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to
a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with
EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with
EC2-VPC.
describeAccountAttributes in interface AmazonEC2describeAccountAttributesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest().withAttributeNames("supported-platforms");
DescribeAccountAttributesResult response = client.describeAccountAttributes(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeAccountAttributesRequest request = new DescribeAccountAttributesRequest();
DescribeAccountAttributesResult response = client.describeAccountAttributes(request);public DescribeAccountAttributesResult describeAccountAttributes()
AmazonEC2describeAccountAttributes in interface AmazonEC2AmazonEC2.describeAccountAttributes(DescribeAccountAttributesRequest)public DescribeAddressesResult describeAddresses(DescribeAddressesRequest request)
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. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
describeAddresses in interface AmazonEC2describeAddressesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeAddressesRequest request = new DescribeAddressesRequest();
DescribeAddressesResult response = client.describeAddresses(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeAddressesRequest request = new DescribeAddressesRequest().withFilters(new Filter().withName("domain").withValues("vpc"));
DescribeAddressesResult response = client.describeAddresses(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeAddressesRequest request = new DescribeAddressesRequest().withFilters(new Filter().withName("domain").withValues("standard"));
DescribeAddressesResult response = client.describeAddresses(request);public DescribeAddressesResult describeAddresses()
AmazonEC2describeAddresses in interface AmazonEC2AmazonEC2.describeAddresses(DescribeAddressesRequest)public DescribeAggregateIdFormatResult describeAggregateIdFormat(DescribeAggregateIdFormatRequest request)
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
describeAggregateIdFormat in interface AmazonEC2describeAggregateIdFormatRequest - public DescribeAvailabilityZonesResult describeAvailabilityZones(DescribeAvailabilityZonesRequest request)
Describes the Availability Zones and Local Zones that are available to you. If there is an event impacting an Availability Zone or Local Zone, you can use this request to view the state and any provided messages for that Availability Zone or Local Zone.
For more information about Availability Zones and Local Zones, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
describeAvailabilityZones in interface AmazonEC2describeAvailabilityZonesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); DescribeAvailabilityZonesRequest request = new DescribeAvailabilityZonesRequest(); DescribeAvailabilityZonesResult response = client.describeAvailabilityZones(request);
public DescribeAvailabilityZonesResult describeAvailabilityZones()
AmazonEC2describeAvailabilityZones in interface AmazonEC2AmazonEC2.describeAvailabilityZones(DescribeAvailabilityZonesRequest)public DescribeBundleTasksResult describeBundleTasks(DescribeBundleTasksRequest request)
Describes the specified bundle tasks or all of your bundle tasks.
Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can
still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image
manifest name you provided to the bundle task.
describeBundleTasks in interface AmazonEC2describeBundleTasksRequest - public DescribeBundleTasksResult describeBundleTasks()
AmazonEC2describeBundleTasks in interface AmazonEC2AmazonEC2.describeBundleTasks(DescribeBundleTasksRequest)public DescribeByoipCidrsResult describeByoipCidrs(DescribeByoipCidrsRequest request)
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.
describeByoipCidrs in interface AmazonEC2describeByoipCidrsRequest - public DescribeCapacityReservationsResult describeCapacityReservations(DescribeCapacityReservationsRequest request)
Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.
describeCapacityReservations in interface AmazonEC2describeCapacityReservationsRequest - public DescribeClassicLinkInstancesResult describeClassicLinkInstances(DescribeClassicLinkInstancesRequest request)
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
describeClassicLinkInstances in interface AmazonEC2describeClassicLinkInstancesRequest - public DescribeClassicLinkInstancesResult describeClassicLinkInstances()
AmazonEC2describeClassicLinkInstances in interface AmazonEC2AmazonEC2.describeClassicLinkInstances(DescribeClassicLinkInstancesRequest)public DescribeClientVpnAuthorizationRulesResult describeClientVpnAuthorizationRules(DescribeClientVpnAuthorizationRulesRequest request)
Describes the authorization rules for a specified Client VPN endpoint.
describeClientVpnAuthorizationRules in interface AmazonEC2describeClientVpnAuthorizationRulesRequest - public DescribeClientVpnConnectionsResult describeClientVpnConnections(DescribeClientVpnConnectionsRequest request)
Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
describeClientVpnConnections in interface AmazonEC2describeClientVpnConnectionsRequest - public DescribeClientVpnEndpointsResult describeClientVpnEndpoints(DescribeClientVpnEndpointsRequest request)
Describes one or more Client VPN endpoints in the account.
describeClientVpnEndpoints in interface AmazonEC2describeClientVpnEndpointsRequest - public DescribeClientVpnRoutesResult describeClientVpnRoutes(DescribeClientVpnRoutesRequest request)
Describes the routes for the specified Client VPN endpoint.
describeClientVpnRoutes in interface AmazonEC2describeClientVpnRoutesRequest - public DescribeClientVpnTargetNetworksResult describeClientVpnTargetNetworks(DescribeClientVpnTargetNetworksRequest request)
Describes the target networks associated with the specified Client VPN endpoint.
describeClientVpnTargetNetworks in interface AmazonEC2describeClientVpnTargetNetworksRequest - public DescribeCoipPoolsResult describeCoipPools(DescribeCoipPoolsRequest request)
Describes the specified customer-owned address pools or all of your customer-owned address pools.
describeCoipPools in interface AmazonEC2describeCoipPoolsRequest - public DescribeConversionTasksResult describeConversionTasks(DescribeConversionTasksRequest request)
Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
describeConversionTasks in interface AmazonEC2describeConversionTasksRequest - public DescribeConversionTasksResult describeConversionTasks()
AmazonEC2describeConversionTasks in interface AmazonEC2AmazonEC2.describeConversionTasks(DescribeConversionTasksRequest)public DescribeCustomerGatewaysResult describeCustomerGateways(DescribeCustomerGatewaysRequest request)
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.
describeCustomerGateways in interface AmazonEC2describeCustomerGatewaysRequest - Contains the parameters for DescribeCustomerGateways.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeCustomerGatewaysRequest request = new DescribeCustomerGatewaysRequest().withCustomerGatewayIds("cgw-0e11f167");
DescribeCustomerGatewaysResult response = client.describeCustomerGateways(request);public DescribeCustomerGatewaysResult describeCustomerGateways()
AmazonEC2describeCustomerGateways in interface AmazonEC2AmazonEC2.describeCustomerGateways(DescribeCustomerGatewaysRequest)public DescribeDhcpOptionsResult describeDhcpOptions(DescribeDhcpOptionsRequest request)
Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
describeDhcpOptions in interface AmazonEC2describeDhcpOptionsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeDhcpOptionsRequest request = new DescribeDhcpOptionsRequest().withDhcpOptionsIds("dopt-d9070ebb");
DescribeDhcpOptionsResult response = client.describeDhcpOptions(request);public DescribeDhcpOptionsResult describeDhcpOptions()
AmazonEC2describeDhcpOptions in interface AmazonEC2AmazonEC2.describeDhcpOptions(DescribeDhcpOptionsRequest)public DescribeEgressOnlyInternetGatewaysResult describeEgressOnlyInternetGateways(DescribeEgressOnlyInternetGatewaysRequest request)
Describes one or more of your egress-only internet gateways.
describeEgressOnlyInternetGateways in interface AmazonEC2describeEgressOnlyInternetGatewaysRequest - public DescribeElasticGpusResult describeElasticGpus(DescribeElasticGpusRequest request)
Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
describeElasticGpus in interface AmazonEC2describeElasticGpusRequest - public DescribeExportImageTasksResult describeExportImageTasks(DescribeExportImageTasksRequest request)
Describes the specified export image tasks or all of your export image tasks.
describeExportImageTasks in interface AmazonEC2describeExportImageTasksRequest - public DescribeExportTasksResult describeExportTasks(DescribeExportTasksRequest request)
Describes the specified export instance tasks or all of your export instance tasks.
describeExportTasks in interface AmazonEC2describeExportTasksRequest - public DescribeExportTasksResult describeExportTasks()
AmazonEC2describeExportTasks in interface AmazonEC2AmazonEC2.describeExportTasks(DescribeExportTasksRequest)public DescribeFastSnapshotRestoresResult describeFastSnapshotRestores(DescribeFastSnapshotRestoresRequest request)
Describes the state of fast snapshot restores for your snapshots.
describeFastSnapshotRestores in interface AmazonEC2describeFastSnapshotRestoresRequest - public DescribeFleetHistoryResult describeFleetHistory(DescribeFleetHistoryRequest request)
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. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
describeFleetHistory in interface AmazonEC2describeFleetHistoryRequest - public DescribeFleetInstancesResult describeFleetInstances(DescribeFleetInstancesRequest request)
Describes the running instances for the specified EC2 Fleet.
describeFleetInstances in interface AmazonEC2describeFleetInstancesRequest - public DescribeFleetsResult describeFleets(DescribeFleetsRequest request)
Describes the specified EC2 Fleets or all of your EC2 Fleets.
describeFleets in interface AmazonEC2describeFleetsRequest - public DescribeFlowLogsResult describeFlowLogs(DescribeFlowLogsRequest request)
Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
describeFlowLogs in interface AmazonEC2describeFlowLogsRequest - public DescribeFlowLogsResult describeFlowLogs()
AmazonEC2describeFlowLogs in interface AmazonEC2AmazonEC2.describeFlowLogs(DescribeFlowLogsRequest)public DescribeFpgaImageAttributeResult describeFpgaImageAttribute(DescribeFpgaImageAttributeRequest request)
Describes the specified attribute of the specified Amazon FPGA Image (AFI).
describeFpgaImageAttribute in interface AmazonEC2describeFpgaImageAttributeRequest - public DescribeFpgaImagesResult describeFpgaImages(DescribeFpgaImagesRequest request)
Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.
describeFpgaImages in interface AmazonEC2describeFpgaImagesRequest - public DescribeHostReservationOfferingsResult describeHostReservationOfferings(DescribeHostReservationOfferingsRequest request)
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. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.
describeHostReservationOfferings in interface AmazonEC2describeHostReservationOfferingsRequest - public DescribeHostReservationsResult describeHostReservations(DescribeHostReservationsRequest request)
Describes reservations that are associated with Dedicated Hosts in your account.
describeHostReservations in interface AmazonEC2describeHostReservationsRequest - public DescribeHostsResult describeHosts(DescribeHostsRequest request)
Describes the specified Dedicated Hosts or all your Dedicated Hosts.
The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume
capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state
released.
describeHosts in interface AmazonEC2describeHostsRequest - public DescribeHostsResult describeHosts()
AmazonEC2describeHosts in interface AmazonEC2AmazonEC2.describeHosts(DescribeHostsRequest)public DescribeIamInstanceProfileAssociationsResult describeIamInstanceProfileAssociations(DescribeIamInstanceProfileAssociationsRequest request)
Describes your IAM instance profile associations.
describeIamInstanceProfileAssociations in interface AmazonEC2describeIamInstanceProfileAssociationsRequest - public DescribeIdFormatResult describeIdFormat(DescribeIdFormatRequest request)
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. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By
default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings
by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users,
regardless of these settings and provided that they have permission to use the relevant Describe
command for the resource type.
describeIdFormat in interface AmazonEC2describeIdFormatRequest - public DescribeIdFormatResult describeIdFormat()
AmazonEC2describeIdFormat in interface AmazonEC2AmazonEC2.describeIdFormat(DescribeIdFormatRequest)public DescribeIdentityIdFormatResult describeIdentityIdFormat(DescribeIdentityIdFormatRequest request)
Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.
describeIdentityIdFormat in interface AmazonEC2describeIdentityIdFormatRequest - public DescribeImageAttributeResult describeImageAttribute(DescribeImageAttributeRequest request)
Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
describeImageAttribute in interface AmazonEC2describeImageAttributeRequest - Contains the parameters for DescribeImageAttribute.public DescribeImagesResult describeImages(DescribeImagesRequest request)
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. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results in an error indicating that the AMI ID cannot be found.
describeImages in interface AmazonEC2describeImagesRequest - public DescribeImagesResult describeImages()
AmazonEC2describeImages in interface AmazonEC2AmazonEC2.describeImages(DescribeImagesRequest)public DescribeImportImageTasksResult describeImportImageTasks(DescribeImportImageTasksRequest request)
Displays details about an import virtual machine or import snapshot tasks that are already created.
describeImportImageTasks in interface AmazonEC2describeImportImageTasksRequest - public DescribeImportImageTasksResult describeImportImageTasks()
AmazonEC2describeImportImageTasks in interface AmazonEC2AmazonEC2.describeImportImageTasks(DescribeImportImageTasksRequest)public DescribeImportSnapshotTasksResult describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest request)
Describes your import snapshot tasks.
describeImportSnapshotTasks in interface AmazonEC2describeImportSnapshotTasksRequest - public DescribeImportSnapshotTasksResult describeImportSnapshotTasks()
AmazonEC2describeImportSnapshotTasks in interface AmazonEC2AmazonEC2.describeImportSnapshotTasks(DescribeImportSnapshotTasksRequest)public DescribeInstanceAttributeResult describeInstanceAttribute(DescribeInstanceAttributeRequest request)
Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid
attribute values are: instanceType | kernel | ramdisk |
userData | disableApiTermination | instanceInitiatedShutdownBehavior |
rootDeviceName | blockDeviceMapping | productCodes |
sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport
describeInstanceAttribute in interface AmazonEC2describeInstanceAttributeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeInstanceAttributeRequest request = new DescribeInstanceAttributeRequest().withAttribute("instanceType").withInstanceId("i-1234567890abcdef0");
DescribeInstanceAttributeResult response = client.describeInstanceAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeInstanceAttributeRequest request = new DescribeInstanceAttributeRequest().withAttribute("disableApiTermination").withInstanceId(
"i-1234567890abcdef0");
DescribeInstanceAttributeResult response = client.describeInstanceAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeInstanceAttributeRequest request = new DescribeInstanceAttributeRequest().withAttribute("blockDeviceMapping").withInstanceId(
"i-1234567890abcdef0");
DescribeInstanceAttributeResult response = client.describeInstanceAttribute(request);public DescribeInstanceCreditSpecificationsResult describeInstanceCreditSpecifications(DescribeInstanceCreditSpecificationsRequest request)
Describes the credit option for CPU usage of the specified burstable performance instances. The credit options
are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the
unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a
with the unlimited credit option. For example, if you resize a T2 instance, while it is configured
as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or
unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance
that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
describeInstanceCreditSpecifications in interface AmazonEC2describeInstanceCreditSpecificationsRequest - public DescribeInstanceEventNotificationAttributesResult describeInstanceEventNotificationAttributes(DescribeInstanceEventNotificationAttributesRequest request)
Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
describeInstanceEventNotificationAttributes in interface AmazonEC2describeInstanceEventNotificationAttributesRequest - public DescribeInstanceStatusResult describeInstanceStatus(DescribeInstanceStatusRequest request)
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshooting instances with failed status checks in the Amazon Elastic Compute Cloud User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon Elastic Compute Cloud User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.
describeInstanceStatus in interface AmazonEC2describeInstanceStatusRequest - public DescribeInstanceStatusResult describeInstanceStatus()
AmazonEC2describeInstanceStatus in interface AmazonEC2AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest)public DescribeInstanceTypeOfferingsResult describeInstanceTypeOfferings(DescribeInstanceTypeOfferingsRequest request)
Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
describeInstanceTypeOfferings in interface AmazonEC2describeInstanceTypeOfferingsRequest - public DescribeInstanceTypesResult describeInstanceTypes(DescribeInstanceTypesRequest request)
Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
describeInstanceTypes in interface AmazonEC2describeInstanceTypesRequest - public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
describeInstances in interface AmazonEC2describeInstancesRequest - public DescribeInstancesResult describeInstances()
AmazonEC2describeInstances in interface AmazonEC2AmazonEC2.describeInstances(DescribeInstancesRequest)public DescribeInternetGatewaysResult describeInternetGateways(DescribeInternetGatewaysRequest request)
Describes one or more of your internet gateways.
describeInternetGateways in interface AmazonEC2describeInternetGatewaysRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeInternetGatewaysRequest request = new DescribeInternetGatewaysRequest().withFilters(new Filter().withName("attachment.vpc-id").withValues(
"vpc-a01106c2"));
DescribeInternetGatewaysResult response = client.describeInternetGateways(request);public DescribeInternetGatewaysResult describeInternetGateways()
AmazonEC2describeInternetGateways in interface AmazonEC2AmazonEC2.describeInternetGateways(DescribeInternetGatewaysRequest)public DescribeIpv6PoolsResult describeIpv6Pools(DescribeIpv6PoolsRequest request)
Describes your IPv6 address pools.
describeIpv6Pools in interface AmazonEC2describeIpv6PoolsRequest - public DescribeKeyPairsResult describeKeyPairs(DescribeKeyPairsRequest request)
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.
describeKeyPairs in interface AmazonEC2describeKeyPairsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeKeyPairsRequest request = new DescribeKeyPairsRequest().withKeyNames("my-key-pair");
DescribeKeyPairsResult response = client.describeKeyPairs(request);public DescribeKeyPairsResult describeKeyPairs()
AmazonEC2describeKeyPairs in interface AmazonEC2AmazonEC2.describeKeyPairs(DescribeKeyPairsRequest)public DescribeLaunchTemplateVersionsResult describeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest request)
Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account.
describeLaunchTemplateVersions in interface AmazonEC2describeLaunchTemplateVersionsRequest - public DescribeLaunchTemplatesResult describeLaunchTemplates(DescribeLaunchTemplatesRequest request)
Describes one or more launch templates.
describeLaunchTemplates in interface AmazonEC2describeLaunchTemplatesRequest - public DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations(DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest request)
Describes the associations between virtual interface groups and local gateway route tables.
describeLocalGatewayRouteTableVirtualInterfaceGroupAssociations in interface AmazonEC2describeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest - public DescribeLocalGatewayRouteTableVpcAssociationsResult describeLocalGatewayRouteTableVpcAssociations(DescribeLocalGatewayRouteTableVpcAssociationsRequest request)
Describes the specified associations between VPCs and local gateway route tables.
describeLocalGatewayRouteTableVpcAssociations in interface AmazonEC2describeLocalGatewayRouteTableVpcAssociationsRequest - public DescribeLocalGatewayRouteTablesResult describeLocalGatewayRouteTables(DescribeLocalGatewayRouteTablesRequest request)
Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
describeLocalGatewayRouteTables in interface AmazonEC2describeLocalGatewayRouteTablesRequest - public DescribeLocalGatewayVirtualInterfaceGroupsResult describeLocalGatewayVirtualInterfaceGroups(DescribeLocalGatewayVirtualInterfaceGroupsRequest request)
Describes the specified local gateway virtual interface groups.
describeLocalGatewayVirtualInterfaceGroups in interface AmazonEC2describeLocalGatewayVirtualInterfaceGroupsRequest - public DescribeLocalGatewayVirtualInterfacesResult describeLocalGatewayVirtualInterfaces(DescribeLocalGatewayVirtualInterfacesRequest request)
Describes the specified local gateway virtual interfaces.
describeLocalGatewayVirtualInterfaces in interface AmazonEC2describeLocalGatewayVirtualInterfacesRequest - public DescribeLocalGatewaysResult describeLocalGateways(DescribeLocalGatewaysRequest request)
Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
describeLocalGateways in interface AmazonEC2describeLocalGatewaysRequest - public DescribeManagedPrefixListsResult describeManagedPrefixLists(DescribeManagedPrefixListsRequest request)
Describes your managed prefix lists and any AWS-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
describeManagedPrefixLists in interface AmazonEC2describeManagedPrefixListsRequest - public DescribeMovingAddressesResult describeMovingAddresses(DescribeMovingAddressesRequest request)
Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
describeMovingAddresses in interface AmazonEC2describeMovingAddressesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); DescribeMovingAddressesRequest request = new DescribeMovingAddressesRequest(); DescribeMovingAddressesResult response = client.describeMovingAddresses(request);
public DescribeMovingAddressesResult describeMovingAddresses()
AmazonEC2describeMovingAddresses in interface AmazonEC2AmazonEC2.describeMovingAddresses(DescribeMovingAddressesRequest)public DescribeNatGatewaysResult describeNatGateways(DescribeNatGatewaysRequest request)
Describes one or more of your NAT gateways.
describeNatGateways in interface AmazonEC2describeNatGatewaysRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNatGatewaysRequest request = new DescribeNatGatewaysRequest().withFilter(new Filter().withName("vpc-id").withValues("vpc-1a2b3c4d"));
DescribeNatGatewaysResult response = client.describeNatGateways(request);public DescribeNetworkAclsResult describeNetworkAcls(DescribeNetworkAclsRequest request)
Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
describeNetworkAcls in interface AmazonEC2describeNetworkAclsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkAclsRequest request = new DescribeNetworkAclsRequest().withNetworkAclIds("acl-5fb85d36");
DescribeNetworkAclsResult response = client.describeNetworkAcls(request);public DescribeNetworkAclsResult describeNetworkAcls()
AmazonEC2describeNetworkAcls in interface AmazonEC2AmazonEC2.describeNetworkAcls(DescribeNetworkAclsRequest)public DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(DescribeNetworkInterfaceAttributeRequest request)
Describes a network interface attribute. You can specify only one attribute at a time.
describeNetworkInterfaceAttribute in interface AmazonEC2describeNetworkInterfaceAttributeRequest - Contains the parameters for DescribeNetworkInterfaceAttribute.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkInterfaceAttributeRequest request = new DescribeNetworkInterfaceAttributeRequest().withAttribute("attachment").withNetworkInterfaceId(
"eni-686ea200");
DescribeNetworkInterfaceAttributeResult response = client.describeNetworkInterfaceAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkInterfaceAttributeRequest request = new DescribeNetworkInterfaceAttributeRequest().withAttribute("description").withNetworkInterfaceId(
"eni-686ea200");
DescribeNetworkInterfaceAttributeResult response = client.describeNetworkInterfaceAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkInterfaceAttributeRequest request = new DescribeNetworkInterfaceAttributeRequest().withAttribute("groupSet").withNetworkInterfaceId(
"eni-686ea200");
DescribeNetworkInterfaceAttributeResult response = client.describeNetworkInterfaceAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkInterfaceAttributeRequest request = new DescribeNetworkInterfaceAttributeRequest().withAttribute("sourceDestCheck")
.withNetworkInterfaceId("eni-686ea200");
DescribeNetworkInterfaceAttributeResult response = client.describeNetworkInterfaceAttribute(request);public DescribeNetworkInterfacePermissionsResult describeNetworkInterfacePermissions(DescribeNetworkInterfacePermissionsRequest request)
Describes the permissions for your network interfaces.
describeNetworkInterfacePermissions in interface AmazonEC2describeNetworkInterfacePermissionsRequest - Contains the parameters for DescribeNetworkInterfacePermissions.public DescribeNetworkInterfacesResult describeNetworkInterfaces(DescribeNetworkInterfacesRequest request)
Describes one or more of your network interfaces.
describeNetworkInterfaces in interface AmazonEC2describeNetworkInterfacesRequest - Contains the parameters for DescribeNetworkInterfaces.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeNetworkInterfacesRequest request = new DescribeNetworkInterfacesRequest().withNetworkInterfaceIds("eni-e5aa89a3");
DescribeNetworkInterfacesResult response = client.describeNetworkInterfaces(request);public DescribeNetworkInterfacesResult describeNetworkInterfaces()
AmazonEC2describeNetworkInterfaces in interface AmazonEC2AmazonEC2.describeNetworkInterfaces(DescribeNetworkInterfacesRequest)public DescribePlacementGroupsResult describePlacementGroups(DescribePlacementGroupsRequest request)
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
describePlacementGroups in interface AmazonEC2describePlacementGroupsRequest - public DescribePlacementGroupsResult describePlacementGroups()
AmazonEC2describePlacementGroups in interface AmazonEC2AmazonEC2.describePlacementGroups(DescribePlacementGroupsRequest)public DescribePrefixListsResult describePrefixLists(DescribePrefixListsRequest request)
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.
describePrefixLists in interface AmazonEC2describePrefixListsRequest - public DescribePrefixListsResult describePrefixLists()
AmazonEC2describePrefixLists in interface AmazonEC2AmazonEC2.describePrefixLists(DescribePrefixListsRequest)public DescribePrincipalIdFormatResult describePrincipalIdFormat(DescribePrincipalIdFormatRequest request)
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.
By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.
The following resource types support longer IDs: bundle | conversion-task |
customer-gateway | dhcp-options | elastic-ip-allocation |
elastic-ip-association | export-task | flow-log | image |
import-task | instance | internet-gateway | network-acl |
network-acl-association | network-interface | network-interface-attachment
| prefix-list | reservation | route-table |
route-table-association | security-group | snapshot | subnet
| subnet-cidr-block-association | volume | vpc |
vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
vpn-connection | vpn-gateway.
describePrincipalIdFormat in interface AmazonEC2describePrincipalIdFormatRequest - public DescribePublicIpv4PoolsResult describePublicIpv4Pools(DescribePublicIpv4PoolsRequest request)
Describes the specified IPv4 address pools.
describePublicIpv4Pools in interface AmazonEC2describePublicIpv4PoolsRequest - public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
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.
describeRegions in interface AmazonEC2describeRegionsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); DescribeRegionsRequest request = new DescribeRegionsRequest(); DescribeRegionsResult response = client.describeRegions(request);
public DescribeRegionsResult describeRegions()
AmazonEC2describeRegions in interface AmazonEC2AmazonEC2.describeRegions(DescribeRegionsRequest)public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)
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.
describeReservedInstances in interface AmazonEC2describeReservedInstancesRequest - Contains the parameters for DescribeReservedInstances.public DescribeReservedInstancesResult describeReservedInstances()
AmazonEC2describeReservedInstances in interface AmazonEC2AmazonEC2.describeReservedInstances(DescribeReservedInstancesRequest)public DescribeReservedInstancesListingsResult describeReservedInstancesListings(DescribeReservedInstancesListingsRequest request)
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. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
describeReservedInstancesListings in interface AmazonEC2describeReservedInstancesListingsRequest - Contains the parameters for DescribeReservedInstancesListings.public DescribeReservedInstancesListingsResult describeReservedInstancesListings()
AmazonEC2describeReservedInstancesListings in interface AmazonEC2AmazonEC2.describeReservedInstancesListings(DescribeReservedInstancesListingsRequest)public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest request)
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
describeReservedInstancesModifications in interface AmazonEC2describeReservedInstancesModificationsRequest - Contains the parameters for DescribeReservedInstancesModifications.public DescribeReservedInstancesModificationsResult describeReservedInstancesModifications()
AmazonEC2describeReservedInstancesModifications in interface AmazonEC2AmazonEC2.describeReservedInstancesModifications(DescribeReservedInstancesModificationsRequest)public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest request)
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
describeReservedInstancesOfferings in interface AmazonEC2describeReservedInstancesOfferingsRequest - Contains the parameters for DescribeReservedInstancesOfferings.public DescribeReservedInstancesOfferingsResult describeReservedInstancesOfferings()
AmazonEC2describeReservedInstancesOfferings in interface AmazonEC2AmazonEC2.describeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest)public DescribeRouteTablesResult describeRouteTables(DescribeRouteTablesRequest request)
Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
describeRouteTables in interface AmazonEC2describeRouteTablesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeRouteTablesRequest request = new DescribeRouteTablesRequest().withRouteTableIds("rtb-1f382e7d");
DescribeRouteTablesResult response = client.describeRouteTables(request);public DescribeRouteTablesResult describeRouteTables()
AmazonEC2describeRouteTables in interface AmazonEC2AmazonEC2.describeRouteTables(DescribeRouteTablesRequest)public DescribeScheduledInstanceAvailabilityResult describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest request)
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
describeScheduledInstanceAvailability in interface AmazonEC2describeScheduledInstanceAvailabilityRequest - Contains the parameters for DescribeScheduledInstanceAvailability.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeScheduledInstanceAvailabilityRequest request = new DescribeScheduledInstanceAvailabilityRequest().withFirstSlotStartTimeRange(
new SlotDateTimeRangeRequest().withEarliestTime(new Date("2016-01-31T00:00:00Z")).withLatestTime(new Date("2016-01-31T04:00:00Z")))
.withRecurrence(new ScheduledInstanceRecurrenceRequest().withFrequency("Weekly").withInterval(1).withOccurrenceDays(1));
DescribeScheduledInstanceAvailabilityResult response = client.describeScheduledInstanceAvailability(request);public DescribeScheduledInstancesResult describeScheduledInstances(DescribeScheduledInstancesRequest request)
Describes the specified Scheduled Instances or all your Scheduled Instances.
describeScheduledInstances in interface AmazonEC2describeScheduledInstancesRequest - Contains the parameters for DescribeScheduledInstances.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeScheduledInstancesRequest request = new DescribeScheduledInstancesRequest().withScheduledInstanceIds("sci-1234-1234-1234-1234-123456789012");
DescribeScheduledInstancesResult response = client.describeScheduledInstances(request);public DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest request)
[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.
describeSecurityGroupReferences in interface AmazonEC2describeSecurityGroupReferencesRequest - public DescribeSecurityGroupsResult describeSecurityGroups(DescribeSecurityGroupsRequest request)
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. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
describeSecurityGroups in interface AmazonEC2describeSecurityGroupsRequest - public DescribeSecurityGroupsResult describeSecurityGroups()
AmazonEC2describeSecurityGroups in interface AmazonEC2AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest)public DescribeSnapshotAttributeResult describeSnapshotAttribute(DescribeSnapshotAttributeRequest request)
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
describeSnapshotAttribute in interface AmazonEC2describeSnapshotAttributeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSnapshotAttributeRequest request = new DescribeSnapshotAttributeRequest().withAttribute("createVolumePermission").withSnapshotId(
"snap-066877671789bd71b");
DescribeSnapshotAttributeResult response = client.describeSnapshotAttribute(request);public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
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. All AWS accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
implicit: An AWS account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the
specified owners and for which you have access are returned. The results can include the AWS account IDs of the
specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you
own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are
returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which
you own or have explicit permissions, or all for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more
manageable. The MaxResults parameter sets the maximum number of results returned in a single page.
If the list of results exceeds your MaxResults value, then that number of results is returned along
with a NextToken value that can be passed to a subsequent DescribeSnapshots request to
retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
describeSnapshots in interface AmazonEC2describeSnapshotsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSnapshotsRequest request = new DescribeSnapshotsRequest().withSnapshotIds("snap-1234567890abcdef0");
DescribeSnapshotsResult response = client.describeSnapshots(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSnapshotsRequest request = new DescribeSnapshotsRequest().withFilters(new Filter().withName("status").withValues("pending")).withOwnerIds(
"012345678910");
DescribeSnapshotsResult response = client.describeSnapshots(request);public DescribeSnapshotsResult describeSnapshots()
AmazonEC2describeSnapshots in interface AmazonEC2AmazonEC2.describeSnapshots(DescribeSnapshotsRequest)public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest request)
Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
describeSpotDatafeedSubscription in interface AmazonEC2describeSpotDatafeedSubscriptionRequest - Contains the parameters for DescribeSpotDatafeedSubscription.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build(); DescribeSpotDatafeedSubscriptionRequest request = new DescribeSpotDatafeedSubscriptionRequest(); DescribeSpotDatafeedSubscriptionResult response = client.describeSpotDatafeedSubscription(request);
public DescribeSpotDatafeedSubscriptionResult describeSpotDatafeedSubscription()
AmazonEC2describeSpotDatafeedSubscription in interface AmazonEC2AmazonEC2.describeSpotDatafeedSubscription(DescribeSpotDatafeedSubscriptionRequest)public DescribeSpotFleetInstancesResult describeSpotFleetInstances(DescribeSpotFleetInstancesRequest request)
Describes the running instances for the specified Spot Fleet.
describeSpotFleetInstances in interface AmazonEC2describeSpotFleetInstancesRequest - Contains the parameters for DescribeSpotFleetInstances.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSpotFleetInstancesRequest request = new DescribeSpotFleetInstancesRequest().withSpotFleetRequestId("sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE");
DescribeSpotFleetInstancesResult response = client.describeSpotFleetInstances(request);public DescribeSpotFleetRequestHistoryResult describeSpotFleetRequestHistory(DescribeSpotFleetRequestHistoryRequest request)
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. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
describeSpotFleetRequestHistory in interface AmazonEC2describeSpotFleetRequestHistoryRequest - Contains the parameters for DescribeSpotFleetRequestHistory.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSpotFleetRequestHistoryRequest request = new DescribeSpotFleetRequestHistoryRequest().withSpotFleetRequestId(
"sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE").withStartTime(new Date("2015-05-26T00:00:00Z"));
DescribeSpotFleetRequestHistoryResult response = client.describeSpotFleetRequestHistory(request);public DescribeSpotFleetRequestsResult describeSpotFleetRequests(DescribeSpotFleetRequestsRequest request)
Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
describeSpotFleetRequests in interface AmazonEC2describeSpotFleetRequestsRequest - Contains the parameters for DescribeSpotFleetRequests.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSpotFleetRequestsRequest request = new DescribeSpotFleetRequestsRequest().withSpotFleetRequestIds("sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE");
DescribeSpotFleetRequestsResult response = client.describeSpotFleetRequests(request);public DescribeSpotFleetRequestsResult describeSpotFleetRequests()
AmazonEC2describeSpotFleetRequests in interface AmazonEC2AmazonEC2.describeSpotFleetRequests(DescribeSpotFleetRequestsRequest)public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest request)
Describes the specified Spot Instance requests.
You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response.
If the status of the Spot Instance is fulfilled, the instance ID appears in the response and
contains the identifier of the instance. Alternatively, you can use DescribeInstances with a
filter to look for instances where the instance lifecycle is spot.
We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results
returned. This paginates the output, which makes the list more manageable and returns the results faster. If the
list of results exceeds your MaxResults value, then that number of results is returned along with a
NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request
to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
describeSpotInstanceRequests in interface AmazonEC2describeSpotInstanceRequestsRequest - Contains the parameters for DescribeSpotInstanceRequests.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSpotInstanceRequestsRequest request = new DescribeSpotInstanceRequestsRequest().withSpotInstanceRequestIds("sir-08b93456");
DescribeSpotInstanceRequestsResult response = client.describeSpotInstanceRequests(request);public DescribeSpotInstanceRequestsResult describeSpotInstanceRequests()
AmazonEC2describeSpotInstanceRequests in interface AmazonEC2AmazonEC2.describeSpotInstanceRequests(DescribeSpotInstanceRequestsRequest)public DescribeSpotPriceHistoryResult describeSpotPriceHistory(DescribeSpotPriceHistoryRequest request)
Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
describeSpotPriceHistory in interface AmazonEC2describeSpotPriceHistoryRequest - Contains the parameters for DescribeSpotPriceHistory.AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSpotPriceHistoryRequest request = new DescribeSpotPriceHistoryRequest().withEndTime(new Date("2014-01-06T08:09:10"))
.withInstanceTypes("m1.xlarge").withProductDescriptions("Linux/UNIX (Amazon VPC)").withStartTime(new Date("2014-01-06T07:08:09"));
DescribeSpotPriceHistoryResult response = client.describeSpotPriceHistory(request);public DescribeSpotPriceHistoryResult describeSpotPriceHistory()
AmazonEC2describeSpotPriceHistory in interface AmazonEC2AmazonEC2.describeSpotPriceHistory(DescribeSpotPriceHistoryRequest)public DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(DescribeStaleSecurityGroupsRequest request)
[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.
describeStaleSecurityGroups in interface AmazonEC2describeStaleSecurityGroupsRequest - public DescribeSubnetsResult describeSubnets(DescribeSubnetsRequest request)
Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
describeSubnets in interface AmazonEC2describeSubnetsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeSubnetsRequest request = new DescribeSubnetsRequest().withFilters(new Filter().withName("vpc-id").withValues("vpc-a01106c2"));
DescribeSubnetsResult response = client.describeSubnets(request);public DescribeSubnetsResult describeSubnets()
AmazonEC2describeSubnets in interface AmazonEC2AmazonEC2.describeSubnets(DescribeSubnetsRequest)public DescribeTagsResult describeTags(DescribeTagsRequest request)
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.
describeTags in interface AmazonEC2describeTagsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeTagsRequest request = new DescribeTagsRequest().withFilters(new Filter().withName("resource-id").withValues("i-1234567890abcdef8"));
DescribeTagsResult response = client.describeTags(request);public DescribeTagsResult describeTags()
AmazonEC2describeTags in interface AmazonEC2AmazonEC2.describeTags(DescribeTagsRequest)public DescribeTrafficMirrorFiltersResult describeTrafficMirrorFilters(DescribeTrafficMirrorFiltersRequest request)
Describes one or more Traffic Mirror filters.
describeTrafficMirrorFilters in interface AmazonEC2describeTrafficMirrorFiltersRequest - public DescribeTrafficMirrorSessionsResult describeTrafficMirrorSessions(DescribeTrafficMirrorSessionsRequest request)
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
describeTrafficMirrorSessions in interface AmazonEC2describeTrafficMirrorSessionsRequest - public DescribeTrafficMirrorTargetsResult describeTrafficMirrorTargets(DescribeTrafficMirrorTargetsRequest request)
Information about one or more Traffic Mirror targets.
describeTrafficMirrorTargets in interface AmazonEC2describeTrafficMirrorTargetsRequest - public DescribeTransitGatewayAttachmentsResult describeTransitGatewayAttachments(DescribeTransitGatewayAttachmentsRequest request)
Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
describeTransitGatewayAttachments in interface AmazonEC2describeTransitGatewayAttachmentsRequest - public DescribeTransitGatewayMulticastDomainsResult describeTransitGatewayMulticastDomains(DescribeTransitGatewayMulticastDomainsRequest request)
Describes one or more transit gateway multicast domains.
describeTransitGatewayMulticastDomains in interface AmazonEC2describeTransitGatewayMulticastDomainsRequest - public DescribeTransitGatewayPeeringAttachmentsResult describeTransitGatewayPeeringAttachments(DescribeTransitGatewayPeeringAttachmentsRequest request)
Describes your transit gateway peering attachments.
describeTransitGatewayPeeringAttachments in interface AmazonEC2describeTransitGatewayPeeringAttachmentsRequest - public DescribeTransitGatewayRouteTablesResult describeTransitGatewayRouteTables(DescribeTransitGatewayRouteTablesRequest request)
Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.
describeTransitGatewayRouteTables in interface AmazonEC2describeTransitGatewayRouteTablesRequest - public DescribeTransitGatewayVpcAttachmentsResult describeTransitGatewayVpcAttachments(DescribeTransitGatewayVpcAttachmentsRequest request)
Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
describeTransitGatewayVpcAttachments in interface AmazonEC2describeTransitGatewayVpcAttachmentsRequest - public DescribeTransitGatewaysResult describeTransitGateways(DescribeTransitGatewaysRequest request)
Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
describeTransitGateways in interface AmazonEC2describeTransitGatewaysRequest - public DescribeVolumeAttributeResult describeVolumeAttribute(DescribeVolumeAttributeRequest request)
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
describeVolumeAttribute in interface AmazonEC2describeVolumeAttributeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVolumeAttributeRequest request = new DescribeVolumeAttributeRequest().withAttribute("autoEnableIO").withVolumeId("vol-049df61146c4d7901");
DescribeVolumeAttributeResult response = client.describeVolumeAttribute(request);public DescribeVolumeStatusResult describeVolumeStatus(DescribeVolumeStatusRequest request)
Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok,
impaired , warning, or insufficient-data. If all checks pass, the overall
status of the volume is ok. If the check fails, the overall status is impaired. If the
status is insufficient-data, then the checks may still be taking place on your volume at the time.
We recommend that you retry the request. For more information about volume status, see Monitoring the Status of
Your Volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and may require you to take action. For example, if your
volume returns an impaired status, then the volume event might be
potential-data-inconsistency. This means that your volume has been affected by an issue with the
underlying host, has all I/O operations disabled, and may have inconsistent data.
Actions: Reflect the actions you may have to take in response to an event. For example, if the status of
the volume is impaired and the volume event shows potential-data-inconsistency, then
the action shows enable-volume-io. This means that you may want to enable the I/O operations for the
volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume
status does not indicate volumes in the error state (for example, when a volume is incapable of
accepting I/O.)
describeVolumeStatus in interface AmazonEC2describeVolumeStatusRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVolumeStatusRequest request = new DescribeVolumeStatusRequest().withVolumeIds("vol-1234567890abcdef0");
DescribeVolumeStatusResult response = client.describeVolumeStatus(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVolumeStatusRequest request = new DescribeVolumeStatusRequest().withFilters(new Filter().withName("volume-status.status")
.withValues("impaired"));
DescribeVolumeStatusResult response = client.describeVolumeStatus(request);public DescribeVolumeStatusResult describeVolumeStatus()
AmazonEC2describeVolumeStatus in interface AmazonEC2AmazonEC2.describeVolumeStatus(DescribeVolumeStatusRequest)public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
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. The MaxResults parameter sets the maximum number of results returned in a single page.
If the list of results exceeds your MaxResults value, then that number of results is returned along
with a NextToken value that can be passed to a subsequent DescribeVolumes request to
retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
describeVolumes in interface AmazonEC2describeVolumesRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVolumesRequest request = new DescribeVolumesRequest();
DescribeVolumesResult response = client.describeVolumes(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVolumesRequest request = new DescribeVolumesRequest().withFilters(
new Filter().withName("attachment.instance-id").withValues("i-1234567890abcdef0"), new Filter().withName("attachment.delete-on-termination")
.withValues("true"));
DescribeVolumesResult response = client.describeVolumes(request);public DescribeVolumesResult describeVolumes()
AmazonEC2describeVolumes in interface AmazonEC2AmazonEC2.describeVolumes(DescribeVolumesRequest)public DescribeVolumesModificationsResult describeVolumesModifications(DescribeVolumesModificationsRequest request)
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. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications in the Amazon Elastic Compute Cloud User Guide.
describeVolumesModifications in interface AmazonEC2describeVolumesModificationsRequest - public DescribeVpcAttributeResult describeVpcAttribute(DescribeVpcAttributeRequest request)
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
describeVpcAttribute in interface AmazonEC2describeVpcAttributeRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVpcAttributeRequest request = new DescribeVpcAttributeRequest().withAttribute("enableDnsSupport").withVpcId("vpc-a01106c2");
DescribeVpcAttributeResult response = client.describeVpcAttribute(request);AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVpcAttributeRequest request = new DescribeVpcAttributeRequest().withAttribute("enableDnsHostnames").withVpcId("vpc-a01106c2");
DescribeVpcAttributeResult response = client.describeVpcAttribute(request);public DescribeVpcClassicLinkResult describeVpcClassicLink(DescribeVpcClassicLinkRequest request)
Describes the ClassicLink status of one or more VPCs.
describeVpcClassicLink in interface AmazonEC2describeVpcClassicLinkRequest - public DescribeVpcClassicLinkResult describeVpcClassicLink()
AmazonEC2describeVpcClassicLink in interface AmazonEC2AmazonEC2.describeVpcClassicLink(DescribeVpcClassicLinkRequest)public DescribeVpcClassicLinkDnsSupportResult describeVpcClassicLinkDnsSupport(DescribeVpcClassicLinkDnsSupportRequest request)
Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
describeVpcClassicLinkDnsSupport in interface AmazonEC2describeVpcClassicLinkDnsSupportRequest - public DescribeVpcEndpointConnectionNotificationsResult describeVpcEndpointConnectionNotifications(DescribeVpcEndpointConnectionNotificationsRequest request)
Describes the connection notifications for VPC endpoints and VPC endpoint services.
describeVpcEndpointConnectionNotifications in interface AmazonEC2describeVpcEndpointConnectionNotificationsRequest - public DescribeVpcEndpointConnectionsResult describeVpcEndpointConnections(DescribeVpcEndpointConnectionsRequest request)
Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
describeVpcEndpointConnections in interface AmazonEC2describeVpcEndpointConnectionsRequest - public DescribeVpcEndpointServiceConfigurationsResult describeVpcEndpointServiceConfigurations(DescribeVpcEndpointServiceConfigurationsRequest request)
Describes the VPC endpoint service configurations in your account (your services).
describeVpcEndpointServiceConfigurations in interface AmazonEC2describeVpcEndpointServiceConfigurationsRequest - public DescribeVpcEndpointServicePermissionsResult describeVpcEndpointServicePermissions(DescribeVpcEndpointServicePermissionsRequest request)
Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
describeVpcEndpointServicePermissions in interface AmazonEC2describeVpcEndpointServicePermissionsRequest - public DescribeVpcEndpointServicesResult describeVpcEndpointServices(DescribeVpcEndpointServicesRequest request)
Describes available services to which you can create a VPC endpoint.
describeVpcEndpointServices in interface AmazonEC2describeVpcEndpointServicesRequest - Contains the parameters for DescribeVpcEndpointServices.public DescribeVpcEndpointServicesResult describeVpcEndpointServices()
AmazonEC2describeVpcEndpointServices in interface AmazonEC2AmazonEC2.describeVpcEndpointServices(DescribeVpcEndpointServicesRequest)public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
Describes one or more of your VPC endpoints.
describeVpcEndpoints in interface AmazonEC2describeVpcEndpointsRequest - Contains the parameters for DescribeVpcEndpoints.public DescribeVpcEndpointsResult describeVpcEndpoints()
AmazonEC2describeVpcEndpoints in interface AmazonEC2AmazonEC2.describeVpcEndpoints(DescribeVpcEndpointsRequest)public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest request)
Describes one or more of your VPC peering connections.
describeVpcPeeringConnections in interface AmazonEC2describeVpcPeeringConnectionsRequest - public DescribeVpcPeeringConnectionsResult describeVpcPeeringConnections()
AmazonEC2describeVpcPeeringConnections in interface AmazonEC2AmazonEC2.describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest)public DescribeVpcsResult describeVpcs(DescribeVpcsRequest request)
Describes one or more of your VPCs.
describeVpcs in interface AmazonEC2describeVpcsRequest - AmazonEC2 client = AmazonEC2ClientBuilder.standard().build();
DescribeVpcsRequest request = new DescribeVpcsRequest().withVpcIds("vpc-a01106c2");
DescribeVpcsResult response = client.describeVpcs(request);public DescribeVpcsResult describeVpcs()
AmazonEC2describeVpcs in interface AmazonEC2AmazonEC2.describeVpcs(DescribeVpcsRequest)public DescribeVpnConnectionsResult describeVpnConnections(DescribeVpnConnectionsRequest request)
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.
describeVpnConnections in interface AmazonEC2describeVpnConnectionsRequest - Contains the parameters for DescribeVpnConnections.public DescribeVpnConnectionsResult describeVpnConnections()
AmazonEC2describeVpnConnections in interface AmazonEC2AmazonEC2.describeVpnConnections(DescribeVpnConnectionsRequest)public DescribeVpnGatewaysResult describeVpnGateways(DescribeVpnGatewaysRequest request)
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.
describeVpnGateways in interface AmazonEC2describeVpnGatewaysRequest - Contains the parameters for DescribeVpnGateways.