baiji v0.6.5 Baiji.Cloudformation
AWS CloudFormation
AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.
Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product’s technical documentation at docs.aws.amazon.com.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration
For a specified stack that is in the UPDATE_ROLLBACK_FAILED
state,
continues rolling it back to the UPDATE_ROLLBACK_COMPLETE
state.
Depending on the cause of the failure, you can manually fix the
error
and continue the rollback. By continuing the rollback, you can return your
stack to a working state (the UPDATE_ROLLBACK_COMPLETE
state), and then
try to update the stack again
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn’t exist or an existing stack. If you create a change set for a stack that doesn’t exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack’s information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack
Creates a stack as specified in the template. After the call completes
successfully, the stack creation starts. You can check the status of the
stack via the DescribeStacks
API
Creates stack instances for the specified accounts, within the specified
regions. A stack instance refers to a stack in a specific account and
region. Accounts
and Regions
are required parameters—you must specify
at least one account and one region
Creates a stack set
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set
Deletes a specified stack. Once the call completes successfully, stack
deletion starts. Deleted stacks do not show up in the DescribeStacks
API
if the deletion has been completed successfully
Deletes stack instances for the specified accounts, in the specified regions
Deletes a stack set. Before you can delete a stack set, all of its member
stack instances must be deleted. For more information about how to do this,
see DeleteStackInstances
Retrieves your account’s AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack’s event history, go to Stacks in the AWS CloudFormation User Guide
Returns the stack instance that’s associated with the specified stack set, AWS account, and region
Returns a description of the specified resource in the specified stack
Returns AWS resource descriptions for running and deleted stacks. If
StackName
is specified, all the associated resources that are part of the
stack are returned. If PhysicalResourceId
is specified, the associated
resources of the stack that the resource belongs to are returned
Returns the description of the specified stack set
Returns the description of the specified stack set operation
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template
Updates a stack using the input information that was provided when the
specified change set was created. After the call successfully completes,
AWS CloudFormation starts updating the stack. Use the DescribeStacks
action to view the status of the update
Returns the stack policy for a specified stack. If a stack doesn’t have a policy, a null value is returned
Returns the template body for a specified stack. You can get the template for running or deleted stacks
Returns information about a new or existing template. The
GetTemplateSummary
action is useful for viewing parameter information,
such as default parameter values and parameter types, before you create or
update a stack or stack set
Returns the ID and status of each active change set for a stack. For
example, AWS CloudFormation lists change sets that are in the
CREATE_IN_PROGRESS
or CREATE_PENDING
state
Lists all exported output values in the account and region in which you
call this action. Use this action to see the exported output values that
you can import into other stacks. To import values, use the
Fn::ImportValue
function
Lists all stacks that are importing an exported output value. To modify or
remove an exported output value, first use this action to see which stacks
are using it. To see the exported output values in your account, see
ListExports
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region
Returns descriptions of all resources of the specified stack
Returns summary information about the results of a stack set operation
Returns summary information about operations performed on a stack set
Returns summary information about stack sets that are associated with the user
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted)
Sets a stack policy for a specified stack
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn’t proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance
Stops an in-progress operation on a stack set and its associated stack instances
Updates a stack as specified in the template. After the call completes
successfully, the stack update starts. You can check the status of the
stack via the DescribeStacks
action
Updates the stack set and all associated stack instances
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn’t, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.
For a specified stack that is in the UPDATE_ROLLBACK_FAILED
state,
continues rolling it back to the UPDATE_ROLLBACK_COMPLETE
state.
Depending on the cause of the failure, you can manually fix the
error
and continue the rollback. By continuing the rollback, you can return your
stack to a working state (the UPDATE_ROLLBACK_COMPLETE
state), and then
try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED
state when AWS
CloudFormation cannot roll back all changes after a failed stack update.
For example, you might have a stack that is rolling back to an old database
instance that was deleted outside of AWS CloudFormation. Because AWS
CloudFormation doesn’t know the database was deleted, it assumes that the
database instance still exists and attempts to roll back to it, causing the
update rollback to fail.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn’t exist or an existing stack. If you create a change set for a stack that doesn’t exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack’s information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.
To create a change set for a stack that doesn’t exist, for the
ChangeSetType
parameter, specify CREATE
. To create a change set for an
existing stack, specify UPDATE
for the ChangeSetType
parameter. After
the CreateChangeSet
call successfully completes, AWS CloudFormation
starts creating the change set. To check the status of the change set or to
review it, use the DescribeChangeSet
action.
When you are satisfied with the changes the change set will make, execute
the change set by using the ExecuteChangeSet
action. AWS CloudFormation
doesn’t make changes until you execute the change set.
Creates a stack as specified in the template. After the call completes
successfully, the stack creation starts. You can check the status of the
stack via the DescribeStacks
API.
Creates stack instances for the specified accounts, within the specified
regions. A stack instance refers to a stack in a specific account and
region. Accounts
and Regions
are required parameters—you must specify
at least one account and one region.
Creates a stack set.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
Deletes a specified stack. Once the call completes successfully, stack
deletion starts. Deleted stacks do not show up in the DescribeStacks
API
if the deletion has been completed successfully.
Deletes stack instances for the specified accounts, in the specified regions.
Deletes a stack set. Before you can delete a stack set, all of its member
stack instances must be deleted. For more information about how to do this,
see DeleteStackInstances
.
Retrieves your account’s AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.
Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack’s event history, go to Stacks in the AWS CloudFormation User Guide.
Returns the stack instance that’s associated with the specified stack set, AWS account, and region.
For a list of stack instances that are associated with a specific stack
set, use ListStackInstances
.
Returns a description of the specified resource in the specified stack.
For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.
Returns AWS resource descriptions for running and deleted stacks. If
StackName
is specified, all the associated resources that are part of the
stack are returned. If PhysicalResourceId
is specified, the associated
resources of the stack that the resource belongs to are returned.
information for up to 90 days after the stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not both.
In addition, you can specify LogicalResourceId
to filter the returned
result. For more information about resources, the LogicalResourceId
and
PhysicalResourceId
, go to the AWS CloudFormation User
Guide.
Returns the description of the specified stack set.
Returns the description of the specified stack set operation.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
Updates a stack using the input information that was provided when the
specified change set was created. After the call successfully completes,
AWS CloudFormation starts updating the stack. Use the DescribeStacks
action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren’t valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can’t specify a temporary stack policy that overrides the current policy.
Returns the stack policy for a specified stack. If a stack doesn’t have a policy, a null value is returned.
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
Returns information about a new or existing template. The
GetTemplateSummary
action is useful for viewing parameter information,
such as default parameter values and parameter types, before you create or
update a stack or stack set.
You can use the GetTemplateSummary
action when you submit a template, or
you can get template information for a stack set, or a running or deleted
stack.
For deleted stacks, GetTemplateSummary
returns the template information
for up to 90 days after the stack has been deleted. If the template does
not exist, a ValidationError
is returned.
Returns the ID and status of each active change set for a stack. For
example, AWS CloudFormation lists change sets that are in the
CREATE_IN_PROGRESS
or CREATE_PENDING
state.
Lists all exported output values in the account and region in which you
call this action. Use this action to see the exported output values that
you can import into other stacks. To import values, use the
Fn::ImportValue
function.
For more information, see AWS CloudFormation Export Stack Output Values.
Lists all stacks that are importing an exported output value. To modify or
remove an exported output value, first use this action to see which stacks
are using it. To see the exported output values in your account, see
ListExports
.
For more information about importing an exported output value, see the
Fn::ImportValue
function.
Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.
Returns descriptions of all resources of the specified stack.
For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.
Returns summary information about the results of a stack set operation.
Returns summary information about operations performed on a stack set.
Returns summary information about stack sets that are associated with the user.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).
Sets a stack policy for a specified stack.
Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn’t proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.
Stops an in-progress operation on a stack set and its associated stack instances.
Updates a stack as specified in the template. After the call completes
successfully, the stack update starts. You can check the status of the
stack via the DescribeStacks
action.
To get a copy of the template for an existing stack, you can use the
GetTemplate
action.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
Updates the stack set and all associated stack instances.
Even if the stack set operation created by updating the stack set fails
(completely or partially, below or above a specified failure tolerance),
the stack set is updated with your changes. Subsequent
CreateStackInstances
calls on the specified stack set use the updated
stack set.
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn’t, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.