Amazon EC2 

Amazon EC2 plugin steps perform Amazon EC2 Virtual Machine operations.

Steps to Create Access Key ID and Secret Access Key:

Access Key and Secret Key are required for all Amazon EC2 Plugin steps. 

Log in to your Amazon AWS Console (https://console.aws.amazon.com) and follow the below procedure to create Access Key and Secret Key.

1. Click on the AWS logged in username in the top right side.
   
2. Click on ‘My Security Credentials’.
   
3. Click on ‘Access keys (access key ID and secret access key)’.
   
4. Click on ‘Create New Access Key’.
   
5. Your keys are now created. Either click on ‘Show Access Key’ to see the generated keys or Click on ‘Download Key File’ which contains the keys.
   

Amazon EC2: Get Instance Propoerties

Description

Amazon EC2: Get Instance Properties step fetches the properties of all EC2 instances on the specified Amazon AWS cloud account.

Prerequisites:

1. Amazon AWS cloud instance with access details.
   
2. Login details [Access key and Secret key] to authenticate to Amazon AWS cloud. Refer “Steps to Create Access Key ID and Secret Access Key” in the Plugin header for details.
   

      

Note: As this step generates multiple rows, use this as the first step in the workflow

 

Configurations 

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hoisted or choose a region from the Region Explorer window.
3	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
5	Access Key	Specify an Access Key to authenticate EC2 instance on Amazon AWS cloud. This field is mandatory.
7	Secret Key	Specify a Secret Key to authenticate Amazon AWS cloud.  This field is mandatory.
8	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static (hardcoded) values and environment variables are allowed.It will not work for previous step fields.

Output Tab:
No.	Field Name	Description
	Output Fields (Tabular):
1	Field Name	On click of the cell in the output table, if the connection is successfully established, it populates the list of instance properties. Select an instance property in a field or many in the table as desired.
2	Output Field	Specify an output field to hold the field values for the field name specified above.

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hosted or choose a region from the Region Explorer window. The field type is String. This field is mandatory.
3	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
	Access Key:	Access key to authenticate Amazon AWS cloud.
4	Accept Values from fields	Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Access Key field to appear as Text box.
5	Access Key	Specify the Access Key to authenticate Amazon AWS cloud EC2 instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
	Secret Key:	Secret key to authenticate Amazon AWS cloud.
6	Accept Values from fields	Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Secret Key field to appear as Text box.
7	Secret Key	Specify the Secret Key to authenticate Amazon AWS Cloud EC2 instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
8	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Amazon Machine Image	Specify Amazon Machine Image (AMI) Id to be launched.
2	Instance Type	Specify Instance Type of the AMI to be launched.
3	Button: Get	Click Get button to get a popup containing list of Instance types.
4	Number of Instances	Specify Number of instances to be created.
5	Security Group	Specify Security Group in which instance is to be launched.
6	Button: Get	Click Get button to get a popup containing list of Security Groups.
7	Key Pair Name	Specify Key Pair Name to be assigned to the instance.
8	Button: Get	Click Get button to get a popup containing list of Key Pair Names.

Tip: You may use Get Instance Properties as the first step in the workflow to fetch these properties for all the EC2 instances on this AWS cloud account other than fetching them manually from EC2 web portal.

Output Tab:
No.	Field Name	Description
	Output Field:
1	Instance Id	Specify an output field to hold the Instance Id of the newly created Virtual Machine instance launched as a result of step execution.

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hosted or choose a region from the Region Explorer window. The field type is String. This field is mandatory.
3	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
	Access Key:	Access key to authenticate Amazon AWS cloud.
4	Accept Values from fields	Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Access Key field to appear as Text box.
5	Access Key	Specify the Access Key to authenticate Amazon AWS cloud EC2 instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
	Secret Key:	Secret key to authenticate Amazon AWS cloud.
6	Accept Values from fields	Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Secret Key field to appear as Text box.
7	Secret Key	Specify the Secret Key to authenticate Amazon AWS Cloud EC2 instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
8	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Instance Id	Specify the EC2 Virtual Machine Instance Id to be restarted.

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hosted or choose a region from the Region Explorer window. The field type is String. This field is mandatory.
	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
	Access Key:	Access key to authenticate Amazon AWS cloud.
3	Accept Values from fields	Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Access Key field to appear as Text box.
4	Access Key	Specify the Access Key to authenticate Amazon AWS cloud EC2 instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
	Secret Key:	Secret key to authenticate Amazon AWS cloud.
5	Accept Values from fields	Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Secret Key field to appear as Text box.
6	Secret Key	Specify the Secret Key to authenticate Amazon AWS Cloud EC2 instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
7	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Instance Id	Specify the EC2 Virtual Machine Instance Id to be started.

Output Tab:
No.	Field Name	Description
	Output Field:
1	Current State	Specify an output field to hold the current state of the instance after successful plugin execution. Default value for this field is “CurrentState”. Current State label value is mandatory.
2	Previous State	Specify an output field to hold the previous state of the instance before successful plugin execution. Default label value for this field is “PreviousState”. Previous State label value is mandatory.

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hosted or choose a region from the Region Explorer window. The field type is String. This field is mandatory.
3	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
	Access Key:	Access key to authenticate Amazon AWS cloud.
4	Accept Values from fields	Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Access Key field to appear as Text box.
5	Access Key	Specify the Access Key to authenticate Amazon AWS cloud EC2 instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
	Secret Key:	Secret key to authenticate Amazon AWS cloud.
6	Accept Values from fields	Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Secret Key field to appear as Text box.
7	Secret Key	Specify the Secret Key to authenticate Amazon AWS Cloud EC2 instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
8	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Instance Id	Specify the Virtual Machine Instance Id to be stopped.

Output Tab:
No.	Field Name	Description
	Output Field:
1	Current State	Specify an output field to hold the current state of the instance after successful plugin execution. Default value for this field is “CurrentState”. Current State label value is mandatory.
2	Previous State	Specify an output field to hold the previous state of the instance before successful plugin execution. Default label value for this field is “PreviousState”. Previous State label value is mandatory.

No.	Field Name			Description
1	Step Name	Name of the step. This name has to be unique in a single workflow.
	Connection:
2	Region	Specify the region where the instance is hosted or choose a region from the Region Explorer window. The field type is String. This field is mandatory.
3	Button: Get	Click Get button to open the Region Explorer window. Choose a Region.
	Access Key:	Access key to authenticate Amazon AWS cloud.
4	Accept Values from fields	Leave checkbox unchecked to accept Access Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Access Key field to appear as Text box.
5	Access Key	Specify the Access Key to authenticate Amazon AWS cloud EC2 instance. If checkbox above is enabled Access Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Access Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
	Secret Key:	Secret key to authenticate Amazon AWS cloud.
6	Accept Values from fields	Leave checkbox unchecked to accept Secret Key value from a field in the previous steps of the stream using a drop down list.  Else enable checkbox for Secret Key field to appear as Text box.
7	Secret Key	Specify the Secret Key to authenticate Amazon AWS Cloud EC2 instance. If checkbox above is enabled Secret Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Secret Key field appears as a drop down to select fields from previous steps. The field type is String. This field is mandatory.
8	Button: Test Connection	Click Test Connection button to verify whether the connection is available or not. Region, Access key and Secret Key are mandatory to authenticate Amazon AWS cloud. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Instance Id	Specify the EC2 Instance Id to be terminated.

Output Tab:
No.	Field Name	Description
	Output Field:
1	Current State	Specify an output field to hold the current state of the instance after successful plugin execution. Default value for this field is “CurrentState”. Current State label value is mandatory.
2	Previous State	Specify an output field to hold the previous state of the instance before successful plugin execution. Default label value for this field is “PreviousState”. Previous State label value is mandatory.