AWS CloudFormation plugin

AWS CloudFormation enables you to create and manage a collection of related Amazon Web Services (AWS) resources. With the AWS CloudFormation plugin, you can use existing templates with dynamic runtime values for the chosen service or application architectures and provision the services or applications. You can modify the template values as desired.

Before you begin

To use the AWS CloudFormation plugin, complete the following prerequisite tasks:

  1. Verify that your Deployment Automation user role allows you to manage plugins. For details, see Server roles and system security.

  2. Download the Deployment Automation plugin bundle, extract the AWS CloudFormation plugin zip file from the bundle, and load the file into Deployment Automation. For details, see Load and upgrade plugins.

To use the plugin steps, open a component or global process and navigate to Cloud > CloudFormation in the Tools pane.

For details on creating processes, see Create and design component processes and Create and design global processes.

Back to top

Step: AWS CloudFormation List Stack

This step enables you to select a stack from the stack list. This should typically be the first AWS CloudFormation plugin step in your process, as it is used to get information passed to subsequent steps.

The following table describes the step's properties:

Property Description
Access Key Enter the CloudFormation access key for logging in.
Secret Key Enter the corresponding CloudFormation secret key for logging in.
Region Select the region that contains the stack you want.
Display Results Selection Dialog

Use this option to display details returned from the step in a dialog box upon a successful process run, which enables you to select specific information to use in subsequent process steps.

This option is selected by default. It is implicitly required because there is no way to select the information without it.

Back to top

Step: AWS CloudFormation Modify Stack

Use this step to view and edit a selected stack template. Typically, the List Stack runs just before this step in the process.

You specify properties to get the template body from AWS CloudFormation.

After the plugin gets the template body, it displays the dynamic fields using the Deployment Automation standard user interface elements converted and sent from the Deployment Automation agent. The UI is rendered dynamically in a multiedit form, which can be edited by the user and resubmitted for further processing.

The following table describes the step's properties:

Property Description
Access Key Enter the CloudFormation access key for logging in.
Secret Key Enter the corresponding CloudFormation secret key for logging in.
Stack Name The stack name can be passed from an earlier List Stack step, or you can enter a stack name.
Region Select the region that contains the stack you want.
Display Results Selection Dialog

Use this option to display details returned from the step in a dialog box upon a successful process run, which enables you to select specific information to use in subsequent process steps.

This option is selected by default. It is implicitly required because there is no way to select the information without it.

Back to top

Step: AWS CloudFormation Update Stack

This step enables you to submit the changed stack to the AWS CloudFormation. The Modify Stack step should typically be just before this step in the process.

The following table describes the step's properties:

Property Description
Access Key Enter the CloudFormation access key for logging in.
Secret Key Enter the corresponding CloudFormation secret key for logging in.
Stack Name The stack name can be passed from an earlier List Stack step, or you can enter a stack name.
Region Select the region that contains the stack you want.
Modified Values Enter the modified template values for the stack.
Original Template The original template content is passed from a previous Modify Stack step and is used for submitting the modified values to AWS CloudFormation.

Back to top

See also: