EC2Connector (Amazon EC2 Connector

java.lang.Object
- org.mule.modules.ec2.EC2Connector

```
@RequiresEnterpriseLicense(allowEval=true)
 @Connector(name="ec2",
           friendlyName="Amazon EC2",
           minMuleVersion="3.9")
public class EC2Connector
extends Object
```
Amazon Elastic Compute Cloud (Amazon EC2) provides scalable computing capacity in the Amazon Web Services (AWS) cloud.The Anypoint Connector for Amazon EC2 provides connectivity to the Amazon Elastic Compute Cloud (Amazon EC2) API, enabling you to interface with Amazon EC2 to launch as many or as few virtual servers as you need, configure security and networking, and manage storage.

Author:

MuleSoft, Inc.

Constructor Summary

Constructors
Constructor and Description

EC2Connector()

Constructors
Constructor and Description
`EC2Connector()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AllocateAddressResult`	`allocateAddress(String domain)` Acquires an Elastic IP address.
`AssignIpv6AddressesResult`	`assignIpv6Addresses(String networkInterfaceId, Integer ipv6AddressCount, List<String> ipv6Addresses)` Assigns one or more IPv6 addresses to the specified network interface.
`void`	`assignPrivateIpAddresses(String networkInterfaceId, Boolean allowReassignment, List<String> privateIpAddresses, Integer secondaryPrivateIpAddressCount)` Assigns one or more secondary private IP addresses to the specified network interface
`AssociateAddressResult`	`associateAddress(String allocationId, Boolean allowReassociation, String instanceId, String networkInterfaceId, String privateIpAddress, String publicIp)` Associates an Elastic IP address with an instance or a network interface.
`AssociateIamInstanceProfileResult`	`associateIamInstanceProfile(String instanceId, String profileName)` Associates an IAM instance profile with a running or stopped instance.
`AttachNetworkInterfaceResult`	`attachNetworkInterface(Integer deviceIndex, String instanceId, String networkInterfaceId)` Attaches a network interface to an instance.
`AttachVolumeResult`	`attachVolume(String volumeId, String instanceId, String device)` Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
`AuthorizeSecurityGroupEgressResult`	`authorizeSecurityGroupEgress(String groupId, String cidrIp, String ipProtocol, Integer fromPort, Integer toPort, List<IpPermission> ipPermissions, String sourceSecurityGroupName, String sourceSecurityGroupOwnerId)` [EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.
`AuthorizeSecurityGroupIngressResult`	`authorizeSecurityGroupIngress(String groupId, String groupName, String cidrIp, String ipProtocol, Integer fromPort, Integer toPort, List<IpPermission> ipPermissions, String sourceSecurityGroupName, String sourceSecurityGroupOwnerId)` Adds one or more ingress rules to a security group.
`CopySnapshotResult`	`copySnapshot(String sourceSnapshotId, RegionEndpoint sourceRegion, String description, RegionEndpoint destinationRegion, String presignedUrl, Boolean encrypted, String kmsKeyId)` Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3.
`CreateImageResult`	`createImage(String instanceId, String iName)` Creates an Amazon EBS-backed AMI from a running or stopped instance
`CreateKeyPairResult`	`createKeyPair(String keyName)` Creates a new 2048-bit RSA key pair with the specified name.
`CreateNetworkInterfaceResult`	`createNetworkInterface(String subnetId, String description, List<String> groups, Integer ipv6AddressCount, List<InstanceIpv6Address> ipv6Addresses, String privateIpAddress, List<PrivateIpAddressSpecification> privateIpAddresses, Integer secondaryPrivateIpAddressCount)` Creates a network interface in the specified subnet.
`CreateSecurityGroupResult`	`createSecurityGroup(String vpcId, String groupName, String description)` Creates a security group.
`CreateSnapshotResult`	`createSnapshot(String volumeId, String description)` Creates a snapshot of an EBS volume and stores it in Amazon S3.
`void`	`createTags(List<String> resources, List<Tag> tags)` Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources.
`CreateVolumeResult`	`createVolume(String availabilityZone, boolean encrypted, Integer iops, String kmsKeyId, Integer size, String snapshotId, VolumeType volumeType)` Creates an EBS volume that can be attached to an instance in the same Availability Zone.
`void`	`deleteKeyPair(String keyName)` Deletes the specified key pair, by removing the public key from Amazon EC2.
`void`	`deleteNetworkInterface(String networkInterfaceId)` Deletes the specified network interface.
`DeleteSecurityGroupResult`	`deleteSecurityGroup(String groupId, String groupName)` Deletes a security group.
`DeleteSnapshotResult`	`deleteSnapshot(String snapshotId)` Deletes the specified snapshot.
`void`	`deleteTags(List<String> resources, List<Tag> tags)` Deletes a specific set of tags from a specific set of resources.
`DeleteVolumeResult`	`deleteVolume(String volumeId)` Deletes the specified EBS volume.
`void`	`deregisterImage(String imageId)` Deregisters the specified AMI.
`DescribeAddressesResult`	`describeAddresses(List<String> allocationIds, List<Filter> filters, List<String> publicIps)` Describes one or more of your Elastic IP addresses.
`DescribeAvailabilityZonesResult`	`describeAvailabilityZones(List<String> zoneNames, List<Filter> filters)` Describes one or more of the Availability Zones that are currently available to the account.
`DescribeIamInstanceProfileAssociationsResult`	`describeIamInstanceProfileAssociations(List<String> associationIds, List<Filter> filters)` Describes your IAM instance profile associations.
`DescribeImageAttributeResult`	`describeImageAttribute(String imageId, String attribute)` Describes an attributes of an AMI.
`DescribeImagesResult`	`describeImages()` Describes one or more of the images available to you (AMIs, AKIs, and ARIs).
`DescribeInstanceAttributeResult`	`describeInstanceAttribute(String attribute, String instanceId)` Describes the specified attribute of the specified instance.
`DescribeInstancesResult`	`describeInstances(List<String> instanceIds, List<Filter> filters)` Describes one or more of your instances.
`DescribeInstanceStatusResult`	`describeInstanceStatus(List<String> instanceIds, List<Filter> filters)` Describes the status of one or more instances.
`DescribeKeyPairsResult`	`describeKeyPairs(List<String> keyNames, List<Filter> filters)` Describes one or more of your key pairs.
`DescribeMovingAddressesResult`	`describeMovingAddresses(List<Filter> filters, Integer maxResults, String nextToken, List<String> publicIps)` Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform.
`DescribeNetworkInterfaceAttributeResult`	`describeNetworkInterfaceAttribute(String attribute, String networkInterfaceId)` Describes a network interface attribute.
`DescribeNetworkInterfacesResult`	`describeNetworkInterfaces(List<Filter> filters, List<String> networkInterfaceIds)` Describes one or more of your network interfaces.
`DescribeRegionsResult`	`describeRegions(List<String> regionNames, List<Filter> filters)` Describes one or more regions that are currently available to you.
`DescribeSecurityGroupReferencesResult`	`describeSecurityGroupReferences(List<String> groupIds)` [EC2-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.
`DescribeSecurityGroupsResult`	`describeSecurityGroups(List<String> groupIds, List<String> groupNames, List<Filter> filters)` Describes one or more of your security groups.
`DescribeSnapshotAttributeResult`	`describeSnapshotAttribute(String snapshotId, SnapshotAttributeName attribute)` Describes the specified attribute of the specified snapshot.
`DescribeSnapshotsResult`	`describeSnapshots(List<String> snapshotIds, List<String> ownerIds, List<String> restorableByUserIds, List<Filter> filters)` Describes one or more of the EBS snapshots available to you.
`DescribeStaleSecurityGroupsResult`	`describeStaleSecurityGroups(String vpcId)` [EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.
`DescribeTagsResult`	`describeTags(List<Filter> filters)` Describes one or more of the tags for your EC2 resources.
`DescribeVolumeAttributeResult`	`describeVolumeAttribute(String volumeId, VolumeAttributeName attributeName)` Describes the specified attribute of the specified volume.
`DescribeVolumesResult`	`describeVolumes(List<String> volumeIds, List<Filter> filters)` Describes the specified EBS volumes.
`DescribeVolumesModificationsResult`	`describeVolumesModifications(List<String> volumeIds, List<Filter> filters)` Reports the current modification status of EBS volumes.
`DescribeVolumeStatusResult`	`describeVolumeStatus(List<String> volumeIds, List<Filter> filters)` Describes the status of the specified volumes.
`void`	`detachNetworkInterface(String attachmentId, Boolean force)` Detaches a network interface from an instance.
`DetachVolumeResult`	`detachVolume(String volumeId, String device, Boolean force, String instanceId)` Detaches an EBS volume from an instance.
`void`	`disAssociateAddress(String associationId, String publicIp)` Disassociates an Elastic IP address from the instance or network interface it's associated with.
`DisassociateIamInstanceProfileResult`	`disassociateIamInstanceProfile(String associationId)` Disassociates an IAM instance profile from a running or stopped instance.
`EnableVolumeIOResult`	`enableVolumeIo(String volumeId)` Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
`Config`	`getConfig()`
`GetConsoleOutputResult`	`getConsoleOutput(String instanceId)` Retrieves console output for the specified instance.
`GetConsoleScreenshotResult`	`getConsoleScreenshot(String instanceId)` Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
`GetPasswordDataResult`	`getPasswordData(String instanceId)` Retrieves the encrypted administrator password for an instance running Windows.
`ImportKeyPairResult`	`importKeyPair(String keyName, String publicKeyMaterial)` Imports the public key from an RSA key pair that you created with a third-party tool.
`void`	`modifyImageAttribute(String imageId, String attribute, String operationType, String value)` Modifies the specified attribute of the specified AMI.
`void`	`modifyInstanceAttribute(String instanceId, String attribute, String value)` Modifies the specified attribute of the specified instance.
`void`	`modifyNetworkInterfaceAttribute(String networkInterfaceId, String attachmentId, String description, List<String> groups, Boolean deleteOnTermination, Boolean sourceDestCheck)` Modifies the specified network interface attribute.
`ModifySnapshotAttributeResult`	`modifySnapshotAttribute(String snapshotId, SnapshotAttributeName attribute, OperationType operationType, Collection<String> groupNames, Collection<String> userIds)` Adds or removes permission settings for the specified snapshot.
`ModifyVolumeResult`	`modifyVolume(String volumeId, Integer iops, Integer size, VolumeType volumeType)` You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity.
`ModifyVolumeAttributeResult`	`modifyVolumeAttribute(String volumeId, boolean autoEnableIO)` Modifies a volume attribute.
`MonitorInstancesResult`	`monitorInstances(List<String> instanceIds)` Enables detailed monitoring for a running instance.
`MoveAddressToVpcResult`	`moveAddressToVpc(String publicIp)` Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform.
`void`	`rebootInstances(List<String> instanceIds)` Requests a reboot of one or more instances.
`void`	`releaseAddress(String allocationId, String publicIp)` Releases the specified Elastic IP address.
`ReplaceIamInstanceProfileAssociationResult`	`replaceIamInstanceProfileAssociation(String associationId, String profileName)` Replaces an IAM instance profile for the specified running instance.
`void`	`reportInstanceStatus(List<String> instanceIds, List<String> reasonCodes, String status, String description)` Submits feedback about the status of an instance.
`void`	`resetImageAttribute(String imageId, String attribute)` Resets an attribute of an AMI to its default value.
`void`	`resetInstanceAttribute(String instanceId, String attribute)` Resets an attribute of an instance to its default value.
`void`	`resetNetworkInterfaceAttribute(String networkInterfaceId, String sourceDestCheck)` Resets a network interface attribute.
`ResetSnapshotAttributeResult`	`resetSnapshotAttribute(String snapshotId, SnapshotAttributeName attribute)` Resets permission settings for the specified snapshot.
`RestoreAddressToClassicResult`	`restoreAddressToClassic(String publicIp)` Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.
`RevokeSecurityGroupEgressResult`	`revokeSecurityGroupEgress(String groupId, String cidrIp, String ipProtocol, Integer fromPort, Integer toPort, List<IpPermission> ipPermissions, String sourceSecurityGroupName, String sourceSecurityGroupOwnerId)` [EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.
`RevokeSecurityGroupIngressResult`	`revokeSecurityGroupIngress(String groupId, String groupName, String cidrIp, String ipProtocol, Integer fromPort, Integer toPort, List<IpPermission> ipPermissions, String sourceSecurityGroupName, String sourceSecurityGroupOwnerId)` Removes one or more ingress rules from a security group.
`RunInstancesResult`	`runInstances(String imageId, Integer minCount, Integer maxCount, List<String> securityGroups, List<String> securityGroupIds, String keyname, String subnetId, String instanceType)` Launches the specified number of instances of an AMI for which you have permissions.
`void`	`setConfig(Config config)`
`StartInstancesResult`	`startInstances(List<String> instanceIds)` Starts an Amazon EBS-backed AMI that you've previously stopped.
`StopInstancesResult`	`stopInstances(List<String> instanceIds, Boolean force)` Stops an Amazon EBS-backed instance.
`TerminateInstancesResult`	`terminateInstances(List<String> instanceIds)` Shuts down one or more instances.
`UnassignIpv6AddressesResult`	`unassignIpv6Addresses(List<String> ipv6Addresses, String networkInterfaceId)` Unassigns one or more IPv6 addresses from a network interface.
`void`	`unAssignPrivateIpAddresses(String networkInterfaceId, List<String> privateIpAddresses)` Unassigns one or more secondary private IP addresses from a network interface.
`UnmonitorInstancesResult`	`unmonitorInstances(List<String> instanceIds)` Disables detailed monitoring for a running instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EC2Connector
```
public EC2Connector()
```

Method Detail

getConfig
```
public Config getConfig()
```

setConfig
```
public void setConfig(Config config)
```

createImage

@Processor
public CreateImageResult createImage(String instanceId,
                                                String iName)

Creates an Amazon EBS-backed AMI from a running or stopped instance

API reference

Parameters:: instanceId - instance information; iName - instance name
Returns:: operation results

deregisterImage
```
@Processor
public void deregisterImage(String imageId)
```
Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.
API reference

Parameters:

imageId - AMI id to be deregistered

describeImages
```
@Processor
public DescribeImagesResult describeImages()
```
Describes one or more of the images available to you (AMIs, AKIs, and ARIs). Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
API reference

Returns:

describe images result

describeImageAttribute

@Processor
public DescribeImageAttributeResult describeImageAttribute(String imageId,
                                                                      @Optional
                                                                      String attribute)

Describes an attributes of an AMI. You can specify only one attribute at a time

API reference

Parameters:: imageId - The ID of the AMI.; attribute - The attribute to reset (currently you can only reset the launch permission attribute).
Returns:: operation results

resetImageAttribute
```
@Processor
public void resetImageAttribute(String imageId,
                                           String attribute)
```
Resets an attribute of an AMI to its default value.
API reference

Parameters:

imageId - The ID of the AMI.

attribute - The attribute to reset (currently you can only reset the launch permission attribute).

modifyImageAttribute

@Processor
public void modifyImageAttribute(String imageId,
                                            @Optional
                                            String attribute,
                                            @Optional
                                            String operationType,
                                            @Optional
                                            String value)

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

API reference

Parameters:: imageId - The ID of the AMI.; attribute - The name of the attribute to modify.; operationType - The operation type.; value - The value of the attribute being modified.

createKeyPair
```
@Processor
public CreateKeyPairResult createKeyPair(String keyName)
```
Creates a new 2048-bit RSA key pair with the specified name. The public key is stored by Amazon EC2 and the private key is returned to you. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
API reference

Parameters:

keyName - A unique name for the key pair.

Returns:

CreateKeyPairResult which has the KeyPair that got created.

importKeyPair
```
@Processor
public ImportKeyPairResult importKeyPair(@Placement(order=1)
                                                    String keyName,
                                                    @Placement(order=2)
                                                    String publicKeyMaterial)
```
Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
API reference

Parameters:

keyName - A unique name for the key pair.

publicKeyMaterial - The public key which must be base64-encoded.

Returns:

ImportKeyPairResult which contains the KeyName and KeyFingerPrint

deleteKeyPair
```
@Processor
public void deleteKeyPair(String keyName)
```
Deletes the specified key pair, by removing the public key from Amazon EC2.
API reference

Parameters:

keyName - the name of the key pair to be deleted

describeKeyPairs

@Processor
public DescribeKeyPairsResult describeKeyPairs(@Placement(order=1) @Optional
                                                          List<String> keyNames,
                                                          @Placement(order=2) @Optional
                                                          List<Filter> filters)

Describes one or more of your key pairs.

API reference

Parameters:: keyNames - One or more key pair names to which we need describeKeyPairs service to return information for. When the list is null or empty, it returns all the available KeyPairs' information.
Returns:: DescribeKeyPairsResult which contains the information for KeyPairs

createVolume

@Processor
public CreateVolumeResult createVolume(@Placement(order=1)
                                                  String availabilityZone,
                                                  @Placement(order=2) @Default(value="false")
                                                  boolean encrypted,
                                                  @Placement(order=3) @Optional
                                                  Integer iops,
                                                  @Placement(order=4) @Optional
                                                  String kmsKeyId,
                                                  @Placement(order=5) @Optional
                                                  Integer size,
                                                  @Placement(order=6) @Optional
                                                  String snapshotId,
                                                  @Placement(order=7) @Default(value="Standard")
                                                  VolumeType volumeType)

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. 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 with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted.

API reference

Parameters:: availabilityZone - The Availability Zone in which to create the volume.; encrypted - Specifies whether the volume should be encrypted.; iops - Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.; kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.; size - The size of the volume, in GiBs.; snapshotId - The snapshot from which to create the volume.; volumeType - The volume type.
Returns:: CreateVolumeResult A simple result wrapper around the Volume object that was sent over the wire.

attachVolume

@Processor
public AttachVolumeResult attachVolume(@Placement(order=1)
                                                  String volumeId,
                                                  @Placement(order=2)
                                                  String instanceId,
                                                  @Placement(order=3)
                                                  String device)

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption.

API reference

Parameters:: volumeId - The ID of the EBS volume.; instanceId - The ID of the instance.; device - The device name to expose to the instance (for example, /dev/sdh or xvdh).
Returns:: AttachVolumeResult A simple result wrapper around the VolumeAttachment object that was sent over the wire.

deleteVolume
```
@Processor
public DeleteVolumeResult deleteVolume(String volumeId)
```
Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance). The volume may remain in the deleting state for several minutes.
API reference

Parameters:

volumeId - The ID of the volume.

Returns:

DeleteVolumeResult

describeVolumes
```
@Processor
public DescribeVolumesResult describeVolumes(@Placement(order=1) @Optional
                                                        List<String> volumeIds,
                                                        @Placement(order=2) @Optional
                                                        List<Filter> filters)
```
Describes the specified EBS volumes. If you are describing a long list of volumes, you can 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.
API reference

Parameters:

volumeIds - One or more volume IDs.

filters - One or more filters.

Returns:

DescribeVolumesResult Contains the output of describeVolumes.

describeVolumeAttribute

@Processor
public DescribeVolumeAttributeResult describeVolumeAttribute(@Placement(order=1)
                                                                        String volumeId,
                                                                        @Placement(order=2) @Default(value="AutoEnableIO")
                                                                        VolumeAttributeName attributeName)

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

API reference

Parameters:: volumeId - The ID of the volume.; attributeName - The attribute of the volume.
Returns:: DescribeVolumeAttributeResult Contains the output of describeVolumeAttribute.

enableVolumeIo
```
@Processor
public EnableVolumeIOResult enableVolumeIo(String volumeId)
```
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
API reference

Parameters:

volumeId - The ID of the volume.

Returns:

EnableVolumeIOResult

modifyVolumeAttribute
```
@Processor
public ModifyVolumeAttributeResult modifyVolumeAttribute(String volumeId,
                                                                    @Default(value="true")
                                                                    boolean autoEnableIO)
```
Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
API reference

Parameters:

volumeId - The ID of the volume.

autoEnableIO - Indicates whether the volume should be auto-enabled for I/O operations.

Returns:

ModifyVolumeAttributeResult

describeVolumeStatus
```
@Processor
public DescribeVolumeStatusResult describeVolumeStatus(@Placement(order=1) @Optional
                                                                  List<String> volumeIds,
                                                                  @Placement(order=2) @Optional
                                                                  List<Filter> filters)
```
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.
API reference

Parameters:

volumeIds - One or more volume IDs.

filters - One or more filters.

Returns:

DescribeVolumeStatusResult Contains the output of describeVolumeStatus.

detachVolume
```
@Processor
public DetachVolumeResult detachVolume(@Placement(order=1)
                                                  String volumeId,
                                                  @Placement(order=2) @Optional
                                                  String device,
                                                  @Placement(order=3) @Optional
                                                  Boolean force,
                                                  @Placement(order=4) @Optional
                                                  String instanceId)
```
Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
API reference

Parameters:

volumeId - The ID of the volume.

device - The device name.

force - Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally).

instanceId - The ID of the instance.

Returns:

DetachVolumeResult A simple result wrapper around the VolumeAttachment object that was sent over the wire.

modifyVolume

@Processor
public ModifyVolumeResult modifyVolume(@Placement(order=1)
                                                  String volumeId,
                                                  @Placement(order=2) @Optional
                                                  Integer iops,
                                                  @Placement(order=3) @Optional
                                                  Integer size,
                                                  @Placement(order=4) @Optional
                                                  VolumeType volumeType)

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity.

API reference

Parameters:: volumeId - The ID of the volume to be modified.; iops - Target IOPS rate of the volume to be modified.; size - Target size in GiB of the volume to be modified.; volumeType - Target EBS volume type of the volume to be modified
Returns:: ModifyVolumeResult Contains the output of modifyVolume.

describeVolumesModifications
```
@Processor
public DescribeVolumesModificationsResult describeVolumesModifications(@Placement(order=1) @Optional
                                                                                  List<String> volumeIds,
                                                                                  @Placement(order=2) @Optional
                                                                                  List<Filter> filters)
```
Reports the current modification status of EBS volumes. Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.
API reference

Parameters:

volumeIds - One or more volume IDs for which in-progress modifications will be described.

filters - One or more filters.

Returns:

DescribeVolumesModificationsResult Contains the output of describeVolumesModifications.

createSnapshot
```
@Processor
public CreateSnapshotResult createSnapshot(String volumeId,
                                                      @Optional
                                                      String description)
```
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.
API reference

Parameters:

volumeId - The ID of the EBS volume.

description - A description for the snapshot.

Returns:

CreateSnapshotResult A simple result wrapper around the Snapshot object that was sent over the wire.

copySnapshot
```
@Processor
public CopySnapshotResult copySnapshot(@Placement(order=1)
                                                  String sourceSnapshotId,
                                                  @Placement(order=2)
                                                  RegionEndpoint sourceRegion,
                                                  @Placement(order=3) @Optional
                                                  String description,
                                                  @Placement(order=4) @Optional
                                                  RegionEndpoint destinationRegion,
                                                  @Placement(order=5) @Optional
                                                  String presignedUrl,
                                                  @Placement(order=6) @Optional
                                                  Boolean encrypted,
                                                  @Placement(order=7) @Optional
                                                  String kmsKeyId)
```
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). The snapshot is copied to the regional endpoint that you send the HTTP request to. Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during 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 non-default CMK with the KmsKeyId parameter. 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 the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
API reference

Parameters:

sourceSnapshotId - The ID of the EBS snapshot to copy.

sourceRegion - The ID of the region that contains the snapshot to be copied.

description - A description for the EBS snapshot.

destinationRegion - The destination region to use in the PresignedUrl parameter of a snapshot copy operation.

presignedUrl - The pre-signed URL that facilitates copying an encrypted snapshot.

encrypted - Specifies whether the destination snapshot should be encrypted.

kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.

Returns:

CopySnapshotResult Contains the output of copySnapshot.

deleteSnapshot
```
@Processor
public DeleteSnapshotResult deleteSnapshot(String snapshotId)
```
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.
API reference

Parameters:

snapshotId - The ID of the EBS snapshot.

Returns:

DeleteSnapshotResult Contains the output of deleteSnapshot.

describeSnapshots
```
@Processor
public DescribeSnapshotsResult describeSnapshots(@Placement(order=1) @Optional
                                                            List<String> snapshotIds,
                                                            @Placement(order=2) @Optional
                                                            List<String> ownerIds,
                                                            @Placement(order=3) @Optional
                                                            List<String> restorableByUserIds,
                                                            @Placement(order=4) @Optional
                                                            List<Filter> filters)
```
Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions. The list of snapshots returned can be modified 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.
API reference

Parameters:

snapshotIds - One or more snapshot IDs.

ownerIds - Returns the snapshots owned by the specified owner.

restorableByUserIds - One or more AWS accounts IDs that can create volumes from the snapshot.

filters - One or more filters.

Returns:

DescribeSnapshotsResult Contains the output of describeSnapshots.

describeSnapshotAttribute

@Processor
public DescribeSnapshotAttributeResult describeSnapshotAttribute(String snapshotId,
                                                                            @Default(value="CreateVolumePermission")
                                                                            SnapshotAttributeName attribute)

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

API reference

Parameters:: snapshotId - The ID of the EBS snapshot.; attribute - The snapshot attribute you would like to view.
Returns:: DescribeSnapshotAttributeResult Contains the output of describeSnapshotAttribute.

modifySnapshotAttribute

@Processor
public ModifySnapshotAttributeResult modifySnapshotAttribute(@Placement(order=1)
                                                                        String snapshotId,
                                                                        @Placement(order=2) @Default(value="CreateVolumePermission")
                                                                        SnapshotAttributeName attribute,
                                                                        @Placement(order=3) @Default(value="Add")
                                                                        OperationType operationType,
                                                                        @Placement(order=4) @Optional
                                                                        Collection<String> groupNames,
                                                                        @Placement(order=5) @Optional
                                                                        Collection<String> userIds)

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls. Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

API reference

Parameters:: snapshotId - The ID of the snapshot.; attribute - The snapshot attribute to modify.; operationType - The type of operation to perform to the attribute.; groupNames - The group to modify for the snapshot.; userIds - The account ID to modify for the snapshot.
Returns:: ModifySnapshotAttributeResult Contains the output of modifySnapshotAttribute.

resetSnapshotAttribute

@Processor
public ResetSnapshotAttributeResult resetSnapshotAttribute(String snapshotId,
                                                                      @Default(value="CreateVolumePermission")
                                                                      SnapshotAttributeName attribute)

Resets permission settings for the specified snapshot.

API reference

Parameters:: snapshotId - The ID of the snapshot.; attribute - The attribute to reset.
Returns:: ResetSnapshotAttributeResult Contains the output of resetSnapshotAttribute.

createTags
```
@Processor
public void createTags(List<String> resources,
                                  List<Tag> tags)
```
Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. 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.
API reference

Parameters:

resources - (list) The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

tags - (list) One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

deleteTags
```
@Processor
public void deleteTags(List<String> resources,
                                  List<Tag> tags)
```
Deletes a specific set of tags from a specific set of resources. This call is designed to follow a DescribeTags call. You first determine what tags a resource has, and then you call DeleteTags with the resource ID and the specific tags you want to delete.
API reference

Parameters:

resources - (list) The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

tags - (list) One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

describeTags

@Processor
public DescribeTagsResult describeTags(@Optional
                                                  List<Filter> filters)

Describes one or more of the tags for your EC2 resources.

API reference

Parameters:: filters - one or more filters
Returns:: operation results

describeRegions

@Processor
public DescribeRegionsResult describeRegions(@Optional
                                                        List<String> regionNames,
                                                        @Optional
                                                        List<Filter> filters)

Describes one or more regions that are currently available to you.

API reference

Parameters:: regionNames - The names of one or more regions.; filters - One or more filters.
Returns:: operation results

describeAvailabilityZones

@Processor
public DescribeAvailabilityZonesResult describeAvailabilityZones(@Optional
                                                                            List<String> zoneNames,
                                                                            @Optional
                                                                            List<Filter> filters)

Describes one or more of the Availability Zones that are currently available to the account. The results include zones only for the region you're currently using.

API reference

Parameters:: zoneNames - The names of one or more Availability Zones.; filters - One or more filters.
Returns:: operation results

associateIamInstanceProfile
```
@Processor
public AssociateIamInstanceProfileResult associateIamInstanceProfile(String instanceId,
                                                                                String profileName)
```
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
API reference

Parameters:

instanceId - The ID of the instance.

profileName - The NAME of the instance profile.

Returns:

operation results

describeIamInstanceProfileAssociations

@Processor
public DescribeIamInstanceProfileAssociationsResult describeIamInstanceProfileAssociations(@Optional
                                                                                                      List<String> associationIds,
                                                                                                      @Optional
                                                                                                      List<Filter> filters)

Describes your IAM instance profile associations.

API reference

Parameters:: associationIds - One or more IAM instance profile associations.; filters - One or more filters.
Returns:: operation results

describeInstanceAttribute
```
@Processor
public DescribeInstanceAttributeResult describeInstanceAttribute(String attribute,
                                                                            String instanceId)
```
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
API reference

Parameters:

attribute - The instance attribute.

instanceId - The ID of the instance.

Returns:

operation results

describeInstances
```
@Processor
public DescribeInstancesResult describeInstances(@Optional
                                                            List<String> instanceIds,
                                                            @Optional
                                                            List<Filter> filters)
```
Describes one or more of your instances. If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. 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 returned results.
API reference

Parameters:

instanceIds - One or more instance IDs.

filters - One or more filters.

Returns:

operation results

describeInstanceStatus

@Processor
public DescribeInstanceStatusResult describeInstanceStatus(@Optional
                                                                      List<String> instanceIds,
                                                                      @Optional
                                                                      List<Filter> filters)

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

API reference

Parameters:: instanceIds - One or more instance IDs.; filters - One or more filters.
Returns:: operation results

disassociateIamInstanceProfile
```
@Processor
public DisassociateIamInstanceProfileResult disassociateIamInstanceProfile(String associationId)
```
Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.
API reference

Parameters:

associationId - The ID of the IAM instance profile association.

Returns:

operation results

getConsoleOutput
```
@Processor
public GetConsoleOutputResult getConsoleOutput(String instanceId)
```
Retrieves console output for the specified instance.
API reference

Parameters:

instanceId - The ID of the instance.

Returns:

operation results

getConsoleScreenshot
```
@Processor
public GetConsoleScreenshotResult getConsoleScreenshot(String instanceId)
```
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.
API reference

Parameters:

instanceId - The ID of the instance.

Returns:

operation results

getPasswordData
```
@Processor
public GetPasswordDataResult getPasswordData(String instanceId)
```
Retrieves the encrypted administrator password for an instance running Windows.
API reference

Parameters:

instanceId - The ID of the Windows instance.

Returns:

operation results

modifyInstanceAttribute
```
@Processor
public void modifyInstanceAttribute(String instanceId,
                                               String attribute,
                                               String value)
```
Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. To modify some attributes, the instance must be stopped.
API reference

Parameters:

instanceId - The ID of the instance.

attribute - The name of the attribute.

value - A new value for the attribute.

monitorInstances
```
@Processor
public MonitorInstancesResult monitorInstances(List<String> instanceIds)
```
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled.
API reference

Parameters:

instanceIds - One or more instance IDs.

Returns:

operation results

rebootInstances
```
@Processor
public void rebootInstances(List<String> instanceIds)
```
Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instance(s). The operation will succeed if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.
API reference

Parameters:

instanceIds - One or more instance IDs.

replaceIamInstanceProfileAssociation
```
@Processor
public ReplaceIamInstanceProfileAssociationResult replaceIamInstanceProfileAssociation(String associationId,
                                                                                                  String profileName)
```
Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first
API reference

Parameters:

associationId - The ID of the existing IAM instance profile association

profileName - The NAME of the instance profile to replace.

Returns:

operation results

reportInstanceStatus
```
@Processor
public void reportInstanceStatus(List<String> instanceIds,
                                            List<String> reasonCodes,
                                            String status,
                                            @Optional
                                            String description)
```
Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks. Use of this action does not change the value returned by DescribeInstanceStatus.
API reference

Parameters:

instanceIds - One or more instance IDs.

reasonCodes - One or more reason codes that describes the health state of your instance.

status - The status of all instances listed.

description - Descriptive text about the health state of your instance.

resetInstanceAttribute
```
@Processor
public void resetInstanceAttribute(String instanceId,
                                              String attribute)
```
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk , the instance must be in a stopped state. To reset the sourceDestCheck , the instance can be either running or stopped. The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true , which means checking is enabled. This value must be false for a NAT instance to perform NAT.
API reference

Parameters:

instanceId - The ID of the instance.

attribute - The attribute to reset.You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

startInstances
```
@Processor
public StartInstancesResult startInstances(List<String> instanceIds)
```
Starts an Amazon EBS-backed AMI that you've previously stopped.
API reference

Parameters:

instanceIds - One or more instance IDs.

Returns:

StartInstancesResult Contains the output of StartInstances

stopInstances

@Processor
public StopInstancesResult stopInstances(List<String> instanceIds,
                                                    @Optional
                                                    Boolean force)

Stops an Amazon EBS-backed instance.

API reference

Parameters:: instanceIds - One or more instance IDs.; force - Forces the instances to stop.
Returns:: StopInstancesResult Contains the output of StopInstances.

terminateInstances
```
@Processor
public TerminateInstancesResult terminateInstances(List<String> instanceIds)
```
Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. Terminated instances will remain visible after termination (approximately one hour).
API reference

Parameters:

instanceIds - One or more instance IDs.

Returns:

result of the operation

unmonitorInstances
```
@Processor
public UnmonitorInstancesResult unmonitorInstances(List<String> instanceIds)
```
Disables detailed monitoring for a running instance.
API reference

Parameters:

instanceIds - One or more instance IDs.

Returns:

operation results

runInstances

@Processor
public RunInstancesResult runInstances(String imageId,
                                                  @Default(value="1")
                                                  Integer minCount,
                                                  @Default(value="1")
                                                  Integer maxCount,
                                                  @Optional
                                                  List<String> securityGroups,
                                                  @Optional
                                                  List<String> securityGroupIds,
                                                  @Optional
                                                  String keyname,
                                                  @Optional
                                                  String subnetId,
                                                  @Optional
                                                  String instanceType)

Launches the specified number of instances of an AMI for which you have permissions.

API reference

Parameters:: imageId - The ID of the AMI, which you can get by calling describe-images; minCount - The minimum no of instances to launch; maxCount - The maximum no of instances to launch; securityGroups - One or more security group names; securityGroupIds - One or more security group IDs.; keyname - The name of the key pair; subnetId - The ID of the subnet to launch the instance into.
Returns:: operation results

createSecurityGroup

@Processor
public CreateSecurityGroupResult createSecurityGroup(@Placement(order=1) @Optional
                                                                String vpcId,
                                                                @Placement(order=2)
                                                                String groupName,
                                                                @Placement(order=3)
                                                                String description)

Creates a security group.

API reference

Parameters:: vpcId - The ID of the VPC.; groupName - The name of the security group.; description - A description for the security group.
Returns:: CreateSecurityGroupResult Contains the output of CreateSecurityGroup.

describeSecurityGroups

@Processor
public DescribeSecurityGroupsResult describeSecurityGroups(@Placement(order=1) @Optional
                                                                      List<String> groupIds,
                                                                      @Placement(order=2) @Optional
                                                                      List<String> groupNames,
                                                                      @Placement(order=3) @Optional
                                                                      List<Filter> filters)

Describes one or more of your security groups.

API reference

Parameters:: groupIds - One or more security group IDs.; groupNames - [EC2-Classic and default VPC only] One or more security group names.; filters - One or more filters.
Returns:: DescribeSecurityGroupsResult Contains the output of DescribeSecurityGroups.

deleteSecurityGroup

@Processor
public DeleteSecurityGroupResult deleteSecurityGroup(@Placement(order=1) @Optional
                                                                String groupId,
                                                                @Placement(order=2) @Optional
                                                                String groupName)

Deletes a security group.

API reference

Parameters:: groupId - The ID of the security group.; groupName - [EC2-Classic, default VPC] The name of the security group.
Returns:: DeleteSecurityGroupResult

authorizeSecurityGroupIngress

@Processor
public AuthorizeSecurityGroupIngressResult authorizeSecurityGroupIngress(@Placement(order=1) @Optional
                                                                                    String groupId,
                                                                                    @Placement(order=2) @Optional
                                                                                    String groupName,
                                                                                    @Placement(order=3) @Optional
                                                                                    String cidrIp,
                                                                                    @Placement(order=4) @Optional
                                                                                    String ipProtocol,
                                                                                    @Placement(order=5) @Optional
                                                                                    Integer fromPort,
                                                                                    @Placement(order=6) @Optional
                                                                                    Integer toPort,
                                                                                    @Placement(order=7) @Optional
                                                                                    List<IpPermission> ipPermissions,
                                                                                    @Placement(order=8) @Optional
                                                                                    String sourceSecurityGroupName,
                                                                                    @Placement(order=9) @Optional
                                                                                    String sourceSecurityGroupOwnerId)

Adds one or more ingress rules to a security group.

API reference

Parameters:: groupId - The ID of the security group.; groupName - [EC2-Classic, default VPC] The name of the security group.; cidrIp - The CIDR IPv4 address range.; ipProtocol - The IP protocol name (tcp, udp, icmp) or number.; fromPort - The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.; toPort - The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number.; ipPermissions - A set of IP permissions.; sourceSecurityGroupName - [EC2-Classic, default VPC] The name of the source security group.; sourceSecurityGroupOwnerId - [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account.
Returns:: AuthorizeSecurityGroupIngressResult

revokeSecurityGroupIngress

@Processor
public RevokeSecurityGroupIngressResult revokeSecurityGroupIngress(@Placement(order=1) @Optional
                                                                              String groupId,
                                                                              @Placement(order=2) @Optional
                                                                              String groupName,
                                                                              @Placement(order=3) @Optional
                                                                              String cidrIp,
                                                                              @Placement(order=4) @Optional
                                                                              String ipProtocol,
                                                                              @Placement(order=5) @Optional
                                                                              Integer fromPort,
                                                                              @Placement(order=6) @Optional
                                                                              Integer toPort,
                                                                              @Placement(order=7) @Optional
                                                                              List<IpPermission> ipPermissions,
                                                                              @Placement(order=8) @Optional
                                                                              String sourceSecurityGroupName,
                                                                              @Placement(order=9) @Optional
                                                                              String sourceSecurityGroupOwnerId)

Removes one or more ingress rules from a security group.

API reference

Parameters:: groupId - The ID of the security group.; groupName - [EC2-Classic, default VPC] The name of the security group.; cidrIp - The CIDR IP address range.; ipProtocol - The IP protocol name (tcp, udp, icmp) or number.; fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number.; toPort - The end of port range for the TCP and UDP protocols, or an ICMP code number.; ipPermissions - A set of IP permissions.; sourceSecurityGroupName - [EC2-Classic, default VPC] The name of the source security group.; sourceSecurityGroupOwnerId - [EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account.
Returns:: RevokeSecurityGroupIngressResult

authorizeSecurityGroupEgress

@Processor
public AuthorizeSecurityGroupEgressResult authorizeSecurityGroupEgress(@Placement(order=1)
                                                                                  String groupId,
                                                                                  @Placement(order=2) @Optional
                                                                                  String cidrIp,
                                                                                  @Placement(order=3) @Optional
                                                                                  String ipProtocol,
                                                                                  @Placement(order=4) @Optional
                                                                                  Integer fromPort,
                                                                                  @Placement(order=5) @Optional
                                                                                  Integer toPort,
                                                                                  @Placement(order=6) @Optional
                                                                                  List<IpPermission> ipPermissions,
                                                                                  @Placement(order=7) @Optional
                                                                                  String sourceSecurityGroupName,
                                                                                  @Placement(order=8) @Optional
                                                                                  String sourceSecurityGroupOwnerId)

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.

API reference

Parameters:: groupId - The ID of the security group.; cidrIp - The CIDR IPv4 address range.; ipProtocol - The IP protocol name or number.; fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number.; toPort - The end of port range for the TCP and UDP protocols, or an ICMP type number.; ipPermissions - A set of IP permissions.; sourceSecurityGroupName - The name of a destination security group.; sourceSecurityGroupOwnerId - The AWS account number for a destination security group.
Returns:: AuthorizeSecurityGroupEgressResult

revokeSecurityGroupEgress

@Processor
public RevokeSecurityGroupEgressResult revokeSecurityGroupEgress(@Placement(order=1)
                                                                            String groupId,
                                                                            @Placement(order=2) @Optional
                                                                            String cidrIp,
                                                                            @Placement(order=3) @Optional
                                                                            String ipProtocol,
                                                                            @Placement(order=4) @Optional
                                                                            Integer fromPort,
                                                                            @Placement(order=5) @Optional
                                                                            Integer toPort,
                                                                            @Placement(order=6) @Optional
                                                                            List<IpPermission> ipPermissions,
                                                                            @Placement(order=7) @Optional
                                                                            String sourceSecurityGroupName,
                                                                            @Placement(order=8) @Optional
                                                                            String sourceSecurityGroupOwnerId)

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.

API reference

Parameters:: groupId - The ID of the security group.; cidrIp - The CIDR IP address range.; ipProtocol - The IP protocol name or number.; fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number.; toPort - The end of port range for the TCP and UDP protocols, or an ICMP type number.; ipPermissions - A set of IP permissions.; sourceSecurityGroupName - The name of a destination security group.; sourceSecurityGroupOwnerId - The AWS account number for a destination security group.
Returns:: RevokeSecurityGroupEgressResult

describeSecurityGroupReferences
```
@Processor
public DescribeSecurityGroupReferencesResult describeSecurityGroupReferences(List<String> groupIds)
```
[EC2-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.
API reference

Parameters:

groupIds - One or more security group IDs in your account.

Returns:

DescribeSecurityGroupReferencesResult Contains the output of DescribeSecurityGroupReferences.

describeStaleSecurityGroups
```
@Processor
public DescribeStaleSecurityGroupsResult describeStaleSecurityGroups(String vpcId)
```
[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.
API reference

Parameters:

vpcId - The ID of the VPC.

Returns:

DescribeStaleSecurityGroupsResult Contains the output of DescribeStaleSecurityGroups.

allocateAddress
```
@Processor
public AllocateAddressResult allocateAddress(@Optional
                                                        String domain)
```
Acquires an Elastic IP address.
API reference

Parameters:

domain - Set to vpc to allocate the address for use with instances in a VPC. Default: The address is for use with instances in EC2-Classic. Valid Values: vpc | standard

Returns:

operation results

associateAddress

@Processor
public AssociateAddressResult associateAddress(@Optional
                                                          String allocationId,
                                                          @Optional
                                                          Boolean allowReassociation,
                                                          @Optional
                                                          String instanceId,
                                                          @Optional
                                                          String networkInterfaceId,
                                                          @Optional
                                                          String privateIpAddress,
                                                          @Optional
                                                          String publicIp)

Associates an Elastic IP address with an instance or a network interface.

API reference

Parameters:: allocationId - EC2-VPC] The allocation ID. This is required for EC2-VPC.; allowReassociation - [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails.; instanceId - The ID of the instance.; networkInterfaceId - [EC2-VPC] The ID of the network interface; privateIpAddress - [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address.; publicIp - The Elastic IP address. This is required for EC2-Classic.
Returns:: operation Results

describeAddresses

@Processor
public DescribeAddressesResult describeAddresses(@Optional
                                                            List<String> allocationIds,
                                                            @Optional
                                                            List<Filter> filters,
                                                            @Optional
                                                            List<String> publicIps)

Describes one or more of your Elastic IP addresses.

API reference

Parameters:: allocationIds - [EC2-VPC] One or more allocation IDs.; filters - One or more filters. Filter names and values are case-sensitive.; publicIps - [EC2-Classic] One or more Elastic IP addresses.
Returns:: operation results

describeMovingAddresses

@Processor
public DescribeMovingAddressesResult describeMovingAddresses(@Optional
                                                                        List<Filter> filters,
                                                                        @Optional
                                                                        Integer maxResults,
                                                                        @Optional
                                                                        String nextToken,
                                                                        @Optional
                                                                        List<String> publicIps)

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.

API reference

Parameters:: filters - One or more filters.; maxResults - The maximum number of results to return for the request in a single page.; nextToken - The token to use to retrieve the next page of results.; publicIps - One or more Elastic IP addresses.
Returns:: operation results

disAssociateAddress

@Processor
public void disAssociateAddress(@Optional
                                           String associationId,
                                           @Optional
                                           String publicIp)

Disassociates an Elastic IP address from the instance or network interface it's associated with.

API reference

Parameters:: associationId - [EC2-VPC] The association ID. Required for EC2-VPC.; publicIp - [EC2-Classic] The Elastic IP address. Required for EC2-Classic.

moveAddressToVpc
```
@Processor
public MoveAddressToVpcResult moveAddressToVpc(String publicIp)
```
Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance.
API Reference

Parameters:

publicIp - The Elastic IP address.

Returns:

operation results

releaseAddress
```
@Processor
public void releaseAddress(@Optional
                                      String allocationId,
                                      @Optional
                                      String publicIp)
```
Releases the specified Elastic IP address. After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you
API Reference

Parameters:

allocationId - [EC2-VPC] The allocation ID. Required for EC2-VPC.

publicIp - [EC2-Classic] The Elastic IP address. Required for EC2-Classic.

restoreAddressToClassic
```
@Processor
public RestoreAddressToClassicResult restoreAddressToClassic(String publicIp)
```
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.
API Reference

Parameters:

publicIp - The Elastic IP address

Returns:

Operation results

assignIpv6Addresses
```
@Processor
public AssignIpv6AddressesResult assignIpv6Addresses(String networkInterfaceId,
                                                                @Optional
                                                                Integer ipv6AddressCount,
                                                                @Optional
                                                                List<String> ipv6Addresses)
```
Assigns one or more IPv6 addresses to the specified network interface.
API Reference

Parameters:

networkInterfaceId - The ID of the network interface.

ipv6AddressCount - The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

ipv6Addresses - One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

Returns:

Operational Results

unassignIpv6Addresses

@Processor
public UnassignIpv6AddressesResult unassignIpv6Addresses(List<String> ipv6Addresses,
                                                                    String networkInterfaceId)

Unassigns one or more IPv6 addresses from a network interface.

API Reference

Parameters:: ipv6Addresses - The IPv6 addresses to unassign from the network interface.; networkInterfaceId - The ID of the network interface.
Returns:: Operational Results

assignPrivateIpAddresses
```
@Processor
public void assignPrivateIpAddresses(String networkInterfaceId,
                                                @Optional
                                                Boolean allowReassignment,
                                                @Optional
                                                List<String> privateIpAddresses,
                                                @Optional
                                                Integer secondaryPrivateIpAddressCount)
```
Assigns one or more secondary private IP addresses to the specified network interface
API Reference

Parameters:

networkInterfaceId - The ID of the network interface.

allowReassignment - Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

privateIpAddresses - One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

secondaryPrivateIpAddressCount - The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

unAssignPrivateIpAddresses
```
@Processor
public void unAssignPrivateIpAddresses(String networkInterfaceId,
                                                  List<String> privateIpAddresses)
```
Unassigns one or more secondary private IP addresses from a network interface.
API Reference

Parameters:

networkInterfaceId - The ID of the network interface.

privateIpAddresses - The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

createNetworkInterface

@Processor
public CreateNetworkInterfaceResult createNetworkInterface(String subnetId,
                                                                      @Optional
                                                                      String description,
                                                                      @Optional
                                                                      List<String> groups,
                                                                      @Optional
                                                                      Integer ipv6AddressCount,
                                                                      @Optional
                                                                      List<InstanceIpv6Address> ipv6Addresses,
                                                                      @Optional
                                                                      String privateIpAddress,
                                                                      @Optional
                                                                      List<PrivateIpAddressSpecification> privateIpAddresses,
                                                                      @Optional
                                                                      Integer secondaryPrivateIpAddressCount)

Creates a network interface in the specified subnet.

API Reference

Parameters:: subnetId - The ID of the subnet to associate with the network interface.; description - A description for the network interface.; groups - The IDs of one or more security groups.; ipv6AddressCount - The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.; ipv6Addresses - One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.; privateIpAddress - The primary private IPv4 address of the network interface; privateIpAddresses - One or more private IPv4 addresses.; secondaryPrivateIpAddressCount - The number of secondary private IPv4 addresses to assign to a network interface.
Returns:: Operational Results.

deleteNetworkInterface
```
@Processor
public void deleteNetworkInterface(String networkInterfaceId)
```
Deletes the specified network interface. You must detach the network interface before you can delete it.
API Reference

Parameters:

networkInterfaceId - The ID of the network interface.

attachNetworkInterface

@Processor
public AttachNetworkInterfaceResult attachNetworkInterface(Integer deviceIndex,
                                                                      String instanceId,
                                                                      String networkInterfaceId)

Attaches a network interface to an instance.

API Referece

Parameters:: deviceIndex - The index of the device for the network interface attachment.; instanceId - The ID of the instance.; networkInterfaceId - The ID of the network interface.
Returns:: Operational Results

detachNetworkInterface

@Processor
public void detachNetworkInterface(String attachmentId,
                                              @Optional
                                              Boolean force)

Detaches a network interface from an instance.

API Reference

Parameters:: attachmentId - The ID of the network interface.; force - Specifies whether to force a detachment.

describeNetworkInterfaces

@Processor
public DescribeNetworkInterfacesResult describeNetworkInterfaces(@Optional
                                                                            List<Filter> filters,
                                                                            @Optional
                                                                            List<String> networkInterfaceIds)

Describes one or more of your network interfaces.

API Reference

Parameters:: filters - One or more filters.; networkInterfaceIds - One or more network interface IDs.
Returns:: Operational Results.

modifyNetworkInterfaceAttribute
```
@Processor
public void modifyNetworkInterfaceAttribute(String networkInterfaceId,
                                                       @Optional
                                                       String attachmentId,
                                                       @Optional
                                                       String description,
                                                       @Optional
                                                       List<String> groups,
                                                       @Optional
                                                       Boolean deleteOnTermination,
                                                       @Optional
                                                       Boolean sourceDestCheck)
```
Modifies the specified network interface attribute. You can specify only one attribute at a time. We have to be careful while using this operation. If we want to modify only "Description" attribute, then we have to pass only description along with networkInterfaceId. If we want to modify "AttachmentId" then only send AttachmentId and deleteOnTermination = false. If we want to modify "Groups" then we have to send groupSet along with networkInterfaceId.
API Reference

Parameters:

networkInterfaceId - The ID of the network interface.

attachmentId - The ID of the network interface attachment.

description - A description for the network interface.

groups - Changes the security groups for the network interface.The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

deleteOnTermination - Indicates whether the network interface is deleted when the instance is terminated.

sourceDestCheck - Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

resetNetworkInterfaceAttribute

@Processor
public void resetNetworkInterfaceAttribute(String networkInterfaceId,
                                                      @Optional
                                                      String sourceDestCheck)

Resets a network interface attribute. You can specify only one attribute at a time.

API Reference

Parameters:: networkInterfaceId - The ID of the network interface.; sourceDestCheck - The source/destination checking attribute. Resets the value to true.

describeNetworkInterfaceAttribute

@Processor
public DescribeNetworkInterfaceAttributeResult describeNetworkInterfaceAttribute(String attribute,
                                                                                            String networkInterfaceId)

Describes a network interface attribute. You can specify only one attribute at a time.

API Reference

Parameters:: attribute - The attribute of the network interface. This parameter is required.; networkInterfaceId - The ID of the network interface.
Returns:: Operational results.

Class EC2Connector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EC2Connector

Method Detail

getConfig

setConfig

createImage

deregisterImage

describeImages

describeImageAttribute

resetImageAttribute

modifyImageAttribute

createKeyPair

importKeyPair

deleteKeyPair

describeKeyPairs

createVolume

attachVolume

deleteVolume

describeVolumes

describeVolumeAttribute

enableVolumeIo

modifyVolumeAttribute

describeVolumeStatus

detachVolume

modifyVolume

describeVolumesModifications

createSnapshot

copySnapshot

deleteSnapshot

describeSnapshots

describeSnapshotAttribute

modifySnapshotAttribute

resetSnapshotAttribute

createTags

deleteTags

describeTags

describeRegions

describeAvailabilityZones

associateIamInstanceProfile

describeIamInstanceProfileAssociations

describeInstanceAttribute

describeInstances

describeInstanceStatus

disassociateIamInstanceProfile

getConsoleOutput

getConsoleScreenshot

getPasswordData

modifyInstanceAttribute

monitorInstances

rebootInstances

replaceIamInstanceProfileAssociation

reportInstanceStatus

resetInstanceAttribute

startInstances

stopInstances

terminateInstances

unmonitorInstances

runInstances

createSecurityGroup

describeSecurityGroups

deleteSecurityGroup

authorizeSecurityGroupIngress

revokeSecurityGroupIngress

authorizeSecurityGroupEgress

revokeSecurityGroupEgress

describeSecurityGroupReferences

describeStaleSecurityGroups

allocateAddress

associateAddress

describeAddresses

describeMovingAddresses

disAssociateAddress

moveAddressToVpc

releaseAddress

restoreAddressToClassic

assignIpv6Addresses