Activities

Add Tag To Resource

This activity adds or overwrites tag for the specified Amazon EC2 resource.

Activity Parameters

The Add Tag To Resource activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Resource ID (text box editor type): enter the resource ID.
Tag Key (text box editor type): enter the tag key. Tag keys are case-sensitive and accept a maximum of 127 Unicode characters.
Tag Value (text box editor type): enter the tag value. Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

The Read Only Output variable is the possible output value that the activity will provide:

Output Execution: outputs the execution status: True for success, False otherwise.

Assign Volume To Instance

This activity assigns a volume to an instance. You can attach an EBS volume to one of your instances that is in the same Availability Zone as the volume.

Activity Parameters

The Assign Volume To Instance activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Device (text box editor type): enter the device name as exposed to the instance, for example /dev/sdh or xvdh.
Instance Id (text box editor type): enter the ID of the instance.
Volume Id (text box editor type): enter the ID of the Amazon EBS volume.

The Read Only Output variable is the possible output value that the activity will provide:

Output Execution: outputs the execution status: True for success, False otherwise.

Attach Volume

This activity attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Activity Parameters

The Attach Volume activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Device (text box editor type): enter the device name as exposed to the instance, for example /dev/sdh or xvdh.
Instance Id (text box editor type): enter the ID of the instance to which the volume attaches. The volume and instance must be within the same Availability Zone and the instance must be running.
Volume Id (text box editor type): enter the ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone and the instance must be running.

The Read Only Output variable is the possible output value that the activity will provide:

Output Volume Id: outputs the ID of the newly created volume.

Connect To AmazonEC2

This activity connects to the specified AmazonEC2 account and outputs an AmazonEC2 client connection.

Activity Parameters

The Connect To AmazonEC2 activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Amazon AWS Access Key (text box editor type): enter the Amazon AWS Access Key of your AmazonEC2 account.
Amazon AWS Secret Key (text box editor type): enter the Amazon AWS Secret Key of your AmazonEC2 account.
Region (text box editor type): choose the account region.

The Read Only Output variable is the possible output value that the activity will provide:

Output: outputs an Amazon EC2 connection. The output of this activity should be used as input for all Connection parameters used for all activities placed under AmazonEc2 category.

Create OS Image

This activity creates an AMI that uses an Amazon EBS root device from a "running" or "stopped" instance. AMIs that use an Amazon EBS root device boot faster than AMIs that use instance stores. They can be up to 1 TB in size, use storage that persists on instance failure, and can be stopped and started.

Activity Parameters

The Create OS Image activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Description (text box editor type): enter the description for the new operating system image.
Instance Id (text box editor type): enter the existing instance ID for the new operating system image.
Name (text box editor type): enter the name for the new operating system image.
No Reboot (text box editor type): by default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the No Reboot option is set, Amazon EC2 does not shut down the instance before creating the image. When this option is used, file system integrity on the created image can not be guaranteed.

The Read Only Output variable is the possible output value that the activity will provide:

Output Image Id: outputs the ID of the newly created operating system image.

Create Instance

This activity creates an Instance that represents a computing resource, such as an Amazon EC2 instance, which handles the work of serving applications, balancing traffic, and so on.

Activity Parameters

The Create Instance activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

AMI ID (text box editor type): enter the Amazon Machine Image ID. An AMI is required to lunch an instance and must be specified here or in a launch template. E.g. '36542789'
Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Default Volume Size (text box editor type): enter the volume size for the instance as INT32.
Default PVC (text box editor type): enter the default Amazon Virtual Private Cloud. E.g. '172.31.0.0/16'
Device Name for Volume (text box editor type): enter the device name for the volume. The available device names depending on the block device driver of the selected AMI's kernel.
Instance Type (text box editor type): enter an instance type that is compatible with the specified AMI. E.g 'm1.small'
Security Group (text box editor type): enter the identifier of one or more security groups. For a non default VPC, you must use security groups IDs instead. E.g 'mySecurityGroup'
Subnet ID (text box editor type): enter the ID of the subnet to lunch the instance into. E.g '10.0.0.0/24'
Tags (Key-Name) (text box editor type): enter the name of the EC2 key pair. E.g my-sample-key

The Read Only Output variable is the possible output value that the activity will provide:

Output Instance Id: outputs the ID of the new created instance.

Create Snapshot

This activity creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

Activity Parameters

The Create Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Description (text box editor type): enter the description for the new snapshot.
Volume Id (text box editor type): enter the ID of the Amazon EBS volume of which to take a snapshot.

The Read Only Output variable is the possible output value that the activity will provide:

Output Snapshot Id: outputs the ID of the newly created snapshot.

Create Subnet

This activity creates a subnet in an existing VPC.

Activity Parameters

The Create Subnet activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

CIDR Block (text box editor type): enter the network range for the subnet, in CIDR notation, for example "10.0.0.0/24".
Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
VPC Id (text box editor type): enter the ID of the Virtual Private Gateway (VPC) where you want to create the subnet.

The Read Only Output variable is the possible output value that the activity will provide:

Output Subnet Id: outputs the ID of the newly created subnet.

Create Volume

This activity creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.

Activity Parameters

The Create Volume activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Availability Zone (text box editor type): enter the availability zone in which to create the volume. Use the activity Get Availability Zones to list the Availability Zones that are currently available for your account
Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Size (text box editor type): enter the size of the volume, in GBs. Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-104 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size. If you are creating the volume from a snapshot and do not specify a volume size, the default is the snapshot size.

The Read Only Output variable is the possible output value that the activity will provide:

Output Volume Id: outputs the ID of the newly created volume.

Create VPC

This activity creates a VPC (virtual private cloud).

Activity Parameters

The Create VPC activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Cidr Block (text box editor type): enter the network range for the VPC, in CIDR notation, for example "10.0.0/16".
Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPC Id: outputs the ID of the newly created VPC.

Create VPN connection

This activity creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec1.

Activity Parameters

The Create VPN connection activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Customer Gateway Id (text box editor type): enter the ID of the customer gateway.
Type (text box editor type): enter the type of VPN connection, for example "ipsec.1".
VPN Gateway Id (text box editor type): enter the ID of the virtual private gateway.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Id: outputs the ID of the new VPN connection created.

Create VPN Gateway

This activity creates a VPN gateway.

Activity Parameters

The Create VPN Gateway activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Value (text box editor type): enter the VPN gateway ID, for example "ipsec.1".

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Gateway Id: outputs the ID of the newly created VPN Gateway.

Delete Instance By Id

This activity deletes an Amazon EC2 Instance.

Activity Parameters

The Delete Instance By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Instance Id (text box editor type): enter the ID of the Amazon instance to delete. You get use Get Instance activity to obtain a list of all instances and store that result into a list. Bind the list iterator to this parameter at the desired index to deleted the instance.

The Read Only Output variable is the possible output value that the activity will provide:

Output Execution: outputs the execution status: True for success, False otherwise.

Delete Snapshot By Id

This activity deletes a snapshot of an Amazon EBS volume that you own.

Activity Parameters

The Delete Snapshot By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Snapshot Id (text box editor type): enter the ID of the Amazon EBS snapshot to delete.

The Read Only Output variable is the possible output value that the activity will provide:

Output Snapshot Id: outputs the ID of the deleted snapshot.

Delete Volume By Id

This activity deletes an Amazon EBS volume that you own. The volume must be in the availability state (not attached to an instance).

Activity Parameters

The Delete Volume By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Volume Id (text box editor type): enter the ID of the volume that you want to delete. In order to be deleted, the volume should not be attached to an instance.

The Read Only Output variable is the possible output value that the activity will provide:

Output Volume Id: outputs the ID of the deleted volume.

Delete VPC By Id

This activity deletes a VPC given its ID.

Activity Parameters

The Delete VPC By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
VPC Id (text box editor type): enter the ID of the VPC that you want to delete. In order to be deleted, the VPC should not have dependencies and should not be set as a default VPC.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPC Id: outputs the ID of the deleted VPC.

Delete VPN By Id

This activity deletes a VPN connection given its ID.

Activity Parameters

The Delete VPN By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
VPN Id (text box editor type): enter the ID of the VPN that you want to delete.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Id: outputs the ID of the deleted VPN.

Delete VPN Gateway By Id

This activity deletes a VPN gateway given its ID.

Activity Parameters

The Delete VPN Gateway By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
VPN Gateway Id (text box editor type): enter the ID of the VPN gateway that you want to delete. In order to be deleted, the VPN gateway should not be in use, for example it should not be attached to a VPC.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Gateway Id: outputs the ID of the deleted VPN gateway.

Detach Volume

This activity detaches an Amazon EBS volume from an instance.

Activity Parameters

The Detach Volume activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Device (text box editor type): enter the device name.
Force (text box editor type): forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance would not have the opportunity to flush file system caches or a file system metadata. If you use this option, you must perform file system check and repair procedures.
Instance Id (text box editor type): enter the instance ID from which you want to detach the volume.
Volume Id (text box editor type): enter the volume ID that you want to detach. The volume ID should be attached to an instance.

The Read Only Output variable is the possible output value that the activity will provide:

Output Detached Id: outputs the ID of the detached volume.

Disconnect From AmazonEC2

This activity disconnects from AmazonEC2 account.

Activity Parameters

The Disconnect From AmazonEC2 activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

Get Availability Zones

This activity gets the available Amazon EC2 zones.

Activity Parameters

The Get Availability Zones activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output Zones: outputs a list of available zones.

Get Image By Id

This activity gets an image given its ID.

Activity Parameters

The Get Image By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Image Id (text box editor type): enter the ID of the image that you want to get.

The Read Only Output variables are the possible output values that the activity will provide:

Output Architecture: outputs the architecture of the image.
Output Creation Date: outputs the creation date of the image.
Output Description: outputs the description of the image.
Output Hypervisor: outputs the image hypervisor type.
Output Image Location: outputs the location of the AMI.
Output Image Owner Alias: outputs the AWS account alias (for example, amazon) or AWS account ID that owns the AMI.
Output Image Type: outputs the image type.
Output Kernel Id: outputs the kernel associated with the image, if any. Only applicable for machine images.
Output Name: outputs the image name.
Output State: outputs the current image state.

Get Images

This activity gets a list of images IDs.

Activity Parameters

The Get Images activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output Images: outputs a list of images.

Get Instances

This activity gets a list of instances IDs.

Activity Parameters

The Get Instances activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. In this activity, you should have the same availability zone as your instances have. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output Instances: outputs a list of instances.

Get Snapshot By Id

This activity gets a snapshot given its ID.

Activity Parameters

The Get Snapshot By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Snapshot Id (text box editor type): enter the ID of the snapshot that you want to get.

The Read Only Output variables are the possible output values that the activity will provide:

Output Size: outputs the volume size
Output Data Encryption Zone: outputs the availability zone.
Output Description: outputs the snapshot description.
Output Encryption: outputs the snapshot encryption.
Output KmsKeyId: outputs the snapshot KmsKeyId.
Output Message State: outputs the message state.
Output Owner Alias: outputs the snapshot owner alias.
Output Owner Id: outputs the snapshot owner ID.
Output Progress: outputs the snapshot progress.
Output Snapshot State: outputs the snapshot state.
Output Start Time: outputs the start time for the specified snapshot.
Ouput VolumeId: outputs the snapshot volume ID.

Get Snapshots

This activity gets a list of snapshots IDs.

Activity Parameters

The Get Snapshots activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output Snapshots: outputs a list of snapshots IDs.

Get Volume By Id

This activity gets a volume given its ID.

Activity Parameters

The Get Volume By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.
Volume Id (text box editor type): enter the ID of the volume that you want to get.

The Read Only Output variables are the possible output values that the activity will provide:

Output Availability Zone: outputs the availability zone.
Output Creation Time: outputs the creation time.
Output Encrypted: outputs the encrypted state.
Output IOPS: outputs the IOPS value. IOPS is the number of I/O operations per second(IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
Output KmsKeyId: outputs the KmsKeyId. The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
Output Size : outputs the size of the volume in GB.
Output Snapshot Id: outputs the snapshot ID from which the volume was created.
Output State: outputs the volume state.
Output Volume Type : outputs the volume type.

Get Volumes

This activity gets a list of volumes IDs.

Activity Parameters

The Get Volumes activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output Instances: outputs a list of instances.

Get VPC Ids

This activity gets a list of VPC IDs.

Activity Parameters

The Get VPC Ids activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPC Ids: outputs a list of VPC IDs.

Get VPN Connections

This activity gets a list of VPN connections IDs.

Activity Parameters

The Get VPN Connections activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Connections: outputs a list of VPN connections IDs.

Get VPN Gateways

This activity gets a list of VPN gateways.

Activity Parameters

The Get VPN Gateways activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type): the AmazonEC2 connection, obtained after using a ConnectToAmazonEC2 activity. The output from Connect To AmazonEC2 activity should be used as input for this parameter.

The Read Only Output variable is the possible output value that the activity will provide:

Output VPN Gateways: outputs a list of VPN gateways.