Contact Free trial Login

Amazon EC2 Connector 2.3 Reference - Mule 4

Support Category: Select

Configurations


Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when appropriate.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Session Token

String

The session token provided by Amazon STS.

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Role
Parameters
Name Type Description Default Value Required

Role ARN

String

Role ARN that uniquely identifies the role to assume to gain cross-account access.

x

Connection Timeout

Number

Duration (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinity and is not recommended.

50000

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Socket Timeout

Number

Duration (in milliseconds) to transfer data over an established, open connection before the connection times out. A value of 0 means infinity and is not recommended.

50000

Access Key

String

Access key provided by Amazon.

x

Secret Key

String

Secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment. See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

TLS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

Optional proxy host.

Port

Number

Optional proxy port.

Username

String

Optional proxy username.

Password

String

Optional proxy password.

Domain

String

Optional proxy domain.

Workstation

String

Optional proxy workstation.

Operations

Allocate Address

<ec2:allocate-address>

Acquires an elastic IP address. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Domain

String

Set to vpc to allocate the address for use with instances in a VPC. By default, if the Region supports EC2-Classic, this value is standard. Valid values are standard and vpc.

standard

Target Variable

String

Name of a variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Allocate Address Result

Attributes Type

For Configurations

Assign IPv6 Addresses

<ec2:assign-ipv6-addresses>

Assigns one or more IPv6 addresses to the specified network interface. For examples, see Amazon’s API Reference for this operation.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Ipv6 Address Count

Number

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.

Ipv6 Addresses

Array of String

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.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Assign Private IP Addresses

<ec2:assign-private-ip-addresses>

Assigns one or more secondary private IP addresses to the specified network interface. See Amazon’s API Reference for this operation.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

The ID of the network interface.

x

Allow Reassignment

Boolean

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.

false

Private Ip Addresses

Array of String

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.

Secondary Private Ip Address Count

Number

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

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Associate Address

<ec2:associate-address>

Associates an Elastic IP address with an instance or a network interface. Associating an Elastic IP address with an interface in a different network border group is not allowed.

See Amazon’s API reference for this operation.

This operation is idempotent. If you perform the operation more than once, an error is not returned, and each time the Elastic IP address is remapped to the same instance, you might be charged.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

EC2-VPC - The allocation ID. This is required for EC2-VPC.

Allow Reassociation

Boolean

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.

false

Instance Id

String

The ID of the instance.

Network Interface Id

String

EC2-VPC - ID of the network interface.

Private Ip Address

String

EC2-VPC - Primary or secondary private IP address to associate with the Elastic IP address.

Public Ip

String

Elastic IP address. This is required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

Associate IAM Instance Profile

<ec2:associate-iam-instance-profile>

Associates an IAM instance profile with a running or stopped instance. Associating more than one IAM instance profile with an instance is not allowed.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Profile Name

String

Name of the IAM instance profile.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Attach Network Interface

<ec2:attach-network-interface>

Attaches a network interface to an instance. See Amazon’s API Referece for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Device Index

Number

Index of the device for the network interface attachment.

x

Instance Id

String

ID of the instance.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

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 can be attached only to instances that support Amazon EBS encryption. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the EBS volume.

x

Instance Id

String

The ID of the instance.

x

Device

String

The device name to expose to the instance (for example, /dev/sdh or xvdh).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Volume Attachment

Attributes Type

For Configurations

Authorize Security Group Egress

<ec2:authorize-security-group-egress>

(EC2-VPC only) Adds one or more egress rules to a security group to use with a VPC. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The ID of the security group.

x

Cidr Ip

String

The CIDR IPv4 address range.

Ip Protocol

String

The IP protocol name or number.

From Port

Number

The start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

Sets of IP permissions.

Source Security Group Name

String

The name of a destination security group.

Source Security Group Owner Id

String

The AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Authorize Security Group Ingress

<ec2:authorize-security-group-ingress>

Adds one or more ingress rules to a security group. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID or name of the security group. For security groups in a non-default VPC, you must specify the group ID (rather than the Group Name).

Group Name

String

Specifies the name of the security group for EC2-Classic and default VPC.

Cidr Ip

String

IPv4 address range in CIDR format.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number. For icmpv6, specify a set of IP permissions.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

EC2-Classic, default VPC - The name of the source security group.

Source Security Group Owner Id

String

In EC2-Classic, the AWS account number for the source security group, if the source security group is in a different account. You can’t specify this parameter in combination with the CIDR IP address range, IP protocol, Start and End of port range parameters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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

Copies of encrypted EBS snapshots remain encrypted and copies of unencrypted snapshots remain unencrypted. To encrypt unencrypted snapshots, specify thh Encrypted during the copy snapshot operation. Encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK). You can use the KmsKeyId parameter to specify a non-default CMK. To copy an encrypted snapshot that is shared from another account, you must have permissions for the CMK that is used to encrypt the snapshot.

Snapshots that are created by the copySnapshot action have a random volume ID that must not be used for any other purpose.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Source Snapshot Id

String

ID of the EBS snapshot to copy.

x

Source Region

Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

ID of the region that contains the snapshot to copy.

x

Description

String

Description for the EBS snapshot.

Destination Region

String. Enumeration, one of:

  • APNORTHEAST1

  • APNORTHEAST2

  • APSOUTH1

  • APSOUTHEAST1

  • APSOUTHEAST2

  • CACENTRAL1

  • EUCENTRAL1

  • EUWEST1

  • EUWEST2

  • SAEAST1

  • USEAST1

  • USEAST2

  • USWEST1

  • USWEST2

Destination region to use in the PresignedUrl parameter of a copy snapshot operation. The snapshot is copied to the regional endpoint to which you send the HTTP request.

Presigned Url

String

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

Encrypted

Boolean

Specifies whether the destination snapshot should be encrypted.

false

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

Create Image

<ec2:create-image>

Creates an Amazon EBS-backed AMI from a running or stopped instance. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

Instance information.

x

I Name

String

Instance name.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

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.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Key Name

String

Unique name for the key pair.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Key Pair

Attributes Type

For Configurations

Create Network Interface

<ec2:create-network-interface>

Creates a network interface in the specified subnet. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Subnet Id

String

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

x

Description

String

A description for the network interface.

Groups

Array of String

The IDs of one or more security groups.

Ipv6 Address Count

Number

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

Ipv6 Addresses

Array of String

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can’t use this option if you’re specifying a number of IPv6 addresses.

Private Ip Address

String

The primary private IPv4 address of the network interface.

Private Ip Addresses

One or more private IPv4 addresses.

Secondary Private Ip Address Count

Number

The number of secondary private IPv4 addresses to assign to a network interface.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Network Interface

Attributes Type

For Configurations

Create Security Group

<ec2:create-security-group>

Creates a security group. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

ID of the VPC.

Group Name

String

Name of the security group.

x

Description

String

Description for the security group.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

For Configurations

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, but snapshots capture only the data that is written to your EBS volume at the time the snapshot command is issued. Data that is cached by any apps or the operating system is excluded.

Your snapshot should be complete if you can pause file systems on the volume long enough to take the snapshot.

If you can’t pause all file writes to the volume, to ensure a consistent and complete snapshot, do the following:

  1. Unmount the volume from within the instance.

  2. Issue the snapshot command.

  3. Remount the volume.
    You can remount and use your volume while the snapshot status is pending.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the EBS volume.

x

Description

String

Description for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Snapshot

Attributes Type

For Configurations

Create Tags

<ec2:create-tags>

Adds or overwrites one or more tags for the specified Amazon EC2 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.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of IDs of one or more resources to tag. For example, ami-1a2b3c4d.

x

Tags

Array of Tag

List of 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 Mule sets the value to an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Create Volume

<ec2:create-volume>

Creates an EBS volume to attach to an instance that is in the same Availability Zone. The volume is created in the regional endpoint to which you send the HTTP request. 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.

To create encrypted volumes, use the Encrypted parameter. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Availability Zone

String

The Amazon availability zone in which to create the volume.

x

Encrypted

Boolean

Specifies whether to encrypt the volume.

false

Iops

Number

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.

Kms Key Id

String

Full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume.

Size

Number

The size of the volume, in GiBs.

Snapshot Id

String

The snapshot from which to create the volume.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

The volume type.

Standard

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Volume

Attributes Type

For Configurations

Delete Key Pair

<ec2:delete-key-pair>

Removes the public key from Amazon EC2 and deletes the specified key pair. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Key Name

String

Name of the key pair to delete.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Delete Network Interface

<ec2:delete-network-interface>

Deletes the specified network interface. You must detach the network interface before you can delete it. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Delete Security Group

<ec2:delete-security-group>

Deletes a security group. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

The security group ID is required for nondefault VPC.

Group Name

String

For EC2-Classic and default VPC, name of the security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Delete Snapshot

<ec2:delete-snapshot>

Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, which means that only the blocks that changes on the device since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data that is not needed for any other snapshot is removed. This ensures that, no matter which prior snapshots were deleted, all active snapshots 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 de-register the AMI before you can delete the snapshot. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Delete Tags

<ec2:delete-tags>

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags call so you can first determine what tags a resource has. You can then call DeleteTags with the resource ID and the specific tags you want to delete. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resources

Array of String

List of resource IDs, for example: ami-1a2b3c4d. You can specify more than one resource ID.

x

Tags

Array of Tag

List of one or more tags to delete. If you omit the value parameter, Mule deletes the tag regardless of its value. If you specify this parameter with an empty string as the value, Mule deletes the key only if its value is an empty string.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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 might remain in the deleting state for several minutes. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Deregister Image

<ec2:deregister-image>

Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Image Id

String

AMI ID to deregister.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Describe Addresses

<ec2:describe-addresses>

Describes one or more of your Elastic IP addresses. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Allocation Ids

Array of String

For EC2-VPC, one or more allocation IDs.

Filters

Array of Filter

One or more filters. Filter names and values are case-sensitive.

Public Ips

Array of String

For EC2-Classic, one or more Elastic IP addresses.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Address

Attributes Type

For Configurations

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 only the zones for the region you’re currently using. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Zone Names

Array of String

The names of one or more Availability Zones.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Availability Zone

Attributes Type

For Configurations

Describe IAM Instance Profile Associations

<ec2:describe-iam-instance-profile-associations>

Describes your IAM instance profile associations. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Association Ids

Array of String

One or more IAM instance profile associations.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of IAM Instance Profile Association

Attributes Type

For Configurations

Describe Image Attribute

<ec2:describe-image-attribute>

Describes attributes of an AMI. You can specify only one attribute at a time. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

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

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Image Attribute

Attributes Type

For Configurations

Describe Images

<ec2:describe-images>

Describes the images in AWS (AMIs, AKIs, and ARIs). Images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Image

Attributes Type

For Configurations

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:

  • blockDeviceMapping

  • disableApiTermination

  • ebsOptimized, groupSet

  • instanceInitiatedShutdownBehavior

  • instanceType

  • kernel

  • productCodes

  • ramdisk

  • rootDeviceName

  • sourceDestCheck

  • sriovNetSupport

  • userData

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Attribute

String

Instance attribute.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Instance Attribute

Attributes Type

For Configurations

Describe Instance Status

<ec2:describe-instance-status>

Describes the status of one or more instances. By default, only running instances are described, unless otherwise specified. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance Status

Attributes Type

For Configurations

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 don’t specify instance IDs or filters, Amazon EC2 returns information for all instances, which can have a performance impact. If you specify an invalid instance ID, an error is returned.

If you specify an instance that you don’t own, that instance is not included in the returned results.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Reservation

Attributes Type

For Configurations

Describe Key Pairs

<ec2:describe-key-pairs>

Describes one or more of your key pairs. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Key Names

Array of String

One or more key pair names for which the describeKeyPairs service needs to return information. When the list is null or empty, it returns all the available key pairs' information.

Filters

Array of Filter

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Key Pair Info

Attributes Type

For Configurations

Describe Moving Addresses

<ec2:describe-moving-addresses>

Describes the Elastic IP addresses to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Public Ips

Array of String

One or more Elastic IP addresses.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Move Address Status payload and Request ID Attribute attributes

For Configurations

Describe Network Interface Attribute

<ec2:describe-network-interface-attribute>

Describes a network interface attribute. You can specify only one attribute at a time. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Attribute

String

The attribute of the network interface. This parameter is required.

x

Network Interface Id

String

The ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Describe Network Interfaces

<ec2:describe-network-interfaces>

Describes one or more of your network interfaces. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

One or more filters.

Network Interface Ids

Array of String

One or more network interface IDs.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Network Interface

Attributes Type

For Configurations

Describe Regions

<ec2:describe-regions>

Describes one or more regions that are currently available to you. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Region Names

Array of String

The names of one or more regions.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Region

Attributes Type

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs in your account.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Security Group Reference

Attributes Type

For Configurations

Describe Security Groups

<ec2:describe-security-groups>

Describes one or more of your security groups. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Ids

Array of String

One or more security group IDs.

Group Names

Array of String

(EC2-Classic and default VPC only) One or more security group names.

Filters

Array of Filter

One or more filters.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Security Group

Attributes Type

For Configurations

Describe Snapshot Attribute

<ec2:describe-snapshot-attribute>

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the EBS snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to view.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

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

  • Private snapshots owned by another AWS account but for which you have 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.

  • An invalid snapshot ID, an error is returned.

  • A snapshot ID for which you do not have access, it is not included in the returned results.

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

  • 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 you own or to which you have explicit permissions, or all for public snapshots.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Snapshot Ids

Array of String

One or more snapshot IDs.

Owner Ids

Array of String

Returns the snapshots owned by the specified owner.

Restorable By User Ids

Array of String

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

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Snapshot payload and Request ID Attribute attributes

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Vpc Id

String

The ID of the VPC.

x

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Stale Security Group payload and Request ID Attribute attributes

For Configurations

Describe Tags

<ec2:describe-tags>

Describes one or more of the tags for your EC2 resources. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Filters

Array of Filter

one or more filters

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Tag Description

Attributes Type

For Configurations

Describe Volume Attribute

<ec2:describe-volume-attribute>

Describes the specified attribute of the specified volume. You can specify only one attribute at a time. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Attribute Name

Enumeration, one of:

  • AutoEnableIO

  • ProductCodes

The attribute of the volume.

AutoEnableIO

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Describe Volume Status

<ec2:describe-volume-status>

Describes the status of the specified volumes and provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes.

If an issue occurs on the volume’s underlying host, volume performance can be affected. If the volume’s underlying host experiences a power outage or system issue, after the system is restored, data inconsistencies on the volume are possible. Volume events notify you if this occurs. Volume actions notify you if any action must be taken in response to the event. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Volume Status Item payload and Request ID Attribute attributes

For Configurations

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.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

One or more volume IDs.

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Volume payload and Request ID Attribute attributes

For Configurations

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 can be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Ids

Array of String

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

Filters

Array of Filter

One or more filters.

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of Volume Modification payload and Request ID Attribute attributes

For Configurations

Detach Network Interface

<ec2:detach-network-interface>

Detaches a network interface from an instance. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Attachment Id

String

The ID of the network interface.

x

Force

Boolean

Specifies whether to force a detachment.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Detach Volume

<ec2:detach-volume>

Detaches an EBS volume from an instance. You must 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.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

The ID of the volume.

x

Device

String

The device name.

Force

Boolean

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

false

Instance Id

String

The ID of the instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Volume Attachment

Attributes Type

For Configurations

Disassociate Address

<ec2:disassociate-address>

Disassociates an Elastic IP address from the instance or network interface it’s associated with. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Association Id

String

Association ID. Required for EC2-VPC.

Public Ip

String

EC2-Classic Elastic IP address. Required for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Association Id

String

The ID of the IAM instance profile association.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Enable Volume I/O

<ec2:enable-volume-io>

Enables input and output operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Get Console Output

<ec2:get-console-output>

Retrieves console output for the specified instance. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Console Output Result

Attributes Type

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Get Password Data

<ec2:get-password-data>

Retrieves the encrypted administrator password for an instance running Windows. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

The ID of the Windows instance.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Password Data Result

Attributes Type

For Configurations

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. See Amazon’s API reference for this operation.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Key Name

String

A unique name for the key pair.

x

Public Key Material

String

The public key which must be base64-encoded.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Import Key Pair Result

Attributes Type

For Configurations

Modify Image Attribute

<ec2:modify-image-attribute>

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

Name of the attribute to modify.

Operation Type

String

Type of operation.

Value

String

Value of the attribute to modify.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Name of the attribute.

x

Value

String

New value for the attribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Modify Network Interface Attribute

<ec2:modify-network-interface-attribute>

Modifies the specified network interface attribute. You can specify only one attribute at a time. Be careful while using this operation.

  • To modify only the Description attribute, pass only the description along with Network Interface Id.

  • To modify Attachment Id, only send Attachment Id and Delete On Termination set to false.

  • To modify Groups, send groupSet along with Network Interface Id.

See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Attachment Id

String

ID of the network interface attachment.

Description

String

Description for the network interface.

Groups

Array of String

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.

Delete On Termination

Boolean

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

false

Source Dest Check

Boolean

Indicates whether source or 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.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Modify Snapshot Attribute

<ec2:modify-snapshot-attribute>

Adds or removes permission settings for the specified snapshot. You can 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.

You can’t make encrypted snapshots and snapshots with AWS Marketplace product codes public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The snapshot attribute to modify.

CreateVolumePermission

Operation Type

Enumeration, one of:

  • Add

  • Remove

Type of operation to perform to the attribute.

Add

Group Names

Array of String

Group to modify for the snapshot.

User Ids

Array of String

Account ID to modify for the snapshot.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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, it might be possible 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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume to modify.

x

Iops

Number

Target IOPS rate of the volume to modify.

Size

Number

Target size in GiB of the volume to modify.

Volume Type

Enumeration, one of:

  • Standard

  • Io1

  • Gp2

  • Sc1

  • St1

Target EBS volume type of the volume to be modified

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Volume Modification

Attributes Type

For Configurations

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. This behavior prevents 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. It is best to change the default behavior only for boot volumes or for volumes that are stateless or disposable.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Volume Id

String

ID of the volume.

x

Auto Enable IO

Boolean

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

true

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Monitor Instances

<ec2:monitor-instances>

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance Monitoring

Attributes Type

For Configurations

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. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Public Ip

String

The Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Move Address To VPC Result

Attributes Type

For Configurations

Reboot Instances

<ec2:reboot-instances>

Requests a reboot of one or more instances. This operation is asynchronous, meaning that it only queues a request to reboot the specified instances. The operation succeeds 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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Release Address

<ec2:release-address>

Releases the specified Elastic IP address. After an Elastic IP address is released, it is sent to the IP address pool and might be unavailable to you. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Allocation Id

String

Required allocation ID for EC2-VPC.

Public Ip

String

Required Elastic IP address for EC2-Classic.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Association Id

String

ID of the existing IAM instance profile association

x

Profile Name

String

Name of the instance profile to replace.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

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.

See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Reason Codes

Array of String

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

x

Status

String

The status of all instances listed.

x

Description

String

Descriptive text about the health state of your instance.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Reset Image Attribute

<ec2:reset-image-attribute>

Resets an attribute of an AMI to its default value. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI.

x

Attribute

String

Attribute to reset. Currently, you can only reset the launch permission attribute).

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Reset Instance Attribute

<ec2:reset-instance-attribute>

Resets an attribute of an instance to its default value. To reset the kernel or RAM disk, 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 or 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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Id

String

ID of the instance.

x

Attribute

String

Attribute to reset. You can reset only the following attributes:

  • kernel

  • ramdisk

  • sourceDestCheck

To change an instance attribute, use ModifyInstanceAttribute.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Reset Network Interface Attribute

<ec2:reset-network-interface-attribute>

Resets a network interface attribute. You can specify only one attribute at a time. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Source Dest Check

String

Source or destination checking attribute. Resets the value to true.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Reset Snapshot Attribute

<ec2:reset-snapshot-attribute>

Resets permission settings for the specified snapshot. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Snapshot Id

String

ID of the snapshot.

x

Attribute

Enumeration, one of:

  • ProductCodes

  • CreateVolumePermission

The attribute to reset.

CreateVolumePermission

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

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. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Public Ip

String

Elastic IP address.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

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. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

x

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

End of port range for the TCP and UDP protocols, or an ICMP type number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

Name of a destination security group.

Source Security Group Owner Id

String

AWS account number for a destination security group.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Revoke Security Group Ingress

<ec2:revoke-security-group-ingress>

Removes one or more ingress rules from a security group. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Group Id

String

ID of the security group.

Group Name

String

EC2-Classic, default VPC - The name of the security group.

Cidr Ip

String

CIDR IP address range.

Ip Protocol

String

IP protocol name (tcp, udp, icmp) or number.

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP type number.

To Port

Number

The end of port range for the TCP and UDP protocols, or an ICMP code number.

Ip Permissions

Array of IP Permission

A set of IP permissions.

Source Security Group Name

String

For EC2-Classic, default VPC, this is the name of the source security group.

Source Security Group Owner Id

String

For EC2-Classic, this is the AWS account ID of the source security group, if the source security group is in a different account.

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Run Instances

<ec2:run-instances>

Launches the specified number of instances of an AMI for which you have permissions. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Image Id

String

ID of the AMI, which you can get by calling describe-images.

x

Min Count

Number

Minimum number of instances to launch.

1

Max Count

Number

Maximum number of instances to launch.

1

Security Groups

Array of String

One or more security group names.

Security Group Ids

Array of String

One or more security group IDs.

Keyname

String

Name of the key pair.

Subnet Id

String

ID of the subnet to launch the instance into.

Instance Type

String

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Reservation

Attributes Type

For Configurations

Start Instances

<ec2:start-instances>

Starts an Amazon EBS-backed AMI that you’ve previously stopped. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance State Change

Attributes Type

For Configurations

Stop Instances

<ec2:stop-instances>

Stops an Amazon EBS-backed instance. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Force

Boolean

Forces the instances to stop.

false

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance State Change

Attributes Type

For Configurations

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 remain visible after termination (approximately one hour). See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance State Change

Attributes Type

For Configurations

Unassign IPv6 Addresses

<ec2:unassign-ipv6-addresses>

Unassigns one or more IPv6 addresses from a network interface. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface.

x

Network Interface Id

String

ID of the network interface.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Unassign Private IP Addresses

<ec2:unassign-private-ip-addresses>

Unassigns one or more secondary private IP addresses from a network interface. See Amazon’s API Reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Network Interface Id

String

ID of the network interface.

x

Private Ip Addresses

Array of String

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

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

For Configurations

Unmonitor Instances

<ec2:unmonitor-instances>

Disables detailed monitoring for a running instance. See Amazon’s API reference for this operation.

Amazon EC2 Connector supports only the following parameters for this operation:

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Instance Ids

Array of String

One or more instance IDs.

x

Target Variable

String

Name of the variable in which to store the operation’s output.

Target Value

String

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Instance Monitoring

Attributes Type

For Configurations

Types

Amazon EC2 Connector supports only the types that are documented.

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location of the truststore, which is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, which makes connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location of the keystore, which is resolved relative to the current classpath and file system, if possible.

Type

String

The type of keystore used.

Alias

String

When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Allocate Address Result

Field Type Description Default Value Required

Allocation Id

String

Assigned allocation ID that represents the allocation of the Elastic IP address used with instances in a VPC.

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard).

Public Ip

String

Elastic IP address.

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Request ID included in the response

Assign IPv6 Addresses Result

Field Type Description Default Value Required

Assigned Ipv6 Addresses

Array of String

One or more IPv6 addresses assigned to the specified network interface

Network Interface Id

String

ID of the network interface

IAM Instance Profile Association

Field Type Description Default Value Required

Association Id

String

ID of the association

Iam Instance Profile

Instance Id

String

ID of the instance

State

String

State of the association

Timestamp

DateTime

Time the IAM instance profile was associated with the instance

IAM Instance Profile

Field Type Description Default Value Required

Arn

String

ARN of the instance profile

Id

String

ID of the instance profile

Volume Attachment

Field Type Description Default Value Required

Attach Time

DateTime

Timestamp of when the attachment was initiated

Delete On Termination

Boolean

Specifies whether to delete the EBS volume when the instance is terminated

Device

String

Name of the device

Instance Id

String

ID of the instance

State

String

Attachment state of the volume

Volume Id

String

ID of the volume

IP Permission

Field Type Description Default Value Required

From Port

Number

Start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.

Ip Protocol

String

Name of the IP protocol. Valid values include:

  • tcp

  • udp

  • icmp

  • icmpv6

Ipv4 Ranges

Array of String

IPv4 ranges.

Ipv6 Ranges

Array of String

IPv6 ranges.

Prefix List Ids

Array of String

Prefix list IDs.

To Port

Number

End of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

User Id Group Pairs

User ID Group Pair

Field Type Description Default Value Required

Group Id

String

ID of the security group.

Group Name

String

Name of the security group. Use this parameter for a security group in EC2-Classic or a default VPC only.

Peering Status

String

If applicable, status of the VPC peering connection.

User Id

String

AWS account ID.

Vpc Id

String

If applicable, VPC ID for the referenced security group.

Vpc Peering Connection Id

String

VPC peering connection ID, if applicable.

Key Pair

Field Type Description Default Value Required

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Material

String

Key Name

String

Name of the key pair.

Network Interface

Field Type Description Default Value Required

Association

Attachment

Availability Zone

String

Availability zone

Description

String

Description for the network interface

Groups

Array of Group Identifier

Security groups for the network interface

Interface Type

String

Type of network interface

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

AWS account ID of the owner of the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface within the subnet

Private Ip Addresses

Private IPv4 addresses associated with the network interface

Requester Id

String

Entity ID that launched the instance on your behalf

Requester Managed

Boolean

Whether the network interface is managed by AWS

Source Dest Check

Boolean

Specifies whether to validate traffic to or from the instance

Status

String

Status of the network interface

Subnet Id

String

ID of the subnet

Tag Set

Array of Tag

Tags assigned to the network interface

Vpc Id

String

ID of the VPC

Network Interface Association

Field Type Description Default Value Required

Allocation Id

String

Allocation ID

Association Id

String

Association ID

Ip Owner Id

String

Elastic IP address owner ID

Public Dns Name

String

Name of the public DNS

Public Ip

String

Elastic IP address bound to the network interface

Network Interface Attachment

Field Type Description Default Value Required

Attach Time

DateTime

Time the attachment was initiated.

Attachment Id

String

Network interface attachment ID.

Delete On Termination

Boolean

If true, deletes the network interface when the instance is terminated.

Device Index

Number

Device index of the network interface attachment on the instance.

Instance Id

String

ID of the instance.

Instance Owner Id

String

AWS account ID of the instance owner.

Status

String

Attachment state. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

Group Identifier

Field Type Description Default Value Required

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Network Interface Private IP Address

Field Type Description Default Value Required

Association

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address of the network interface.

Private Dns Name

String

Name of the private DNS.

Private Ip Address

String

Private IPv4 address.

Tag

Field Type Description Default Value Required

Key

String

Key of the tag. Tag keys are case-sensitive and have a maximum of 127 Unicode characters. The tag key cannot begin with aws:

Value

String

Value of the tag. Tag values are case-sensitive and have a maximum of 255 Unicode characters.

Private IP Address Specification

Field Type Description Default Value Required

Primary

Boolean

If true, the IPv4 address is the primary private IPv4 address. There can be only one primary IPv4.

Private Ip Address

String

Private IPv4 addresses.

Snapshot

Field Type Description Default Value Required

Data Encryption Key Id

String

Data encryption key identifier for the snapshot.

Description

String

Description of the snapshot.

Encrypted

Boolean

If true, the snapshot is encrypted.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to protect the volume encryption key for the parent volume.

Owner Alias

String

AWS owner alias from the Amazon-maintained list. This is not the AWS account alias that was set using the IAM console.

Owner Id

String

AWS account ID of the snapshot owner.

Progress

String

Percentage of progress of the snapshot.

Snapshot Id

String

ID of the snapshot.

Start Time

DateTime

Time when the snapshot was initiated.

State

String

The state of the snapshot. Valid values include:

  • pending

  • completed

  • error

State Message

String

Displays details about the state of the snapshot to help you diagnose why an error occurs.

Tags

Array of Tag

Tags associated with the snapshot.

Volume Id

String

ID of the volume that was used to create the snapshot.

Volume Size

Number

Size of the volume in GiB.

Volume

Field Type Description Default Value Required

Attachments

Availability Zone

String

Availability zone for the volume.

Create Time

DateTime

Time

Time the creation of the volume is initiated.

Encrypted

Boolean

If true, the volume is encrypted.

Iops

Number

Number of I/O operation per second that the volume supports.

Kms Key Id

String

ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to protect the volume encryption key for the parent volume.

Size

Number

Size of the volume in GiB.

Snapshot Id

String

ID of the snapshot.

State

String

State of the volume. String can be:

  • creating

  • available

  • in-use

  • deleting

Tags

Array of Tag

Tags associated with the volume

Volume Id

String

ID of the volume

Volume Type

String

Volume type. String can be:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

Address

Field Type Description Default Value Required

Allocation Id

String

Allocation ID

Association Id

String

ID of the association of the address with a VPC instance

Domain

String

Specifies whether to use the Elastic IP address with instances in a VPC (vpc) or in EC2-Class (standard)

Instance Id

String

ID of the instance the address is associated with

Network Interface Id

String

ID of the network interface

Network Interface Owner Id

String

ID of the AWS account that owns the network interface

Private Ip Address

String

Private IP address that is associated with the Elastic IP address

Public Ip

String

Elastic IP address

Filter

Field Type Description Default Value Required

Name

String

Name of the filter, which is case-sensitive

Values

Array of String

Filter values, which are case-sensitive

Availability Zone

Field Type Description Default Value Required

Messages

Array of String

Messages about the availability zone

Region Name

String

Name of the region

State

String

State of the availability zone. Valid values include:

  • available

  • information

  • impaired

  • unavailable

Zone Name

String

Name of the availability zone

Image Attribute

Field Type Description Default Value Required

Block Device Mappings

Block device mapping entries.

Description

String

Description for the image.

Image Id

String

ID of the image.

Kernel Id

String

ID of the kernel associated with the image.

Launch Permissions

Launch permissions associated with the AMI.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Ramdisk Id

String

RAM disk associated with the image. This parameter applies only to machine images.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Block Device Mapping

Field Type Description Default Value Required

Device Name

String

Name of the device

Ebs

Used to automatically set up EBS volumes when the instance is launched

No Device

String

Specify a device to suppress in the block device mapping of the AMI

Virtual Name

String

Virtual device name

EBS Block Device

Field Type Description Default Value Required

Delete On Termination

Boolean

If true, the EBS volume is deleted when the instance is terminated

Encrypted

Boolean

Determines whether the encryption state of an EBS volume is changed when it is restored from a backing snapshot

Iops

Number

Number of I/O operations per second the volume supports

Snapshot Id

String

ID of the snapshot

Volume Size

Number

Size of the volume in GiB

Volume Type

String

Type of volume. Valid values include:

  • standard

  • io1

  • io2

  • gp2

  • sc1

  • st1

gp2

Launch Permission

Field Type Description Default Value Required

Group

String

Name of the group

User Id

String

AWS account ID

Product Code

Field Type Description Default Value Required

Product Code Id

String

Product code ID.

Product Code Type

String

Product code type. Valid values include:

  • devpay

  • marketplace

Image

Field Type Description Default Value Required

Architecture

String

Architecture of the image.

Block Device Mappings

Block device mapping entries.

Creation Date

String

Date and time the image was created.

Description

String

Description of the AMI provided when the image was created.

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Hypervisor

String

Hypervisor type of the image.

Image Id

String

AMI ID.

Image Location

String

Location of the AMI.

Image Owner Alias

String

AWS account alias, or AWS account ID of the AMI owner.

Image Type

String

Type of image. Valid values include:

  • machine

  • kernel

  • ramdisk

Kernel Id

String

ID of the kernel associated with the image, if applicable.

Name

String

Name of the AMI provided when the image was created.

Owner Id

String

AWS account ID of the image owner.

Platform

String

For Windows AMIs, this value is set to windows, otherwise, it is left blank.

Product Codes

Array of Product Code

Product codes associated with the AMI.

Public

Boolean

If true, the image has public launch permissions; if false, the image has only implicit and explicit launch permissions.

Ramdisk Id

String

ID of the RAM disk associated with the image. This parameter is applicable only to machine image types.

Root Device Name

String

Device name of the root device volume, for example: /dev/sda1.

Root Device Type

String

Type of root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

String

State of the image.

State Reason

Reason for the state change.

Tags

Array of Tag

Tags associated with the image.

Virtualization Type

String

Type of virtualization of the AMI. Valid values include:

  • hvm

  • paravirtual

State Reason

Field Type Description Default Value Required

Code

String

Reason code for the state change.

Message

String

Message for the state change:

  • Server.InsufficientInstanceCapacity
    There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError
    An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop
    The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown
    The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination
    The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown
    The instance was shut down using the shutdown -h command from the instance.

  • Client.InstanceTerminated
    The instance was terminated or rebooted during AMI creation.

  • Client.InternalError
    Client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound
    Specified snapshot was not found.

  • Client.UserInitiatedHibernate
    Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown
    Instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded
    Limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

Instance Attribute

Field Type Description Default Value Required

Block Device Mappings

Disable Api Termination

Boolean

If the value is true, the instance can’t be terminated using the Amazon EC2 console, CLI, or API. If the value is false, you can terminate the instance using the Amazon EC2 console, CLI, or API.

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

If true, enhanced networking with ENA is enabled.

Groups

Array of Group Identifier

Instance Id

String

ID of the instance

Instance Initiated Shutdown Behavior

String

Specifies whether to stop or terminate the instance when shutdown is initiated from the instance.

Instance Type

String

Type of instance

Kernel Id

String

ID of the kernel associated with the instance

Product Codes

Array of Product Code

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Device name of the root device volume

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

User Data

String

User data.

Instance Block Device Mapping

Field Type Description Default Value Required

Device Name

String

Name of the device

Ebs

EBS Instance Block Device

Field Type Description Default Value Required

Attach Time

DateTime

Timestamp for when the attachment was initiated.

Delete On Termination

Boolean

Whether to delete the instance upon termination.

Status

String

State of the attachment. Valid values include:

  • attaching

  • attached

  • detaching

  • detached

Volume Id

String

ID of the volume.

Instance Status

Field Type Description Default Value Required

Availability Zone

String

Availability zone for the instance

Events

Instance Id

String

ID of the instance

Instance State

Instance Status

System Status

Instance Status Event

Field Type Description Default Value Required

Code

String

Code for the event. Valid values include:

  • instance-reboot

  • system-reboot

  • system-maintenance

  • instance-retirement

  • instance-stop

Description

String

Description of the event.

Not After

DateTime

Specifies the latest scheduled time the event can end.

Not Before

DateTime

Specifies the earliest scheduled time the event can start.

Instance State

Field Type Description Default Value Required

Code

Number

16-bit unsigned integer state code of the instance. Valid values include:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

Name

String

Instance Status Summary

Field Type Description Default Value Required

Details

Status

String

Status of the instance. Valid values include:

  • ok

  • impaired

  • insufficient-data

  • not-applicable

  • initializing

Instance Status Details

Field Type Description Default Value Required

Impaired Since

DateTime

Timestamp of the status check failure.

Name

String

Type of the instance status. Valid value is reachability.

Status

String

Status of the instance. Valid values include:

  • passed

  • failed

  • insufficient-data

  • initializing

Reservation

Field Type Description Default Value Required

Group Names

Array of String

Names of the groups

Groups

Array of Group Identifier

Instances

Array of Instance

Owner Id

String

ID of the AWS account that owns the reservation

Requester Id

String

ID of the requester that launched the instances, for example, AWS Management Console

Reservation Id

String

ID of the reservation

Instance

Field Type Description Default Value Required

Ami Launch Index

Number

AMI launch index that to use to find this instance in the launch group

Architecture

String

Image architecture. Valid values include:

  • i386

  • x86_64

  • arm64

Block Device Mappings

Client Token

String

Idempotency token that was provided when the instance was launched

Ebs Optimized

Boolean

Whether to optimize the instance for Amazon EBS I/O. This is not available with all instance types, as there additional usage charges associated with using an EBS Optimized instance.

Ena Support

Boolean

Specifies whether to enable enhanced networking with ENA

Hypervisor

String

Hypervisor type of the instance. Valid values include:

  • ovm

  • xen
    The xen value is used for both Xen and Nitro hypervisors

Iam Instance Profile

Image Id

String

ID of the AMI used to launch the instance

Instance Id

String

ID of the instance

Instance Lifecycle

String

Specifies the lifecycle of the instance. Valid values include:

  • spot

  • scheduled

Instance Type

String

Type of instance. See the Amazon API Reference for valid values.

Kernel Id

String

ID of the kernel associated with the instance

Key Name

String

Name of the key pair associated with the instance

Launch Time

DateTime

Time the instance was launched

Monitoring

String

Monitoring for the instance

Network Interfaces

Placement

Platform

String

Valid value is Windows for instances launched on a Windows platform. Otherwise, leave this value blank.

Private Dns Name

String

For IPv4, this is the private DNS hostname assigned to the instance. The DNS hostname can only be used inside the Amazon EC2 network and is not available until the instance is in the running state.

Private Ip Address

String

Private IPv4 address assigned to the instance

Product Codes

Array of Product Code

Product codes attached to the instance

Public Dns Name

String

Public DNS name

Public Ip Address

String

Public IP address assigned to the instance

Ramdisk Id

String

ID of the RAM disk associated with the instance

Root Device Name

String

Name of the root device volume

Root Device Type

String

Type of the root device used by the AMI. Valid values include:

  • ebs

  • instance-store

Security Groups

Array of Group Identifier

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Spot Instance Request Id

String

ID of the request

Sriov Net Support

String

Whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

State

State Reason

State Transition Reason

String

Subnet Id

String

ID of the subnet the instance is running in

Tags

Array of Tag

Virtualization Type

String

Virtualization type of the instance

Vpc Id

String

ID of the VPC the instance is running in

Instance Network Interface

Field Type Description Default Value Required

Association

Attachment

Description

String

Description of the network interface

Groups

Array of Group Identifier

Ipv6 Addresses

Array of String

IPv6 addresses associated with the network interface

Mac Address

String

MAC address of the network interface

Network Interface Id

String

ID of the network interface

Owner Id

String

ID of the AWS account that created the network interface

Private Dns Name

String

Name of the private DNS

Private Ip Address

String

IPv4 address of the network interface that is within the subnet

Private Ip Addresses

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Status

String

Network interface status. Valid values are:

  • available

  • associated

  • attaching

  • in-use

  • detaching

Subnet Id

String

ID of the subnet

Vpc Id

String

ID of the VPC

Instance Network Interface Association

Field Type Description Default Value Required

Ip Owner Id

String

ID of the Elastic IP address owner

Public Dns Name

String

Public DNS name

Public Ip

String

Public IP address or Elastic IP address that is bound to the network interface

Instance Network Interface Attachment

Field Type Description Default Value Required

Attach Time

DateTime

Timestamp of when the attachment was initiated

Attachment Id

String

ID of the network interface attachment

Delete On Termination

Boolean

Specifies whether to delete the instance when it’s terminated

Device Index

Number

Index of the device that is on the instance for the network interface attachment

Status

String

State of the attachment

Instance Private IP Address

Field Type Description Default Value Required

Association

Primary

Boolean

If true, designates this IPv4 address as the primary private IP address of the network interface

Private Dns Name

String

Private IPv4 DNS name

Private Ip Address

String

Private IPv4 address of the network interface

Placement

Field Type Description Default Value Required

Affinity

String

Affinity setting for the instance on the dedicated host

Availability Zone

String

Availability Zone of the instance

Group Name

String

Name of the placement group that contains the instance

Host Id

String

ID of the dedicated host

Tenancy

String

Tenancey of the instance, if the instance is running in a VPC

Key Pair Info

Field Type Description Default Value Required

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

Move Address Status

Field Type Description Default Value Required

Move Status

String

Status of the Elastic IP address to move to the EC2-VPC platform, or to restore to the EC2-Classic platform. Valid values include:

  • movingToVpc

  • restoringToClassic

Public Ip

String

Elastic IP address

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to Buffer size increment, with an upper limit of maxInMemorySize. Default value is 100 instances.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max in Memory Size

Number

The maximum number of instances to keep in memory. If more than that is required, content starts to buffer on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Describe Network Interface Attribute Result

Field Type Description Default Value Required

Attachment

Description

String

Description of the network interface

Groups

Array of Group Identifier

Network Interface Id

String

ID of the network interface

Source Dest Check

Boolean

A value of true means that source or destination checking is enabled. A value of false means that source or destination checking is disabled. The value must be false for an instance that is launched in a VPC to perform NAT.

Region

Field Type Description Default Value Required

Endpoint

String

Endpoint of the Region service

Region Name

String

Name of the region

Security Group Reference

Field Type Description Default Value Required

Group Id

String

ID of the security group

Referencing Vpc Id

String

ID of the VPC with the referenced security group

Vpc Peering Connection Id

String

ID of the VPC peering connection

Security Group

Field Type Description Default Value Required

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Ip Permissions

Array of IP Permission

Ip Permissions Egress

Array of IP Permission

Owner Id

String

AWS account ID of the security group owner

Tags

Array of Tag

Vpc Id

String

ID of the security group VPC

Describe Snapshot Attribute Result

Field Type Description Default Value Required

Create Volume Permissions

Product Codes

Array of Product Code

Snapshot Id

String

ID of the snapshot

Create Volume Permission

Field Type Description Default Value Required

Group

String

Group to add or remove. Valid value is all.

User Id

String

AWS account ID to add or remove.

Stale Security Group

Field Type Description Default Value Required

Description

String

Description for the security group

Group Id

String

ID of the security group

Group Name

String

Name of the security group

Stale Ip Permissions

Stale Ip Permissions Egress

Vpc Id

String

ID of the security group VPC

Stale IP Permission

Field Type Description Default Value Required

From Port

Number

Start of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

Ip Protocol

String

IP protocol name for tcip, udp, and icmp, or a protocol number. Does not apply to stale security group rules.

Ip Ranges

Array of String

IP ranges. Does not apply to stale security group rules.

Prefix List Ids

Array of String

Prefix list IDs. Does not apply to stale security group rules.

To Port

Number

End of the port range for the TCP and UDP protocols. Can also be an ICMP type number. A value of -1 indicates all ICMP types.

User Id Group Pairs

Tag Description

Field Type Description Default Value Required

Key

String

Tag key

Resource Id

String

ID of the resource

Resource Type

String

Type of the resource

Value

String

Tag value

Describe Volume Attribute Result

Field Type Description Default Value Required

Auto Enable IO

Boolean

State of the autoEnableIO attribute

Product Codes

Array of Product Code

Volume Id

String

ID of the volume

Volume Status Item

Field Type Description Default Value Required

Actions

Details of the operation

Availability Zone

String

Volume’s availability zone

Events

List of events associated with the volume

Volume Id

String

ID of the volume

Volume Status

Status of the volume

Volume Status Action

Field Type Description Default Value Required

Code

String

Code that identifies the operation

Description

String

Description of the operation

Event Id

String

ID of the event associated with the operation

Event Type

String

Type of event associated with the operation

Volume Status Event

Field Type Description Default Value Required

Description

String

Description of the event

Event Id

String

ID of the event

Event Type

String

Type of event

Not After

DateTime

Timestamp for the latest end time of the event

Not Before

DateTime

Timestamp for the earliest start of the event

Volume Status Info

Field Type Description Default Value Required

Details

Status

String

Intended status of the volume status

Volume Status Details

Field Type Description Default Value Required

Name

String

Name of the volume

Status

String

Status of the volume (ok, impaired, insufficient-data)

Volume Modification

Field Type Description Default Value Required

End Time

DateTime

Completion or failure time of the modification.

Modification State

String

Current state of the modification (modifying, optimizing, completed, failed). For unmodified volumes, the state is null.

Original Iops

Number

Original IOPS rate of the volume.

Original Size

Number

Original size of the volume in G1B.

Original Volume Type

String

Original EBS volume type of the volume.

Progress

Number

Progress of the volume modification from 0 to 100 percent complete.

Start Time

DateTime

Start time of the modification.

Status Message

String

Status message about the modification progress.

Target Iops

Number

Target IOPS rate of the volume.

Target Size

Number

Target size of the volume in GiB.

Target Volume Type

String

Target EBS volume type of the volume.

Volume Id

String

ID of the volume.

Get Console Output Result

Field Type Description Default Value Required

Instance Id

String

ID of the instance

Output

String

Base-64-encoded console output

Timestamp

DateTime

Timestamp of when the output was last updated

Get Console Screenshot Result

Field Type Description Default Value Required

Image Data

String

Data that constitutes the image

Instance Id

String

ID of the instance

Get Password Data Result

Field Type Description Default Value Required

Instance Id

String

ID of the Windows instance

Password Data

String

Password of the instance

Timestamp

DateTime

Timestamp of when the data was last updated

Import Key Pair Result

Field Type Description Default Value Required

Key Fingerprint

String

SHA-1 digest of the DER encoded private key if CreateKeyPair was used to create the key pair. If ImportKeyPair was used to create the key pair, this is the MD5 public key fingerprint as described in section 4 of RFC4716.

Key Name

String

Name of the key pair

Instance Monitoring

Field Type Description Default Value Required

Instance Id

String

ID of the instance

Monitoring

String

Monitoring for the instance

Move Address To VPC Result

Field Type Description Default Value Required

Allocation Id

String

Elastic IP address allocation ID

Status

String

Status for the move of the IP address. Valid values include:

  • MoveInProgress

  • InVpc

  • InClassic

Restore Address To Classic Result

Field Type Description Default Value Required

Public Ip

String

Elastic IP address

Status

String

Status of the IP address move

Instance State Change

Field Type Description Default Value Required

Current State

Instance Id

String

ID of the instance

Previous State

Unassign IPv6 Addresses Result

Field Type Description Default Value Required

Network Interface Id

String

ID of the network interface

Unassigned Ipv6 Addresses

Array of String

IPv6 addresses to unassign from the network interface

Exception Throw List - 1

  • EC2:ACTIVE_VPC_PEERING_CONNECTION_PER_VPC_LIMIT_EXCEEDED

  • EC2:ADDRESS_LIMIT_EXCEEDED

  • EC2:ASN_CONFLICT

  • EC2:ATTACHMENT_LIMIT_EXCEEDED

  • EC2:AUTH_FAILURE

  • EC2:BLOCKED

  • EC2:BOOT_FOR_VOLUME_TYPE_UNSUPPORTED

  • EC2:BUNDLING_IN_PROGRESS

  • EC2:CANNOT_DELETE

  • EC2:CIDR_CONFLICT

  • EC2:CONCURRENT_SNAPSHOT_LIMIT_EXCEEDED

  • EC2:CONCURRENT_TAG_ACCESS

  • EC2:CONNECTIVITY

  • EC2:CUSTOMER_GATEWAY_LIMIT_EXCEEDED

  • EC2:CUSTOMER_KEY_HAS_BEEN_REVOKED

  • EC2:DEFAULT_VPC_ALREADY_EXISTS

  • EC2:DELETE_CONVERSION_TASK_ERROR

  • EC2:DEPENDENCY_VIOLATION

  • EC2:DISALLOWED_FOR_DEDICATED_TENANCY_NETWORK

  • EC2:DISK_IMAGE_SIZE_TOO_LARGE

  • EC2:DRY_RUN_OPERATION

  • EC2:EIP_MIGRATED_TO_VPC

  • EC2:ENCRYPTED_VOLUMES_NOT_SUPPORTED

  • EC2:FILTER_LIMIT_EXCEEDED

  • EC2:FLEET_NOT_IN_MODIFIABLE_STATE

  • EC2:FLOW_LOG_ALREADY_EXISTS

  • EC2:FLOW_LOGS_LIMIT_EXCEEDED

  • EC2:GATEWAY_NOT_ATTACHED

  • EC2:HOST_ALREADY_COVERED_BY_RESERVATION

  • EC2:HOST_LIMIT_EXCEEDED

  • EC2:IDEMPOTENT_INSTANCE_TERMINATED

  • EC2:IDEMPOTENT_PARAMETER_MISMATCH

  • EC2:INACCESSIBLE_STORAGE_LOCATION

  • EC2:INCOMPATIBLE_HOST_REQUIREMENTS

  • EC2:INCOMPLETE_SIGNATURE

  • EC2:INCORRECT_INSTANCE_STATE

  • EC2:INCORRECT_STATE

  • EC2:INSTANCE_ALREADY_LINKED

  • EC2:INSTANCE_LIMIT_EXCEEDED

  • EC2:INSUFFICIENT_ADDRESS_CAPACITY

  • EC2:INSUFFICIENT_CAPACITY

  • EC2:INSUFFICIENT_CAPACITY_ON_HOST

  • EC2:INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET

  • EC2:INSUFFICIENT_HOST_CAPACITY

  • EC2:INSUFFICIENT_INSTANCE_CAPACITY

  • EC2:INSUFFICIENT_RESERVED_INSTANCE_CAPACITY

  • EC2:INSUFFICIENT_RESERVED_INSTANCES_CAPACITY

  • EC2:INTERNAL_ERROR

  • EC2:INTERNAL_FAILURE

  • EC2:INTERNET_GATEWAY_LIMIT_EXCEEDED

  • EC2:INVALID_ACTION

  • EC2:INVALID_ADDRESS_ID_NOT_FOUND

  • EC2:INVALID_ADDRESS_LOCKED

  • EC2:INVALID_ADDRESS_MALFORMED

  • EC2:INVALID_ADDRESS_NOT_FOUND

  • EC2:INVALID_AFFINITY

  • EC2:INVALID_ALLOCATION_ID_NOT_FOUND

  • EC2:INVALID_AMI_ATTRIBUTE_ITEM_VALUE

  • EC2:INVALID_AMI_NAME_DUPLICATE

  • EC2:INVALID_AMI_NAME_MALFORMED

  • EC2:INVALID_AMIID_MALFORMED

  • EC2:INVALID_AMIID_NOT_FOUND

  • EC2:INVALID_AMIID_UNAVAILABLE

  • EC2:INVALID_ASSOCIATION_ID_NOT_FOUND

  • EC2:INVALID_ATTACHMENT_ID_NOT_FOUND

  • EC2:INVALID_ATTACHMENT_NOT_FOUND

  • EC2:INVALID_AUTO_PLACEMENT

  • EC2:INVALID_AVAILABILITY_ZONE

  • EC2:INVALID_BLOCK_DEVICE_MAPPING

  • EC2:INVALID_BUNDLE_ID_NOT_FOUND

  • EC2:INVALID_CHARACTER

  • EC2:INVALID_CIDR_IN_USE

  • EC2:INVALID_CLIENT_TOKEN

  • EC2:INVALID_CLIENT_TOKEN_ID

  • EC2:INVALID_CONVERSION_TASK_ID

  • EC2:INVALID_CONVERSION_TASK_ID_MALFORMED

  • EC2:INVALID_CUSTOMER_GATEWAY_DUPLICATE_IP_ADDRESS

  • EC2:INVALID_CUSTOMER_GATEWAY_ID_MALFORMED

  • EC2:INVALID_CUSTOMER_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_CUSTOMER_GATEWAY_STATE

  • EC2:INVALID_DEVICE_IN_USE

  • EC2:INVALID_DHCP_OPTION_ID_NOT_FOUND

  • EC2:INVALID_DHCP_OPTIONS_ID_MALFORMED

  • EC2:INVALID_DHCP_OPTIONS_ID_NOT_FOUND

  • EC2:INVALID_EXPORT_TASK_ID_NOT_FOUND

  • EC2:INVALID_FILTER

  • EC2:INVALID_FLOW_LOG_ID_NOT_FOUND

  • EC2:INVALID_FORMAT

  • EC2:INVALID_FPGA_IMAGE_ID_MALFORMED

  • EC2:INVALID_FPGA_IMAGE_ID_NOT_FOUND

  • EC2:INVALID_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_GROUP_DUPLICATE

  • EC2:INVALID_GROUP_ID_MALFORMED

  • EC2:INVALID_GROUP_IN_USE

  • EC2:INVALID_GROUP_NOT_FOUND

  • EC2:INVALID_GROUP_RESERVED

  • EC2:INVALID_HOST_CONFIGURATION

  • EC2:INVALID_HOST_ID

  • EC2:INVALID_HOST_ID_MALFORMED

  • EC2:INVALID_HOST_ID_NOT_FOUND

  • EC2:INVALID_HOST_RESERVATION_ID_MALFORMED

  • EC2:INVALID_HOST_RESERVATION_OFFERING_ID_MALFORMED

  • EC2:INVALID_HOST_STATE

  • EC2:INVALID_ID

  • EC2:INVALID_INPUT

  • EC2:INVALID_INSTANCE_ATTRIBUTE_VALUE

  • EC2:INVALID_INSTANCE_FAMILY

  • EC2:INVALID_INSTANCE_ID

  • EC2:INVALID_INSTANCE_ID_MALFORMED

  • EC2:INVALID_INSTANCE_ID_NOT_FOUND

  • EC2:INVALID_INSTANCE_ID_NOT_LINKABLE

  • EC2:INVALID_INSTANCE_STATE

  • EC2:INVALID_INSTANCE_TYPE

  • EC2:INVALID_INTERFACE_IP_ADDRESS_LIMIT_EXCEEDED

  • EC2:INVALID_INTERNET_GATEWAY_ID_MALFORMED

  • EC2:INVALID_INTERNET_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_IP_ADDRESS_IN_USE

  • EC2:INVALID_KEY_FORMAT

  • EC2:INVALID_KEY_PAIR_DUPLICATE

  • EC2:INVALID_KEY_PAIR_FORMAT

  • EC2:INVALID_KEY_PAIR_NOT_FOUND

  • EC2:INVALID_MANIFEST

  • EC2:INVALID_MAX_RESULTS

  • EC2:INVALID_NAT_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_ACL_ENTRY_NOT_FOUND

  • EC2:INVALID_NETWORK_ACL_ID_MALFORMED

  • EC2:INVALID_NETWORK_ACL_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_INTERFACE_ATTACHMENT_ID_MALFORMED

  • EC2:INVALID_NETWORK_INTERFACE_ID_MALFORMED

  • EC2:INVALID_NETWORK_INTERFACE_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_INTERFACE_IN_USE

  • EC2:INVALID_NEXT_TOKEN

  • EC2:INVALID_OPTION_CONFLICT

  • EC2:INVALID_PAGINATION_TOKEN

  • EC2:INVALID_PARAMETER

  • EC2:INVALID_PARAMETER_COMBINATION

  • EC2:INVALID_PARAMETER_VALUE

  • EC2:INVALID_PERMISSION_DUPLICATE

  • EC2:INVALID_PERMISSION_MALFORMED

  • EC2:INVALID_PERMISSION_NOT_FOUND

  • EC2:INVALID_PLACEMENT_GROUP_DUPLICATE

  • EC2:INVALID_PLACEMENT_GROUP_IN_USE

  • EC2:INVALID_PLACEMENT_GROUP_UNKNOWN

  • EC2:INVALID_POLICY_DOCUMENT

  • EC2:INVALID_PREFIX_LIST_ID_MALFORMED

  • EC2:INVALID_PREFIX_LIST_ID_NOT_FOUND

  • EC2:INVALID_PRODUCT_INFO

  • EC2:INVALID_PURCHASE_TOKEN_EXPIRED

  • EC2:INVALID_PURCHASE_TOKEN_MALFORMED

  • EC2:INVALID_QUANTITY

  • EC2:INVALID_QUERY_PARAMETER

  • EC2:INVALID_REGION

  • EC2:INVALID_REQUEST

  • EC2:INVALID_RESERVATION_ID_MALFORMED

  • EC2:INVALID_RESERVATION_ID_NOT_FOUND

  • EC2:INVALID_RESERVED_INSTANCES_ID

  • EC2:INVALID_RESERVED_INSTANCES_OFFERING_ID

  • EC2:INVALID_RESOURCE_TYPE_UNKNOWN

  • EC2:INVALID_ROUTE_INVALID_STATE

  • EC2:INVALID_ROUTE_MALFORMED

  • EC2:INVALID_ROUTE_NOT_FOUND

  • EC2:INVALID_ROUTE_TABLE_ID_MALFORMED

  • EC2:INVALID_ROUTE_TABLE_ID_NOT_FOUND

  • EC2:INVALID_SCHEDULED_INSTANCE

  • EC2:INVALID_SECURITY_GROUP_ID_NOT_FOUND

  • EC2:INVALID_SECURITY_REQUEST_HAS_EXPIRED

  • EC2:INVALID_SERVICE_NAME

  • EC2:INVALID_SNAPSHOT_ID_MALFORMED

  • EC2:INVALID_SNAPSHOT_IN_USE

  • EC2:INVALID_SNAPSHOT_NOT_FOUND

  • EC2:INVALID_SPOT_DATAFEED_NOT_FOUND

  • EC2:INVALID_SPOT_FLEET_REQUEST_CONFIG

  • EC2:INVALID_SPOT_FLEET_REQUEST_ID_MALFORMED

  • EC2:INVALID_SPOT_FLEET_REQUEST_ID_NOT_FOUND

  • EC2:INVALID_SPOT_INSTANCE_REQUEST_ID_MALFORMED

  • EC2:INVALID_SPOT_INSTANCE_REQUEST_ID_NOT_FOUND

  • EC2:INVALID_STATE

  • EC2:INVALID_STATE_TRANSITION

  • EC2:INVALID_SUBNET

  • EC2:INVALID_SUBNET_CONFLICT

  • EC2:INVALID_SUBNET_ID_NOT_FOUND

  • EC2:INVALID_SUBNET_RANGE

  • EC2:INVALID_TARGET_ARN_UNKNOWN

  • EC2:INVALID_TENANCY

  • EC2:INVALID_TIME

  • EC2:INVALID_USER_ID_MALFORMED

  • EC2:INVALID_VOLUME_ID_DUPLICATE

  • EC2:INVALID_VOLUME_ID_MALFORMED

  • EC2:INVALID_VOLUME_ID_ZONE_MISMATCH

  • EC2:INVALID_VOLUME_NOT_FOUND

  • EC2:INVALID_VOLUME_ZONE_MISMATCH

  • EC2:INVALID_VPC_ENDPOINT_ID_MALFORMED

  • EC2:INVALID_VPC_ENDPOINT_ID_NOT_FOUND

  • EC2:INVALID_VPC_ID_MALFORMED

  • EC2:INVALID_VPC_ID_NOT_FOUND

  • EC2:INVALID_VPC_PEERING_CONNECTION_ID_MALFORMED

  • EC2:INVALID_VPC_PEERING_CONNECTION_ID_NOT_FOUND

  • EC2:INVALID_VPC_PEERING_CONNECTION_STATE_DNS_HOSTNAMES_DISABLED

  • EC2:INVALID_VPC_RANGE

  • EC2:INVALID_VPC_STATE

  • EC2:INVALID_VPN_CONNECTION_ID

  • EC2:INVALID_VPN_CONNECTION_ID_NOT_FOUND

  • EC2:INVALID_VPN_CONNECTION_INVALID_STATE

  • EC2:INVALID_VPN_CONNECTION_INVALID_TYPE

  • EC2:INVALID_VPN_GATEWAY_ATTACHMENT_NOT_FOUND

  • EC2:INVALID_VPN_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_VPN_GATEWAY_STATE

  • EC2:INVALID_ZONE_NOT_FOUND

  • EC2:KEY_PAIR_LIMIT_EXCEEDED

  • EC2:LEGACY_SECURITY_GROUP

  • EC2:LIMIT_PRICE_EXCEEDED

  • EC2:MALFORMED_QUERY_STRING

  • EC2:MAX_IOPS_LIMIT_EXCEEDED

  • EC2:MAX_SCHEDULED_INSTANCE_CAPACITY_EXCEEDED

  • EC2:MAX_SPOT_FLEET_REQUEST_COUNT_EXCEEDED

  • EC2:MAX_SPOT_INSTANCE_COUNT_EXCEEDED

  • EC2:MISSING_ACTION

  • EC2:MISSING_AUTHENTICATION_TOKEN

  • EC2:MISSING_INPUT

  • EC2:MISSING_PARAMETER

  • EC2:NAT_GATEWAY_LIMIT_EXCEEDED

  • EC2:NAT_GATEWAY_MALFORMED

  • EC2:NAT_GATEWAY_NOT_FOUND

  • EC2:NETWORK_ACL_ENTRY_ALREADY_EXISTS

  • EC2:NETWORK_ACL_ENTRY_LIMIT_EXCEEDED

  • EC2:NETWORK_ACL_LIMIT_EXCEEDED

  • EC2:NETWORK_INTERFACE_LIMIT_EXCEEDED

  • EC2:NO_SUCH_VERSION

  • EC2:NON_EBS_INSTANCE

  • EC2:NOT_EXPORTABLE

  • EC2:OPERATION_NOT_PERMITTED

  • EC2:OPT_IN_REQUIRED

  • EC2:OUTSTANDING_VPC_PEERING_CONNECTION_LIMIT_EXCEEDED

  • EC2:PENDING_SNAPSHOT_LIMIT_EXCEEDED

  • EC2:PENDING_VERIFICATION

  • EC2:PENDING_VPC_PEERING_CONNECTION_LIMIT_EXCEEDED

  • EC2:PLACEMENT_GROUP_LIMIT_EXCEEDED

  • EC2:PRIVATE_IP_ADDRESS_LIMIT_EXCEEDED

  • EC2:REQUEST_EXPIRED

  • EC2:REQUEST_LIMIT_EXCEEDED

  • EC2:REQUEST_RESOURCE_COUNT_EXCEEDED

  • EC2:RESERVED_INSTANCES_COUNT_EXCEEDED

  • EC2:RESERVED_INSTANCES_LIMIT_EXCEEDED

  • EC2:RESERVED_INSTANCES_UNAVAILABLE

  • EC2:RESOURCE_ALREADY_ASSIGNED

  • EC2:RESOURCE_ALREADY_ASSOCIATED

  • EC2:RESOURCE_COUNT_EXCEEDED

  • EC2:RESOURCE_COUNT_LIMIT_EXCEEDED

  • EC2:RESOURCE_LIMIT_EXCEEDED

  • EC2:RETRY_EXHAUSTED

  • EC2:ROUTE_ALREADY_EXISTS

  • EC2:ROUTE_LIMIT_EXCEEDED

  • EC2:ROUTE_TABLE_LIMIT_EXCEEDED

  • EC2:RULES_PER_SECURITY_GROUP_LIMIT_EXCEEDED

  • EC2:SCHEDULED_INSTANCE_LIMIT_EXCEEDED

  • EC2:SCHEDULED_INSTANCE_PARAMETER_MISMATCH

  • EC2:SCHEDULED_INSTANCE_SLOT_NOT_OPEN

  • EC2:SCHEDULED_INSTANCE_SLOT_UNAVAILABLE

  • EC2:SECURITY_GROUP_LIMIT_EXCEEDED

  • EC2:SECURITY_GROUPS_PER_INSTANCE_LIMIT_EXCEEDED

  • EC2:SECURITY_GROUPS_PER_INTERFACE_LIMIT_EXCEEDED

  • EC2:SERVICE_UNAVAILABLE

  • EC2:SIGNATURE_DOES_NOT_MATCH

  • EC2:SNAPSHOT_COPY_UNSUPPORTED_INTER_REGION

  • EC2:SNAPSHOT_CREATION_PER_VOLUME_RATE_EXCEEDED

  • EC2:SNAPSHOT_LIMIT_EXCEEDED

  • EC2:SUBNET_LIMIT_EXCEEDED

  • EC2:TAG_LIMIT_EXCEEDED

  • EC2:UNAUTHORIZED_OPERATION

  • EC2:UNAVAILABLE

  • EC2:UNAVAILABLE_HOST_REQUIREMENTS

  • EC2:UNKNOWN

  • EC2:UNKNOWN_PARAMETER

  • EC2:UNKNOWN_PRINCIPAL_TYPE_UNSUPPORTED

  • EC2:UNKNOWN_VOLUME_TYPE

  • EC2:UNSUPPORTED

  • EC2:UNSUPPORTED_HOST_CONFIGURATION

  • EC2:UNSUPPORTED_INSTANCE_ATTRIBUTE

  • EC2:UNSUPPORTED_INSTANCE_TYPE_ON_HOST

  • EC2:UNSUPPORTED_OPERATION

  • EC2:UNSUPPORTED_PROTOCOL

  • EC2:UNSUPPORTED_TENANCY

  • EC2:VALIDATION_ERROR

  • EC2:VOLUME_IN_USE

  • EC2:VOLUME_IOPS_LIMIT

  • EC2:VOLUME_LIMIT_EXCEEDED

  • EC2:VOLUME_TYPE_NOT_AVAILABLE_IN_ZONE

  • EC2:VPC_CIDR_CONFLICT

  • EC2:VPC_ENDPOINT_LIMIT_EXCEEDED

  • EC2:VPC_ID_NOT_SPECIFIED

  • EC2:VPC_LIMIT_EXCEEDED

  • EC2:VPC_PEERING_CONNECTION_ALREADY_EXISTS

  • EC2:VPC_PEERING_CONNECTIONS_PER_VPC_LIMIT_EXCEEDED

  • EC2:VPC_RESOURCE_NOT_SPECIFIED

  • EC2:VPN_CONNECTION_LIMIT_EXCEEDED

  • EC2:VPN_GATEWAY_ATTACHMENT_LIMIT_EXCEEDED

  • EC2:VPN_GATEWAY_LIMIT_EXCEEDED

  • EC2:ZONES_MISMATCHED

Exception Throw List - 2

  • EC2:ACTIVE_VPC_PEERING_CONNECTION_PER_VPC_LIMIT_EXCEEDED

  • EC2:ADDRESS_LIMIT_EXCEEDED

  • EC2:ASN_CONFLICT

  • EC2:ATTACHMENT_LIMIT_EXCEEDED

  • EC2:AUTH_FAILURE

  • EC2:BLOCKED

  • EC2:BOOT_FOR_VOLUME_TYPE_UNSUPPORTED

  • EC2:BUNDLING_IN_PROGRESS

  • EC2:CANNOT_DELETE

  • EC2:CIDR_CONFLICT

  • EC2:CONCURRENT_SNAPSHOT_LIMIT_EXCEEDED

  • EC2:CONCURRENT_TAG_ACCESS

  • EC2:CUSTOMER_GATEWAY_LIMIT_EXCEEDED

  • EC2:CUSTOMER_KEY_HAS_BEEN_REVOKED

  • EC2:DEFAULT_VPC_ALREADY_EXISTS

  • EC2:DELETE_CONVERSION_TASK_ERROR

  • EC2:DEPENDENCY_VIOLATION

  • EC2:DISALLOWED_FOR_DEDICATED_TENANCY_NETWORK

  • EC2:DISK_IMAGE_SIZE_TOO_LARGE

  • EC2:DRY_RUN_OPERATION

  • EC2:EIP_MIGRATED_TO_VPC

  • EC2:ENCRYPTED_VOLUMES_NOT_SUPPORTED

  • EC2:FILTER_LIMIT_EXCEEDED

  • EC2:FLEET_NOT_IN_MODIFIABLE_STATE

  • EC2:FLOW_LOG_ALREADY_EXISTS

  • EC2:FLOW_LOGS_LIMIT_EXCEEDED

  • EC2:GATEWAY_NOT_ATTACHED

  • EC2:HOST_ALREADY_COVERED_BY_RESERVATION

  • EC2:HOST_LIMIT_EXCEEDED

  • EC2:IDEMPOTENT_INSTANCE_TERMINATED

  • EC2:IDEMPOTENT_PARAMETER_MISMATCH

  • EC2:INACCESSIBLE_STORAGE_LOCATION

  • EC2:INCOMPATIBLE_HOST_REQUIREMENTS

  • EC2:INCOMPLETE_SIGNATURE

  • EC2:INCORRECT_INSTANCE_STATE

  • EC2:INCORRECT_STATE

  • EC2:INSTANCE_ALREADY_LINKED

  • EC2:INSTANCE_LIMIT_EXCEEDED

  • EC2:INSUFFICIENT_ADDRESS_CAPACITY

  • EC2:INSUFFICIENT_CAPACITY

  • EC2:INSUFFICIENT_CAPACITY_ON_HOST

  • EC2:INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET

  • EC2:INSUFFICIENT_HOST_CAPACITY

  • EC2:INSUFFICIENT_INSTANCE_CAPACITY

  • EC2:INSUFFICIENT_RESERVED_INSTANCE_CAPACITY

  • EC2:INSUFFICIENT_RESERVED_INSTANCES_CAPACITY

  • EC2:INTERNAL_ERROR

  • EC2:INTERNAL_FAILURE

  • EC2:INTERNET_GATEWAY_LIMIT_EXCEEDED

  • EC2:INVALID_ACTION

  • EC2:INVALID_ADDRESS_ID_NOT_FOUND

  • EC2:INVALID_ADDRESS_LOCKED

  • EC2:INVALID_ADDRESS_MALFORMED

  • EC2:INVALID_ADDRESS_NOT_FOUND

  • EC2:INVALID_AFFINITY

  • EC2:INVALID_ALLOCATION_ID_NOT_FOUND

  • EC2:INVALID_AMI_ATTRIBUTE_ITEM_VALUE

  • EC2:INVALID_AMI_NAME_DUPLICATE

  • EC2:INVALID_AMI_NAME_MALFORMED

  • EC2:INVALID_AMIID_MALFORMED

  • EC2:INVALID_AMIID_NOT_FOUND

  • EC2:INVALID_AMIID_UNAVAILABLE

  • EC2:INVALID_ASSOCIATION_ID_NOT_FOUND

  • EC2:INVALID_ATTACHMENT_ID_NOT_FOUND

  • EC2:INVALID_ATTACHMENT_NOT_FOUND

  • EC2:INVALID_AUTO_PLACEMENT

  • EC2:INVALID_AVAILABILITY_ZONE

  • EC2:INVALID_BLOCK_DEVICE_MAPPING

  • EC2:INVALID_BUNDLE_ID_NOT_FOUND

  • EC2:INVALID_CHARACTER

  • EC2:INVALID_CIDR_IN_USE

  • EC2:INVALID_CLIENT_TOKEN

  • EC2:INVALID_CLIENT_TOKEN_ID

  • EC2:INVALID_CONVERSION_TASK_ID

  • EC2:INVALID_CONVERSION_TASK_ID_MALFORMED

  • EC2:INVALID_CUSTOMER_GATEWAY_DUPLICATE_IP_ADDRESS

  • EC2:INVALID_CUSTOMER_GATEWAY_ID_MALFORMED

  • EC2:INVALID_CUSTOMER_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_CUSTOMER_GATEWAY_STATE

  • EC2:INVALID_DEVICE_IN_USE

  • EC2:INVALID_DHCP_OPTION_ID_NOT_FOUND

  • EC2:INVALID_DHCP_OPTIONS_ID_MALFORMED

  • EC2:INVALID_DHCP_OPTIONS_ID_NOT_FOUND

  • EC2:INVALID_EXPORT_TASK_ID_NOT_FOUND

  • EC2:INVALID_FILTER

  • EC2:INVALID_FLOW_LOG_ID_NOT_FOUND

  • EC2:INVALID_FORMAT

  • EC2:INVALID_FPGA_IMAGE_ID_MALFORMED

  • EC2:INVALID_FPGA_IMAGE_ID_NOT_FOUND

  • EC2:INVALID_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_GROUP_DUPLICATE

  • EC2:INVALID_GROUP_ID_MALFORMED

  • EC2:INVALID_GROUP_IN_USE

  • EC2:INVALID_GROUP_NOT_FOUND

  • EC2:INVALID_GROUP_RESERVED

  • EC2:INVALID_HOST_CONFIGURATION

  • EC2:INVALID_HOST_ID

  • EC2:INVALID_HOST_ID_MALFORMED

  • EC2:INVALID_HOST_ID_NOT_FOUND

  • EC2:INVALID_HOST_RESERVATION_ID_MALFORMED

  • EC2:INVALID_HOST_RESERVATION_OFFERING_ID_MALFORMED

  • EC2:INVALID_HOST_STATE

  • EC2:INVALID_ID

  • EC2:INVALID_INPUT

  • EC2:INVALID_INSTANCE_ATTRIBUTE_VALUE

  • EC2:INVALID_INSTANCE_FAMILY

  • EC2:INVALID_INSTANCE_ID

  • EC2:INVALID_INSTANCE_ID_MALFORMED

  • EC2:INVALID_INSTANCE_ID_NOT_FOUND

  • EC2:INVALID_INSTANCE_ID_NOT_LINKABLE

  • EC2:INVALID_INSTANCE_STATE

  • EC2:INVALID_INSTANCE_TYPE

  • EC2:INVALID_INTERFACE_IP_ADDRESS_LIMIT_EXCEEDED

  • EC2:INVALID_INTERNET_GATEWAY_ID_MALFORMED

  • EC2:INVALID_INTERNET_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_IP_ADDRESS_IN_USE

  • EC2:INVALID_KEY_FORMAT

  • EC2:INVALID_KEY_PAIR_DUPLICATE

  • EC2:INVALID_KEY_PAIR_FORMAT

  • EC2:INVALID_KEY_PAIR_NOT_FOUND

  • EC2:INVALID_MANIFEST

  • EC2:INVALID_MAX_RESULTS

  • EC2:INVALID_NAT_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_ACL_ENTRY_NOT_FOUND

  • EC2:INVALID_NETWORK_ACL_ID_MALFORMED

  • EC2:INVALID_NETWORK_ACL_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_INTERFACE_ATTACHMENT_ID_MALFORMED

  • EC2:INVALID_NETWORK_INTERFACE_ID_MALFORMED

  • EC2:INVALID_NETWORK_INTERFACE_ID_NOT_FOUND

  • EC2:INVALID_NETWORK_INTERFACE_IN_USE

  • EC2:INVALID_NEXT_TOKEN

  • EC2:INVALID_OPTION_CONFLICT

  • EC2:INVALID_PAGINATION_TOKEN

  • EC2:INVALID_PARAMETER

  • EC2:INVALID_PARAMETER_COMBINATION

  • EC2:INVALID_PARAMETER_VALUE

  • EC2:INVALID_PERMISSION_DUPLICATE

  • EC2:INVALID_PERMISSION_MALFORMED

  • EC2:INVALID_PERMISSION_NOT_FOUND

  • EC2:INVALID_PLACEMENT_GROUP_DUPLICATE

  • EC2:INVALID_PLACEMENT_GROUP_IN_USE

  • EC2:INVALID_PLACEMENT_GROUP_UNKNOWN

  • EC2:INVALID_POLICY_DOCUMENT

  • EC2:INVALID_PREFIX_LIST_ID_MALFORMED

  • EC2:INVALID_PREFIX_LIST_ID_NOT_FOUND

  • EC2:INVALID_PRODUCT_INFO

  • EC2:INVALID_PURCHASE_TOKEN_EXPIRED

  • EC2:INVALID_PURCHASE_TOKEN_MALFORMED

  • EC2:INVALID_QUANTITY

  • EC2:INVALID_QUERY_PARAMETER

  • EC2:INVALID_REGION

  • EC2:INVALID_REQUEST

  • EC2:INVALID_RESERVATION_ID_MALFORMED

  • EC2:INVALID_RESERVATION_ID_NOT_FOUND

  • EC2:INVALID_RESERVED_INSTANCES_ID

  • EC2:INVALID_RESERVED_INSTANCES_OFFERING_ID

  • EC2:INVALID_RESOURCE_TYPE_UNKNOWN

  • EC2:INVALID_ROUTE_INVALID_STATE

  • EC2:INVALID_ROUTE_MALFORMED

  • EC2:INVALID_ROUTE_NOT_FOUND

  • EC2:INVALID_ROUTE_TABLE_ID_MALFORMED

  • EC2:INVALID_ROUTE_TABLE_ID_NOT_FOUND

  • EC2:INVALID_SCHEDULED_INSTANCE

  • EC2:INVALID_SECURITY_GROUP_ID_NOT_FOUND

  • EC2:INVALID_SECURITY_REQUEST_HAS_EXPIRED

  • EC2:INVALID_SERVICE_NAME

  • EC2:INVALID_SNAPSHOT_ID_MALFORMED

  • EC2:INVALID_SNAPSHOT_IN_USE

  • EC2:INVALID_SNAPSHOT_NOT_FOUND

  • EC2:INVALID_SPOT_DATAFEED_NOT_FOUND

  • EC2:INVALID_SPOT_FLEET_REQUEST_CONFIG

  • EC2:INVALID_SPOT_FLEET_REQUEST_ID_MALFORMED

  • EC2:INVALID_SPOT_FLEET_REQUEST_ID_NOT_FOUND

  • EC2:INVALID_SPOT_INSTANCE_REQUEST_ID_MALFORMED

  • EC2:INVALID_SPOT_INSTANCE_REQUEST_ID_NOT_FOUND

  • EC2:INVALID_STATE

  • EC2:INVALID_STATE_TRANSITION

  • EC2:INVALID_SUBNET

  • EC2:INVALID_SUBNET_CONFLICT

  • EC2:INVALID_SUBNET_ID_NOT_FOUND

  • EC2:INVALID_SUBNET_RANGE

  • EC2:INVALID_TARGET_ARN_UNKNOWN

  • EC2:INVALID_TENANCY

  • EC2:INVALID_TIME

  • EC2:INVALID_USER_ID_MALFORMED

  • EC2:INVALID_VOLUME_ID_DUPLICATE

  • EC2:INVALID_VOLUME_ID_MALFORMED

  • EC2:INVALID_VOLUME_ID_ZONE_MISMATCH

  • EC2:INVALID_VOLUME_NOT_FOUND

  • EC2:INVALID_VOLUME_ZONE_MISMATCH

  • EC2:INVALID_VPC_ENDPOINT_ID_MALFORMED

  • EC2:INVALID_VPC_ENDPOINT_ID_NOT_FOUND

  • EC2:INVALID_VPC_ID_MALFORMED

  • EC2:INVALID_VPC_ID_NOT_FOUND

  • EC2:INVALID_VPC_PEERING_CONNECTION_ID_MALFORMED

  • EC2:INVALID_VPC_PEERING_CONNECTION_ID_NOT_FOUND

  • EC2:INVALID_VPC_PEERING_CONNECTION_STATE_DNS_HOSTNAMES_DISABLED

  • EC2:INVALID_VPC_RANGE

  • EC2:INVALID_VPC_STATE

  • EC2:INVALID_VPN_CONNECTION_ID

  • EC2:INVALID_VPN_CONNECTION_ID_NOT_FOUND

  • EC2:INVALID_VPN_CONNECTION_INVALID_STATE

  • EC2:INVALID_VPN_CONNECTION_INVALID_TYPE

  • EC2:INVALID_VPN_GATEWAY_ATTACHMENT_NOT_FOUND

  • EC2:INVALID_VPN_GATEWAY_ID_NOT_FOUND

  • EC2:INVALID_VPN_GATEWAY_STATE

  • EC2:INVALID_ZONE_NOT_FOUND

  • EC2:KEY_PAIR_LIMIT_EXCEEDED

  • EC2:LEGACY_SECURITY_GROUP

  • EC2:LIMIT_PRICE_EXCEEDED

  • EC2:MALFORMED_QUERY_STRING

  • EC2:MAX_IOPS_LIMIT_EXCEEDED

  • EC2:MAX_SCHEDULED_INSTANCE_CAPACITY_EXCEEDED

  • EC2:MAX_SPOT_FLEET_REQUEST_COUNT_EXCEEDED

  • EC2:MAX_SPOT_INSTANCE_COUNT_EXCEEDED

  • EC2:MISSING_ACTION

  • EC2:MISSING_AUTHENTICATION_TOKEN

  • EC2:MISSING_INPUT

  • EC2:MISSING_PARAMETER

  • EC2:NAT_GATEWAY_LIMIT_EXCEEDED

  • EC2:NAT_GATEWAY_MALFORMED

  • EC2:NAT_GATEWAY_NOT_FOUND

  • EC2:NETWORK_ACL_ENTRY_ALREADY_EXISTS

  • EC2:NETWORK_ACL_ENTRY_LIMIT_EXCEEDED

  • EC2:NETWORK_ACL_LIMIT_EXCEEDED

  • EC2:NETWORK_INTERFACE_LIMIT_EXCEEDED

  • EC2:NO_SUCH_VERSION

  • EC2:NON_EBS_INSTANCE

  • EC2:NOT_EXPORTABLE

  • EC2:OPERATION_NOT_PERMITTED

  • EC2:OPT_IN_REQUIRED

  • EC2:OUTSTANDING_VPC_PEERING_CONNECTION_LIMIT_EXCEEDED

  • EC2:PENDING_SNAPSHOT_LIMIT_EXCEEDED

  • EC2:PENDING_VERIFICATION

  • EC2:PENDING_VPC_PEERING_CONNECTION_LIMIT_EXCEEDED

  • EC2:PLACEMENT_GROUP_LIMIT_EXCEEDED

  • EC2:PRIVATE_IP_ADDRESS_LIMIT_EXCEEDED

  • EC2:REQUEST_EXPIRED

  • EC2:REQUEST_LIMIT_EXCEEDED

  • EC2:REQUEST_RESOURCE_COUNT_EXCEEDED

  • EC2:RESERVED_INSTANCES_COUNT_EXCEEDED

  • EC2:RESERVED_INSTANCES_LIMIT_EXCEEDED

  • EC2:RESERVED_INSTANCES_UNAVAILABLE

  • EC2:RESOURCE_ALREADY_ASSIGNED

  • EC2:RESOURCE_ALREADY_ASSOCIATED

  • EC2:RESOURCE_COUNT_EXCEEDED

  • EC2:RESOURCE_COUNT_LIMIT_EXCEEDED

  • EC2:RESOURCE_LIMIT_EXCEEDED

  • EC2:ROUTE_ALREADY_EXISTS

  • EC2:ROUTE_LIMIT_EXCEEDED

  • EC2:ROUTE_TABLE_LIMIT_EXCEEDED

  • EC2:RULES_PER_SECURITY_GROUP_LIMIT_EXCEEDED

  • EC2:SCHEDULED_INSTANCE_LIMIT_EXCEEDED

  • EC2:SCHEDULED_INSTANCE_PARAMETER_MISMATCH

  • EC2:SCHEDULED_INSTANCE_SLOT_NOT_OPEN

  • EC2:SCHEDULED_INSTANCE_SLOT_UNAVAILABLE

  • EC2:SECURITY_GROUP_LIMIT_EXCEEDED

  • EC2:SECURITY_GROUPS_PER_INSTANCE_LIMIT_EXCEEDED

  • EC2:SECURITY_GROUPS_PER_INTERFACE_LIMIT_EXCEEDED

  • EC2:SERVICE_UNAVAILABLE

  • EC2:SIGNATURE_DOES_NOT_MATCH

  • EC2:SNAPSHOT_COPY_UNSUPPORTED_INTER_REGION

  • EC2:SNAPSHOT_CREATION_PER_VOLUME_RATE_EXCEEDED

  • EC2:SNAPSHOT_LIMIT_EXCEEDED

  • EC2:SUBNET_LIMIT_EXCEEDED

  • EC2:TAG_LIMIT_EXCEEDED

  • EC2:UNAUTHORIZED_OPERATION

  • EC2:UNAVAILABLE

  • EC2:UNAVAILABLE_HOST_REQUIREMENTS

  • EC2:UNKNOWN

  • EC2:UNKNOWN_PARAMETER

  • EC2:UNKNOWN_PRINCIPAL_TYPE_UNSUPPORTED

  • EC2:UNKNOWN_VOLUME_TYPE

  • EC2:UNSUPPORTED

  • EC2:UNSUPPORTED_HOST_CONFIGURATION

  • EC2:UNSUPPORTED_INSTANCE_ATTRIBUTE

  • EC2:UNSUPPORTED_INSTANCE_TYPE_ON_HOST

  • EC2:UNSUPPORTED_OPERATION

  • EC2:UNSUPPORTED_PROTOCOL

  • EC2:UNSUPPORTED_TENANCY

  • EC2:VALIDATION_ERROR

  • EC2:VOLUME_IN_USE

  • EC2:VOLUME_IOPS_LIMIT

  • EC2:VOLUME_LIMIT_EXCEEDED

  • EC2:VOLUME_TYPE_NOT_AVAILABLE_IN_ZONE

  • EC2:VPC_CIDR_CONFLICT

  • EC2:VPC_ENDPOINT_LIMIT_EXCEEDED

  • EC2:VPC_ID_NOT_SPECIFIED

  • EC2:VPC_LIMIT_EXCEEDED

  • EC2:VPC_PEERING_CONNECTION_ALREADY_EXISTS

  • EC2:VPC_PEERING_CONNECTIONS_PER_VPC_LIMIT_EXCEEDED

  • EC2:VPC_RESOURCE_NOT_SPECIFIED

  • EC2:VPN_CONNECTION_LIMIT_EXCEEDED

  • EC2:VPN_GATEWAY_ATTACHMENT_LIMIT_EXCEEDED

  • EC2:VPN_GATEWAY_LIMIT_EXCEEDED

  • EC2:ZONES_MISMATCHED