Back to Top
Attach an IAM role to an EC2 instance
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.AttachIamRoleToEc2InctanceTask |
| Category | Amazon Web Services |
Attach an IAM role to an EC2 instance
Description
Attach an IAM role to an EC2 instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which the instance is. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| iamRole | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.IamInstanceProfileSelectionParameterType | false | The IAM instance profile name (IAM role) to associate to the EC2 instance. | |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID to attach the IAM role. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Create an EC2 AMI in AWS
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.CreateAwsImageTask |
| Category | Amazon Web Services |
Create an EC2 AMI in AWS
Description
Create an Amazon Machine Image from a specified EC2 instance. The 'imageName' will be assigned to the newly created image.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| asynchronousJob | java.lang.Boolean | true | true | Create the image synchronously or asynchronously. |
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which to create the AMI. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| description | TextArea | true | The description of the new image. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| imageName | java.lang.String | false | The name assigned to the created image. | |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID of the instance from which the AMI is to be created. | |
| outputParameter | java.lang.String | ${imageId} | false | The name of the output parameter, which can pass the return value from the task. The task output will be the AMI ID of the newly created image. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the task list, as an input parameter ${imageId}. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Create an EC2 instance in AWS
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.CreateAwsInstanceTask |
| Category | Amazon Web Services |
Create an EC2 instance in AWS
Description
Create an EC2 instance from a specified AMI ID. The 'instanceName' will be assigned to the new instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| asynchronousJob | java.lang.Boolean | true | true | Create the instance synchronously or asynchronously. |
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which to create the instance. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| imageId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.ImageSelectionParameterType | false | The AMI ID of the image from which the instance is to be created. | |
| instanceName | java.lang.String | false | The name of AWS EC2 instance. | |
| instanceType | java.util.List | t2.medium | false | The instance type to create the EC2 instance. Select one of the values from the list or type in your own. |
| keyName | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.KeyPairSelectionParameterType | false | The name of the security key pair. It must exist in the 'awsRegion' specified. | |
| outputParameter | java.lang.String | ${instanceId} | false | The name of the output parameter, which can pass the return value from the task. The task output will be the EC2 instance ID of the newly created instance. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the task list, as an input parameter ${instanceId}. |
| securityGroups | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.SecurityGroupSelectionParameterType | false | The name of the security groups to be added to the instance separated by commas (','). They must exist in the 'awsRegion' specified. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| subnetId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.SubnetSelectionParameterType | true | The ID of the VPC subnet where the instance will be created and the security group should be. You can select a subnet from the drop-down list or directly type the ID of the desired subnet. | |
| userData | TextArea | true | You can specify user data to configure an instance or run a configuration script during launch. |
Back to Top
If the above parameters are not set in the command, you can set a custom configuration for the task execution by setting the "awsAccessKey", "awsSecretKey", "awsSecretKey" or "outputFormat" task parameters for a custom configuration. This configuration will be saved in the AWS CLI configuration file under a profile called "rapiddeploy".
You can also set environment variables in the task to set the AWS CLI configuration (e.g., AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION).
Execute a generic AWS CLI command
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.GenericAwsCliExecutionTask |
| Category | Amazon Web Services |
Execute a generic AWS CLI command
Description
By default it will use the AWS CLI configuration set in the system for the current user or by the settings in the "--profile", "--region" or "--output" parameters set for the command.If the above parameters are not set in the command, you can set a custom configuration for the task execution by setting the "awsAccessKey", "awsSecretKey", "awsSecretKey" or "outputFormat" task parameters for a custom configuration. This configuration will be saved in the AWS CLI configuration file under a profile called "rapiddeploy".
You can also set environment variables in the task to set the AWS CLI configuration (e.g., AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION).
Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| awsAccessKey | java.lang.String | true | The custom AWS Access Key to use with the AWS CLI command. | |
| awsCliInstallationPath | java.lang.String | true | The path to the AWS CLI installation (e.g., /usr/local/aws-cli or C:\Program Files\Amazon\AWSCLI). If this value is not specified, the framework will try to look for the AWS CLI command in the $PATH environment variable automatically. | |
| awsCommand | java.lang.String | ec2 describe-instances | false | The AWS CLI command you want to execute. |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | true | The custom AWS Region to use for the AWS CLI command. | |
| awsSecretKey | java.lang.String | true | The custom AWS Secret Key to use with the AWS CLI command. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| outputFormat | java.util.List | true | The custom output format to use for the AWS CLI command. If you don't specify an output format, 'json' is used as the default. | |
| outputParameter | java.lang.String | ${awsCommandOutput} | false | The name of the output parameter, which can pass the return value from the task. The task output will be the AWS CLI command output. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the task list, as an input parameter ${awsCommandOutput}. |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Increase the EBS volume of an EC2 instance
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.IncreaseSizeToEbsVolumeTask |
| Category | Amazon Web Services |
Increase the EBS volume of an EC2 instance
Description
Increase the EBS volume of an EC2 instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which the instance is. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID for which to increase the EBS volume size. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
| volumeSize | java.lang.Integer | 10 | false | The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume. |
Back to Top
Start an EC2 instance in AWS
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.StartAwsInstanceTask |
| Category | Amazon Web Services |
Start an EC2 instance in AWS
Description
Start an EC2 instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| asynchronousJob | java.lang.Boolean | true | true | Start the instance synchronously or asynchronously. |
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which the instance is. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID of the instance to start. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Stop an EC2 instance in AWS
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.StopAwsInstanceTask |
| Category | Amazon Web Services |
Stop an EC2 instance in AWS
Description
Stop an EC2 instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which the instance is. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID of the instance to stop. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |
Back to Top
Terminate an EC2 instance in AWS
| Class Name | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.TerminateAwsInstanceTask |
| Category | Amazon Web Services |
Terminate an EC2 instance in AWS
Description
Terminate an EC2 instance.Parameters
The following parameters may be set on this task:Table of task Parameters
| Name | Type | Default Value | Optional | Description |
|---|---|---|---|---|
| awsAccessKey | java.lang.String | false | The AWS Access Key required to use the AWS API. | |
| awsRegion | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.RegionSelectionParameterType | false | The AWS Region in which the instance is. | |
| awsSecretKey | java.lang.String | false | The AWS Secret Key required to use the AWS API. | |
| failOnError | java.lang.Boolean | true | false | This task will not fail the deployment on error if set to false. |
| instanceId | com.midvision.rapiddeploy.plugins.cloudprovider.aws.tasks.parameter.InstanceSelectionParameterType | false | The EC2 instance ID of the instance to terminate. | |
| skipOnFailure | java.lang.String | Previous Task Name | true | Skip current task based on the name of the previous task whether has failed or not. |