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.
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
No |
Mule Version |
3.5.0 or higher |
Configs
Configuration
<ec2:config>
Connection Management
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
accessKey |
The access key provided by Amazon, needed for non anonymous operations |
x |
||
secretKey |
The secrete key provided by Amazon, needed for non anonymous operations |
x |
||
tryDefaultAWSCredentialsProviderChain |
boolean |
Set it to true to try first to obtain credentials from AWS environment. See: http://docs.aws.amazon.com/java-sdk/latest/developer-guide/credentials.html#using-the-default-credential-provider-chain |
|
|
maxConnections |
Sets the maximum number of allowed open HTTP connections. |
50 |
|
|
region |
Region to be set for the amazon EC2 client |
|
Processors
Create image
<ec2:create-image>
Creates an Amazon EBS-backed AMI from a running or stopped instance
XML Sample
<ec2:create-image config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" iName="My server" instanceId="i-1234567890abcdef0">
</ec2:create-image>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
instance information |
x |
||
iName |
instance name |
x |
Deregister image
<ec2:deregister-image>
Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.
XML Sample
<ec2:deregister-image config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" imageId="ami-5731123e">
</ec2:deregister-image>Describe images
<ec2:describe-images>
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.
XML Sample
<ec2:describe-images config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
</ec2:describe-images>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Describe image attribute
<ec2:describe-image-attribute>
Describes an attributes of an AMI. You can specify only one attribute at a time
XML Sample
<ec2:describe-image-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" imageId="ami-5731123e" attribute="launchPermission">
</ec2:describe-image-attribute>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
imageId |
The ID of the AMI. |
x |
||
attribute |
The attribute to reset (currently you can only reset the launch permission attribute). |
|
Reset image attribute
<ec2:reset-image-attribute>
Resets an attribute of an AMI to its default value.
XML Sample
<ec2:reset-image-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attribute="launchPermission" imageId="ami-61a54008" >
</ec2:reset-image-attribute>Modify image attribute
<ec2:modify-image-attribute>
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
XML Sample
<ec2:modify-image-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attribute="launchPermission" imageId="ami-61a54008" operationType="add" value="all">
</ec2:modify-image-attribute>Create key pair
<ec2:create-key-pair>
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.
XML Sample
<ec2:create-key-pair config-ref="Amazon_EC2" keyName="samplekeypair"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
keyName |
A unique name for the key pair. |
x |
Returns
| Return Java Type | Description |
|---|---|
CreateKeyPairResult which has the KeyPair that got created. |
Import key pair
<ec2:import-key-pair>
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.
XML Sample
<ec2:import-key-pair config-ref="Amazon_EC2" keyName="testkeypair" publicKeyMaterial="MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCCjXHCbGTaL/mPvCr4XrLjGsKiV5Szs8hISYZ9
cL2MTQJwNEH+XFgqMNqieAvJFB39JXZ8pNgxPIZ70KACc2wyNSENIV7024J4pHdgaNW+kmwrKxCm
SFzjLDt9Y/IzTexA7bvRUEOZReh17zash55QHYC5c4BVk6juG3FZazd68wIDAQAB" />Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
keyName |
A unique name for the key pair. |
x |
||
publicKeyMaterial |
The public key which must be base64-encoded. |
x |
Returns
| Return Java Type | Description |
|---|---|
ImportKeyPairResult which contains the KeyName and KeyFingerPrint |
Delete key pair
<ec2:delete-key-pair>
Deletes the specified key pair, by removing the public key from Amazon EC2.
XML Sample
<ec2:delete-key-pair config-ref="Amazon_EC2" keyName="samplekeypair"/>Describe key pairs
<ec2:describe-key-pairs>
Describes one or more of your key pairs.
XML Sample
<ec2:describe-key-pairs config-ref="Amazon_EC2">
<ec2:key-names ref="keyNames"/>
<ec2:filters ref="filters"/>
</ec2:describe-key-pairs>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
|
||
filters |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeKeyPairsResult which contains the information for KeyPairs |
Create volume
<ec2:create-volume>
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.
XML Sample
<ec2:create-volume config-ref="Amazon_EC2" availabilityZone="us-east-1a" size="100" volumeType="Standard"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
availabilityZone |
The Availability Zone in which to create the volume. |
x |
||
encrypted |
boolean |
Specifies whether the volume should be encrypted. |
false |
|
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. |
Standard |
|
Returns
| Return Java Type | Description |
|---|---|
CreateVolumeResult A simple result wrapper around the Volume object that was sent over the wire. |
Attach volume
<ec2:attach-volume>
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.
XML Sample
<ec2:attach-volume config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240" instanceId="i-00b520f0a9514c8f0" device="/dev/sdh"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the EBS volume. |
x |
||
instanceId |
The ID of the instance. |
x |
||
device |
The device name to expose to the instance (for example, /dev/sdh or xvdh). |
x |
Returns
| Return Java Type | Description |
|---|---|
AttachVolumeResult A simple result wrapper around the VolumeAttachment object that was sent over the wire. |
Delete volume
<ec2:delete-volume>
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.
XML Sample
<ec2:delete-volume config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume. |
x |
Describe volumes
<ec2:describe-volumes>
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.
XML Sample
<ec2:describe-volumes config-ref="Amazon_EC2">
<ec2:volume-ids ref="volumeIds"/>
<ec2:filters ref="filters"/>
</ec2:describe-volumes>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeIds |
One or more volume IDs. |
|
||
filters |
One or more filters. |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeVolumesResult Contains the output of describeVolumes. |
Describe volume attribute
<ec2:describe-volume-attribute>
Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
XML Sample
<ec2:describe-volume-attribute config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240" attributeName="AutoEnableIO"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume. |
x |
||
attributeName |
The attribute of the volume. |
AutoEnableIO |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeVolumeAttributeResult Contains the output of describeVolumeAttribute. |
Enable volume io
<ec2:enable-volume-io>
Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
XML Sample
<ec2:enable-volume-io config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume. |
x |
Modify volume attribute
<ec2:modify-volume-attribute>
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.
XML Sample
<ec2:modify-volume-attribute config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240" autoEnableIO="false"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume. |
x |
||
autoEnableIO |
boolean |
Indicates whether the volume should be auto-enabled for I/O operations. |
true |
|
Describe volume status
<ec2:describe-volume-status>
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.
XML Sample
<ec2:describe-volume-status config-ref="Amazon_EC2">
<ec2:volume-ids ref="volumeIds"/>
<ec2:filters ref="filters"/>
</ec2:describe-volume-status>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeIds |
One or more volume IDs. |
|
||
filters |
One or more filters. |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeVolumeStatusResult Contains the output of describeVolumeStatus. |
Detach volume
<ec2:detach-volume>
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.
XML Sample
<ec2:detach-volume config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume. |
x |
||
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
| Return Java Type | Description |
|---|---|
DetachVolumeResult A simple result wrapper around the VolumeAttachment object that was sent over the wire. |
Modify volume
<ec2:modify-volume>
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.
XML Sample
<ec2:modify-volume config-ref="Amazon_EC2" volumeId="vol-0159db7831e057240" size="20"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the volume to be modified. |
x |
||
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
| Return Java Type | Description |
|---|---|
ModifyVolumeResult Contains the output of modifyVolume. |
Describe volumes modifications
<ec2:describe-volumes-modifications>
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.
XML Sample
<ec2:describe-volumes-modifications config-ref="Amazon_EC2">
<ec2:volume-ids ref="volumeIds"/>
<ec2:filters ref="filters"/>
</ec2:describe-volumes-modifications>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeIds |
One or more volume IDs for which in-progress modifications will be described. |
|
||
filters |
One or more filters. |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeVolumesModificationsResult Contains the output of describeVolumesModifications. |
Create snapshot
<ec2:create-snapshot>
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.
XML Sample
<ec2:create-snapshot config-ref="Amazon_EC2" volumeId="vol-0a25309b1707e85e8" description="Sample snapshot">
</ec2:create-snapshot>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
volumeId |
The ID of the EBS volume. |
x |
||
description |
A description for the snapshot. |
|
Returns
| Return Java Type | Description |
|---|---|
CreateSnapshotResult A simple result wrapper around the Snapshot object that was sent over the wire. |
Copy snapshot
<ec2:copy-snapshot>
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.
XML Sample
<ec2:copy-snapshot config-ref="Amazon_EC2" sourceSnapshotId="snap-090823e688f86cbcd" sourceRegion="USWEST1" description="Copy of the snapshot"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
sourceSnapshotId |
The ID of the EBS snapshot to copy. |
x |
||
sourceRegion |
The ID of the region that contains the snapshot to be copied. |
x |
||
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
| Return Java Type | Description |
|---|---|
CopySnapshotResult Contains the output of copySnapshot. |
Delete snapshot
<ec2:delete-snapshot>
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.
XML Sample
<ec2:delete-snapshot config-ref="Amazon_EC2" snapshotId="snap-090823e688f86cbcd"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snapshotId |
The ID of the EBS snapshot. |
x |
Returns
| Return Java Type | Description |
|---|---|
DeleteSnapshotResult Contains the output of deleteSnapshot. |
Describe snapshots
<ec2:describe-snapshots>
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.
XML Sample
<ec2:describe-snapshots config-ref="Amazon_EC2">
<ec2:snapshot-ids ref="snapshotIds"/>
<ec2:filters ref="filters"/>
</ec2:describe-snapshots>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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
| Return Java Type | Description |
|---|---|
DescribeSnapshotsResult Contains the output of describeSnapshots. |
Describe snapshot attribute
<ec2:describe-snapshot-attribute>
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
XML Sample
<ec2:describe-snapshot-attribute config-ref="Amazon_EC2" snapshotId="snap-090823e688f86cbcd" attribute="ProductCodes"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snapshotId |
The ID of the EBS snapshot. |
x |
||
attribute |
The snapshot attribute you would like to view. |
CreateVolumePermission |
|
Returns
| Return Java Type | Description |
|---|---|
DescribeSnapshotAttributeResult Contains the output of describeSnapshotAttribute. |
Modify snapshot attribute
<ec2:modify-snapshot-attribute>
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.
XML Sample
<ec2:modify-snapshot-attribute config-ref="Amazon_EC2" snapshotId="snap-090823e688f86cbcd" operationType="Remove"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snapshotId |
The ID of the snapshot. |
x |
||
attribute |
The snapshot attribute to modify. |
CreateVolumePermission |
|
|
operationType |
The type of operation to perform to the attribute. |
Add |
|
|
groupNames |
The group to modify for the snapshot. |
|
||
userIds |
The account ID to modify for the snapshot. |
|
Returns
| Return Java Type | Description |
|---|---|
ModifySnapshotAttributeResult Contains the output of modifySnapshotAttribute. |
Reset snapshot attribute
<ec2:reset-snapshot-attribute>
Resets permission settings for the specified snapshot.
XML Sample
<ec2:reset-snapshot-attribute config-ref="Amazon_EC2" snapshotId="snap-090823e688f86cbcd"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
snapshotId |
The ID of the snapshot. |
x |
||
attribute |
The attribute to reset. |
CreateVolumePermission |
|
Returns
| Return Java Type | Description |
|---|---|
ResetSnapshotAttributeResult Contains the output of resetSnapshotAttribute. |
Create tags
<ec2:create-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.
XML Sample
<ec2:create-tags config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:resources>
<ec2:resource>i-1234567890abcdef0</ec2:resource>
<ec2:resource>ami-1a2b3c4d</ec2:resource>
</ec2:resources>
<ec2:tags>
<ec2:tag key="stack" value="Production"/>
</ec2:tags>
</ec2:create-tags>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
resources |
(list) The IDs of one or more resources to tag. For example, ami-1a2b3c4d. |
x |
||
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. |
x |
Delete tags
<ec2:delete-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.
XML Sample
<ec2:delete-tags config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:resources>
<ec2:resource>ami-1a2b3c4d</ec2:resource>
<ec2:resource>i-1234567890abcdef0</ec2:resource>
</ec2:resources>
<ec2:tags>
<ec2:tag key="stack" value="Production"/>
</ec2:tags>
</ec2:delete-tags>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
resources |
(list) The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID. |
x |
||
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. |
x |
Describe tags
<ec2:describe-tags>
Describes one or more of the tags for your EC2 resources.
XML Sample
<ec2:describe-tags config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="resource-id">
<ec2:values>
<ec2:value>i-1234567890abcdef8</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
</ec2:describe-tags>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filters |
one or more filters |
|
Describe regions
<ec2:describe-regions>
Describes one or more regions that are currently available to you.
XML Sample
<ec2:describe-regions config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="endpoint">
<ec2:values>
<ec2:value>*us*</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
<ec2:region-names>
<ec2:region-name>us-east-1</ec2:region-name>
</ec2:region-names>
</ec2:describe-regions>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
regionNames |
The names of one or more regions. |
|
||
filters |
One or more filters. |
|
Describe availability zones
<ec2:describe-availability-zones>
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.
XML Sample
<ec2:describe-availability-zones config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="zone-name">
<ec2:values>
<ec2:value>us-east-1a</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
<ec2:zone-names>
<ec2:zone-name>us-east-1a</ec2:zone-name>
</ec2:zone-names>
</ec2:describe-availability-zones>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
zoneNames |
The names of one or more Availability Zones. |
|
||
filters |
One or more filters. |
|
Associate iam instance profile
<ec2:associate-iam-instance-profile>
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
XML Sample
<ec2:associate-iam-instance-profile config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" instanceId="i-0a2b091462b339192" profileName="admin-role"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
The ID of the instance. |
x |
||
profileName |
The NAME of the instance profile. |
x |
Describe iam instance profile associations
<ec2:describe-iam-instance-profile-associations>
Describes your IAM instance profile associations.
XML Sample
<ec2:describe-iam-instance-profile-associations config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:association-ids>
<ec2:association-id>iip-assoc-0d1ec06278d29f44a</ec2:association-id>
</ec2:association-ids>
<ec2:filters>
<ec2:filter name="Instance-Id">
<ec2:values>
<ec2:value>i-0402909a2f4dffd14</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
</ec2:describe-iam-instance-profile-associations>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
associationIds |
One or more IAM instance profile associations. |
|
||
filters |
One or more filters. |
|
Describe instance attribute
<ec2:describe-instance-attribute>
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
XML Sample
<ec2:describe-instance-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attribute="instanceType" instanceId="i-1234567890abcdef0">
</ec2:describe-instance-attribute>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
attribute |
The instance attribute. |
x |
||
instanceId |
The ID of the instance. |
x |
Describe instances
<ec2:describe-instances>
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.
XML Sample
<ec2:describe-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="instance-type">
<ec2:values>
<ec2:value>m1.small</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:describe-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
|
||
filters |
One or more filters. |
|
Describe instance status
<ec2:describe-instance-status>
Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.
XML Sample
<ec2:describe-instance-status config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters ref="filters"/>
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:describe-instance-status>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
|
||
filters |
One or more filters. |
|
Disassociate iam instance profile
<ec2:disassociate-iam-instance-profile>
Disassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.
XML Sample
<ec2:disassociate-iam-instance-profile config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" associationId="iip-assoc-05020b59952902f5f">
</ec2:disassociate-iam-instance-profile>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
associationId |
The ID of the IAM instance profile association. |
x |
Get console output
<ec2:get-console-output>
Retrieves console output for the specified instance.
XML Sample
<ec2:get-console-output config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" instanceId="i-1234567890abcdef0">
</ec2:get-console-output>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
The ID of the instance. |
x |
Get console screenshot
<ec2:get-console-screenshot>
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded.
XML Sample
<ec2:get-console-screenshot config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" instanceId="i-1234567890abcdef0">
</ec2:get-console-screenshot>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
The ID of the instance. |
x |
Get password data
<ec2:get-password-data>
Retrieves the encrypted administrator password for an instance running Windows.
XML Sample
<ec2:get-password-data config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" instanceId="i-1234567890abcdef0">
</ec2:get-password-data>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
The ID of the Windows instance. |
x |
Modify instance attribute
<ec2:modify-instance-attribute>
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.
XML Sample
<ec2:modify-instance-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attribute="instanceType" instanceId="i-1234567890abcdef0" value="m1.small">
</ec2:modify-instance-attribute>Monitor instances
<ec2:monitor-instances>
Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled.
XML Sample
<ec2:monitor-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:monitor-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
Reboot instances
<ec2:reboot-instances>
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.
XML Sample
<ec2:reboot-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:reboot-instances>Replace iam instance profile association
<ec2:replace-iam-instance-profile-association>
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
XML Sample
<ec2:replace-iam-instance-profile-association config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" associationId="iip-assoc-05020b59952902f5f" profileName="replace-admin-role">
</ec2:replace-iam-instance-profile-association>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
associationId |
The ID of the existing IAM instance profile association |
x |
||
profileName |
The NAME of the instance profile to replace. |
x |
Report instance status
<ec2:report-instance-status>
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.
XML Sample
<ec2:report-instance-status config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" description="blah..blah" status="unresponsive">
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
<ec2:reason-codes>
<ec2:reason-code>impaired</ec2:reason-code>
</ec2:reason-codes>
</ec2:report-instance-status>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
||
reasonCodes |
One or more reason codes that describes the health state of your instance. |
x |
||
status |
The status of all instances listed. |
x |
||
description |
Descriptive text about the health state of your instance. |
|
Reset instance attribute
<ec2:reset-instance-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.
XML Sample
<ec2:reset-instance-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attribute="kernel" instanceId="i-1234567890abcdef0">
</ec2:reset-instance-attribute>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceId |
The ID of the instance. |
x |
||
attribute |
+++The attribute to reset.You can only reset the following attributes: kernel |
ramdisk |
sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.+ |
Start instances
<ec2:start-instances>
Starts an Amazon EBS-backed AMI that you've previously stopped.
XML Sample
<ec2:start-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:start-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
Returns
| Return Java Type | Description |
|---|---|
StartInstancesResult Contains the output of StartInstances |
Stop instances
<ec2:stop-instances>
Stops an Amazon EBS-backed instance.
XML Sample
<ec2:stop-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" force="true">
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:stop-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
||
force |
Forces the instances to stop. |
|
Returns
| Return Java Type | Description |
|---|---|
StopInstancesResult Contains the output of StopInstances. |
Terminate instances
<ec2:terminate-instances>
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).
XML Sample
<ec2:terminate-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:terminate-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
Unmonitor instances
<ec2:unmonitor-instances>
Disables detailed monitoring for a running instance.
XML Sample
<ec2:unmonitor-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:instance-ids>
<ec2:instance-id>i-1234567890abcdef0</ec2:instance-id>
</ec2:instance-ids>
</ec2:unmonitor-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
instanceIds |
One or more instance IDs. |
x |
Run instances
<ec2:run-instances>
Launches the specified number of instances of an AMI for which you have permissions.
XML Sample
<ec2:run-instances config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" imageId="ami-52d7b544" keyname="MyKeyPair">
</ec2:run-instances>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
imageId |
The ID of the AMI, which you can get by calling describe-images |
x |
||
minCount |
The minimum no of instances to launch |
1 |
|
|
maxCount |
The maximum no of instances to launch |
1 |
|
|
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. |
|
||
instanceType |
|
Create security group
<ec2:create-security-group>
Creates a security group.
XML Sample
<ec2:create-security-group config-ref="Amazon_EC2" vpcId="vpc-b3f03bca" groupName="test group 1" description="test group 1"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
vpcId |
The ID of the VPC. |
|
||
groupName |
The name of the security group. |
x |
||
description |
A description for the security group. |
x |
Returns
| Return Java Type | Description |
|---|---|
CreateSecurityGroupResult Contains the output of CreateSecurityGroup. |
Describe security groups
<ec2:describe-security-groups>
Describes one or more of your security groups.
XML Sample
<ec2:describe-security-groups config-ref="Amazon_EC2">
<ec2:group-ids ref="groupIds"/>
<ec2:filters ref="filters"/>
</ec2:describe-security-groups>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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
| Return Java Type | Description |
|---|---|
DescribeSecurityGroupsResult Contains the output of DescribeSecurityGroups. |
Delete security group
<ec2:delete-security-group>
Deletes a security group.
XML Sample
<ec2:delete-security-group config-ref="Amazon_EC2" groupId="sg-02d9ef7c"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupId |
The ID of the security group. |
|
||
groupName |
[EC2-Classic, default VPC] The name of the security group. |
|
Authorize security group ingress
<ec2:authorize-security-group-ingress>
Adds one or more ingress rules to a security group.
XML Sample
<ec2:authorize-security-group-ingress config-ref="Amazon_EC2" groupId="sg-b3efe3cd" cidrIp="10.0.0.0/16" ipProtocol="tcp" fromPort="25" toPort="30"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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
| Return Java Type | Description |
|---|---|
AuthorizeSecurityGroupIngressResult |
Revoke security group ingress
<ec2:revoke-security-group-ingress>
Removes one or more ingress rules from a security group.
XML Sample
<ec2:revoke-security-group-ingress config-ref="Amazon_EC2" groupId="sg-02d9ef7c" cidrIp="10.0.0.0/16" ipProtocol="tcp" fromPort="25" toPort="30"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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
| Return Java Type | Description |
|---|---|
RevokeSecurityGroupIngressResult |
Authorize security group egress
<ec2:authorize-security-group-egress>
[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.
XML Sample
<ec2:authorize-security-group-egress config-ref="Amazon_EC2" groupId="sg-b3efe3cd">
<ec2:ip-permissions ref="ipPermissions"/>
</ec2:authorize-security-group-egress>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupId |
The ID of the security group. |
x |
||
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
| Return Java Type | Description |
|---|---|
AuthorizeSecurityGroupEgressResult |
Revoke security group egress
<ec2:revoke-security-group-egress>
[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.
XML Sample
<ec2:revoke-security-group-egress config-ref="Amazon_EC2" groupId="sg-2d6f6e53">
<ec2:ip-permissions ref="ipPermissions" />
</ec2:revoke-security-group-egress>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupId |
The ID of the security group. |
x |
||
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
| Return Java Type | Description |
|---|---|
RevokeSecurityGroupEgressResult |
Describe security group references
<ec2:describe-security-group-references>
[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.
XML Sample
<ec2:describe-security-group-references config-ref="Amazon_EC2">
<ec2:group-ids ref="groupIds" />
</ec2:describe-security-group-references>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupIds |
One or more security group IDs in your account. |
x |
Returns
| Return Java Type | Description |
|---|---|
DescribeSecurityGroupReferencesResult Contains the output of DescribeSecurityGroupReferences. |
Describe stale security groups
<ec2:describe-stale-security-groups>
[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.
XML Sample
<ec2:describe-stale-security-groups config-ref="Amazon_EC2" vpcId="vpc-dfb36ea6"/>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
vpcId |
The ID of the VPC. |
x |
Returns
| Return Java Type | Description |
|---|---|
DescribeStaleSecurityGroupsResult Contains the output of DescribeStaleSecurityGroups. |
Allocate address
<ec2:allocate-address>
Acquires an Elastic IP address.
XML Sample
<ec2:allocate-address config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" domain="vpc">
</ec2:allocate-address>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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+++ |
Associate address
<ec2:associate-address>
Associates an Elastic IP address with an instance or a network interface.
XML Sample
<ec2:associate-address config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" instanceId="i-07ffe74c7330ebf53" publicIp="198.51.100.0">
</ec2:associate-address>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
|
Describe addresses
<ec2:describe-addresses>
Describes one or more of your Elastic IP addresses.
XML Sample
<ec2:describe-addresses config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:allocation-ids>
<ec2:allocation-id>eipalloc-282d9641</ec2:allocation-id>
</ec2:allocation-ids>
<ec2:filters>
<ec2:filter name="domain">
<ec2:values>
<ec2:value>standard</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
</ec2:describe-addresses>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
|
Describe moving addresses
<ec2:describe-moving-addresses>
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.
XML Sample
<ec2:describe-moving-addresses config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="moving-status">
<ec2:values>
<ec2:value>MovingToVpc</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
</ec2:describe-moving-addresses>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
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. |
|
Dis associate address
<ec2:dis-associate-address>
Disassociates an Elastic IP address from the instance or network interface it's associated with.
Move address to vpc
<ec2:move-address-to-vpc>
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.
XML Sample
<ec2:move-address-to-vpc config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" publicIp="54.123.4.56">
</ec2:move-address-to-vpc>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
publicIp |
The Elastic IP address. |
x |
Release address
<ec2:release-address>
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
XML Sample
<ec2:release-address config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" publicIp="198.51.100.0" allocationId="eipalloc-64d5890a">
</ec2:release-address>Restore address to classic
<ec2:restore-address-to-classic>
Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform.
XML Sample
<ec2:restore-address-to-classic config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" publicIp="198.51.100.0" >
</ec2:restore-address-to-classic>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
publicIp |
The Elastic IP address |
x |
Assign ipv6 addresses
<ec2:assign-ipv6-addresses>
Assigns one or more IPv6 addresses to the specified network interface.
XML Sample
<ec2:assign-ipv6-addresses config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" ipv6AddressCount="2" networkInterfaceId="eni-38664473">
<ec2:ipv6-addresses>
<ec2:ipv6-address>2001:db8:1234:1a00:3304:8879:34cf:4071</ec2:ipv6-address>
<ec2:ipv6-address>2001:db8:1234:1a00:9691:9503:25ad:1761</ec2:ipv6-address>
</ec2:ipv6-addresses>
</ec2:assign-ipv6-addresses>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
||
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. |
|
Unassign ipv6 addresses
<ec2:unassign-ipv6-addresses>
Unassigns one or more IPv6 addresses from a network interface.
XML Sample
<ec2:unassign-ipv6-addresses config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attachmentId="eni-attach-66c4350a" description="My description" networkInterfaceId="eni-686ea200" deleteOnTermination="false" >
<ec2:ipv6-addresses>
<ec2:ipv6-address>2001:db8:1234:1a00:3304:8879:34cf:4071</ec2:ipv6-address>
</ec2:ipv6-addresses>
</ec2:unassign-ipv6-addresses>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
ipv6Addresses |
The IPv6 addresses to unassign from the network interface. |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
Assign private ip addresses
<ec2:assign-private-ip-addresses>
Assigns one or more secondary private IP addresses to the specified network interface
XML Sample
<ec2:assign-private-ip-addresses config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" networkInterfaceId="eni-38664473" secondaryPrivateIpAddressCount="2">
<ec2:private-ip-addresses>
<ec2:private-ip-address>10.0.0.82</ec2:private-ip-address>
</ec2:private-ip-addresses>
</ec2:assign-private-ip-addresses>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
||
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. |
|
Un assign private ip addresses
<ec2:un-assign-private-ip-addresses>
Unassigns one or more secondary private IP addresses from a network interface.
Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
||
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. |
x |
Create network interface
<ec2:create-network-interface>
Creates a network interface in the specified subnet.
XML Sample
<ec2:create-network-interface config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" description="my network interface" privateIpAddress="10.0.2.17" subnetId="subnet-9d4a7b6c">
</ec2:create-network-interface>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
subnetId |
The ID of the subnet to associate with the network interface. |
x |
||
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. |
|
Delete network interface
<ec2:delete-network-interface>
Deletes the specified network interface. You must detach the network interface before you can delete it.
XML Sample
<ec2:delete-network-interface config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" networkInterfaceId="eni-e5aa89a3">
</ec2:delete-network-interface>Attach network interface
<ec2:attach-network-interface>
Attaches a network interface to an instance.
XML Sample
<ec2:attach-network-interface config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" networkInterfaceId="eni-38664473" deviceIndex="1" instanceId="i-1234567890abcdef0">
</ec2:attach-network-interface>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
deviceIndex |
The index of the device for the network interface attachment. |
x |
||
instanceId |
The ID of the instance. |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
Detach network interface
<ec2:detach-network-interface>
Detaches a network interface from an instance.
XML Sample
<ec2:detach-network-interface config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attachmentId="eni-attach-66c4350a" force="true">
</ec2:detach-network-interface>Describe network interfaces
<ec2:describe-network-interfaces>
Describes one or more of your network interfaces.
XML Sample
<ec2:describe-network-interfaces config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" >
<ec2:filters>
<ec2:filter name="tag:Purpose">
<ec2:values>
<ec2:value>Prod</ec2:value>
</ec2:values>
</ec2:filter>
</ec2:filters>
<ec2:network-interface-ids>
<ec2:network-interface-id>eni-b9a5ac93</ec2:network-interface-id>
</ec2:network-interface-ids>
</ec2:describe-network-interfaces>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
filters |
One or more filters. |
|
||
networkInterfaceIds |
One or more network interface IDs. |
|
Modify network interface attribute
<ec2:modify-network-interface-attribute>
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.
XML Sample
<ec2:modify-network-interface-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attachmentId="eni-attach-66c4350a" description="My description" networkInterfaceId="eni-686ea200">
<ec2:groups>
<ec2:group>sg-903004f8</ec2:group>
<ec2:group>sg-1a2b3c4d</ec2:group>
</ec2:groups>
</ec2:modify-network-interface-attribute>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
||
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. |
|
Reset network interface attribute
<ec2:reset-network-interface-attribute>
Resets a network interface attribute. You can specify only one attribute at a time.
XML Sample
<ec2:reset-network-interface-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" attachmentId="eni-attach-66c4350a" description="My description" networkInterfaceId="eni-686ea200" deleteOnTermination="false" sourceDestCheck="true">
</ec2:reset-network-interface-attribute>Describe network interface attribute
<ec2:describe-network-interface-attribute>
Describes a network interface attribute. You can specify only one attribute at a time.
XML Sample
<ec2:describe-network-interface-attribute config-ref="Amazon_EC2__Configuration" doc:name="Amazon EC2" networkInterfaceId="eni-e5aa89a3" attribute="attachment">
</ec2:describe-network-interface-attribute>Attributes
| Name | Java Type | Description | Default Value | Required |
|---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
attribute |
The attribute of the network interface. This parameter is required. |
x |
||
networkInterfaceId |
The ID of the network interface. |
x |
Returns
| Return Java Type | Description |
|---|---|