NAME

Paws::CloudFormation - Perl Interface to AWS AWS CloudFormation

SYNOPSIS

  use Paws;

  my $obj = Paws->service('CloudFormation');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

METHODS

CancelUpdateStack(StackName => Str, [ClientRequestToken => Str])

Each argument is described in detail in: Paws::CloudFormation::CancelUpdateStack

Returns: nothing

  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.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

ContinueUpdateRollback(StackName => Str, [ClientRequestToken => Str, ResourcesToSkip => ArrayRef[Str|Undef], RoleARN => Str])

Each argument is described in detail in: Paws::CloudFormation::ContinueUpdateRollback

Returns: a Paws::CloudFormation::ContinueUpdateRollbackOutput instance

  For a specified stack that is in the C<UPDATE_ROLLBACK_FAILED> state,
continues rolling it back to the C<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 C<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.

CreateChangeSet(ChangeSetName => Str, StackName => Str, [Capabilities => ArrayRef[Str|Undef], ChangeSetType => Str, ClientToken => Str, Description => Str, NotificationARNs => ArrayRef[Str|Undef], Parameters => ArrayRef[Paws::CloudFormation::Parameter], ResourceTypes => ArrayRef[Str|Undef], RoleARN => Str, RollbackConfiguration => Paws::CloudFormation::RollbackConfiguration, Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str, UsePreviousTemplate => Bool])

Each argument is described in detail in: Paws::CloudFormation::CreateChangeSet

Returns: a Paws::CloudFormation::CreateChangeSetOutput instance

  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.

CreateStack(StackName => Str, [Capabilities => ArrayRef[Str|Undef], ClientRequestToken => Str, DisableRollback => Bool, EnableTerminationProtection => Bool, NotificationARNs => ArrayRef[Str|Undef], OnFailure => Str, Parameters => ArrayRef[Paws::CloudFormation::Parameter], ResourceTypes => ArrayRef[Str|Undef], RoleARN => Str, RollbackConfiguration => Paws::CloudFormation::RollbackConfiguration, StackPolicyBody => Str, StackPolicyURL => Str, Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str, TimeoutInMinutes => Int])

Each argument is described in detail in: Paws::CloudFormation::CreateStack

Returns: a Paws::CloudFormation::CreateStackOutput instance

  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.

CreateStackInstances(Accounts => ArrayRef[Str|Undef], Regions => ArrayRef[Str|Undef], StackSetName => Str, [OperationId => Str, OperationPreferences => Paws::CloudFormation::StackSetOperationPreferences])

Each argument is described in detail in: Paws::CloudFormation::CreateStackInstances

Returns: a Paws::CloudFormation::CreateStackInstancesOutput instance

  Creates stack instances for the specified accounts, within the
specified regions. A stack instance refers to a stack in a specific
account and region. C<Accounts> and C<Regions> are required
parametersE<mdash>you must specify at least one account and one region.

CreateStackSet(StackSetName => Str, [Capabilities => ArrayRef[Str|Undef], ClientRequestToken => Str, Description => Str, Parameters => ArrayRef[Paws::CloudFormation::Parameter], Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::CreateStackSet

Returns: a Paws::CloudFormation::CreateStackSetOutput instance

  Creates a stack set.

DeleteChangeSet(ChangeSetName => Str, [StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DeleteChangeSet

Returns: a Paws::CloudFormation::DeleteChangeSetOutput instance

  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.

DeleteStack(StackName => Str, [ClientRequestToken => Str, RetainResources => ArrayRef[Str|Undef], RoleARN => Str])

Each argument is described in detail in: Paws::CloudFormation::DeleteStack

Returns: nothing

  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.

DeleteStackInstances(Accounts => ArrayRef[Str|Undef], Regions => ArrayRef[Str|Undef], RetainStacks => Bool, StackSetName => Str, [OperationId => Str, OperationPreferences => Paws::CloudFormation::StackSetOperationPreferences])

Each argument is described in detail in: Paws::CloudFormation::DeleteStackInstances

Returns: a Paws::CloudFormation::DeleteStackInstancesOutput instance

  Deletes stack instances for the specified accounts, in the specified
regions.

DeleteStackSet(StackSetName => Str)

Each argument is described in detail in: Paws::CloudFormation::DeleteStackSet

Returns: a Paws::CloudFormation::DeleteStackSetOutput instance

  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.

DescribeAccountLimits([NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeAccountLimits

Returns: a Paws::CloudFormation::DescribeAccountLimitsOutput instance

  Retrieves your account's AWS CloudFormation limits, such as the maximum
number of stacks that you can create in your account.

DescribeChangeSet(ChangeSetName => Str, [NextToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeChangeSet

Returns: a Paws::CloudFormation::DescribeChangeSetOutput instance

  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.

DescribeStackEvents([NextToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStackEvents

Returns: a Paws::CloudFormation::DescribeStackEventsOutput instance

  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.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

DescribeStackInstance(StackInstanceAccount => Str, StackInstanceRegion => Str, StackSetName => Str)

Each argument is described in detail in: Paws::CloudFormation::DescribeStackInstance

Returns: a Paws::CloudFormation::DescribeStackInstanceOutput instance

  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.

DescribeStackResource(LogicalResourceId => Str, StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::DescribeStackResource

Returns: a Paws::CloudFormation::DescribeStackResourceOutput instance

  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.

DescribeStackResources([LogicalResourceId => Str, PhysicalResourceId => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStackResources

Returns: a Paws::CloudFormation::DescribeStackResourcesOutput instance

  Returns AWS resource descriptions for running and deleted stacks. If
C<StackName> is specified, all the associated resources that are part
of the stack are returned. If C<PhysicalResourceId> is specified, the
associated resources of the stack that the resource belongs to are
returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource 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.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

DescribeStacks([NextToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStacks

Returns: a Paws::CloudFormation::DescribeStacksOutput instance

  Returns the description for the specified stack; if no stack name was
specified, then it returns the description for all the stacks created.

If the stack does not exist, an AmazonCloudFormationException is returned.

DescribeStackSet(StackSetName => Str)

Each argument is described in detail in: Paws::CloudFormation::DescribeStackSet

Returns: a Paws::CloudFormation::DescribeStackSetOutput instance

  Returns the description of the specified stack set.

DescribeStackSetOperation(OperationId => Str, StackSetName => Str)

Each argument is described in detail in: Paws::CloudFormation::DescribeStackSetOperation

Returns: a Paws::CloudFormation::DescribeStackSetOperationOutput instance

  Returns the description of the specified stack set operation.

EstimateTemplateCost([Parameters => ArrayRef[Paws::CloudFormation::Parameter], TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::EstimateTemplateCost

Returns: a Paws::CloudFormation::EstimateTemplateCostOutput instance

  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.

ExecuteChangeSet(ChangeSetName => Str, [ClientRequestToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::ExecuteChangeSet

Returns: a Paws::CloudFormation::ExecuteChangeSetOutput instance

  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.

GetStackPolicy(StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::GetStackPolicy

Returns: a Paws::CloudFormation::GetStackPolicyOutput instance

  Returns the stack policy for a specified stack. If a stack doesn't have
a policy, a null value is returned.

GetTemplate([ChangeSetName => Str, StackName => Str, TemplateStage => Str])

Each argument is described in detail in: Paws::CloudFormation::GetTemplate

Returns: a Paws::CloudFormation::GetTemplateOutput instance

  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.

If the template does not exist, a ValidationError is returned.

GetTemplateSummary([StackName => Str, StackSetName => Str, TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::GetTemplateSummary

Returns: a Paws::CloudFormation::GetTemplateSummaryOutput instance

  Returns information about a new or existing template. The
C<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.

ListChangeSets(StackName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListChangeSets

Returns: a Paws::CloudFormation::ListChangeSetsOutput instance

  Returns the ID and status of each active change set for a stack. For
example, AWS CloudFormation lists change sets that are in the
C<CREATE_IN_PROGRESS> or C<CREATE_PENDING> state.

ListExports([NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListExports

Returns: a Paws::CloudFormation::ListExportsOutput instance

  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
C<Fn::ImportValue> function.

For more information, see AWS CloudFormation Export Stack Output Values.

ListImports(ExportName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListImports

Returns: a Paws::CloudFormation::ListImportsOutput instance

  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.

ListStackInstances(StackSetName => Str, [MaxResults => Int, NextToken => Str, StackInstanceAccount => Str, StackInstanceRegion => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackInstances

Returns: a Paws::CloudFormation::ListStackInstancesOutput instance

  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.

ListStackResources(StackName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackResources

Returns: a Paws::CloudFormation::ListStackResourcesOutput instance

  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.

ListStacks([NextToken => Str, StackStatusFilter => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::CloudFormation::ListStacks

Returns: a Paws::CloudFormation::ListStacksOutput instance

  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).

ListStackSetOperationResults(OperationId => Str, StackSetName => Str, [MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackSetOperationResults

Returns: a Paws::CloudFormation::ListStackSetOperationResultsOutput instance

  Returns summary information about the results of a stack set operation.

ListStackSetOperations(StackSetName => Str, [MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackSetOperations

Returns: a Paws::CloudFormation::ListStackSetOperationsOutput instance

  Returns summary information about operations performed on a stack set.

ListStackSets([MaxResults => Int, NextToken => Str, Status => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackSets

Returns: a Paws::CloudFormation::ListStackSetsOutput instance

  Returns summary information about stack sets that are associated with
the user.

SetStackPolicy(StackName => Str, [StackPolicyBody => Str, StackPolicyURL => Str])

Each argument is described in detail in: Paws::CloudFormation::SetStackPolicy

Returns: nothing

  Sets a stack policy for a specified stack.

SignalResource(LogicalResourceId => Str, StackName => Str, Status => Str, UniqueId => Str)

Each argument is described in detail in: Paws::CloudFormation::SignalResource

Returns: nothing

  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.

StopStackSetOperation(OperationId => Str, StackSetName => Str)

Each argument is described in detail in: Paws::CloudFormation::StopStackSetOperation

Returns: a Paws::CloudFormation::StopStackSetOperationOutput instance

  Stops an in-progress operation on a stack set and its associated stack
instances.

UpdateStack(StackName => Str, [Capabilities => ArrayRef[Str|Undef], ClientRequestToken => Str, NotificationARNs => ArrayRef[Str|Undef], Parameters => ArrayRef[Paws::CloudFormation::Parameter], ResourceTypes => ArrayRef[Str|Undef], RoleARN => Str, RollbackConfiguration => Paws::CloudFormation::RollbackConfiguration, StackPolicyBody => Str, StackPolicyDuringUpdateBody => Str, StackPolicyDuringUpdateURL => Str, StackPolicyURL => Str, Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str, UsePreviousTemplate => Bool])

Each argument is described in detail in: Paws::CloudFormation::UpdateStack

Returns: a Paws::CloudFormation::UpdateStackOutput instance

  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.

UpdateStackSet(StackSetName => Str, [Capabilities => ArrayRef[Str|Undef], Description => Str, OperationId => Str, OperationPreferences => Paws::CloudFormation::StackSetOperationPreferences, Parameters => ArrayRef[Paws::CloudFormation::Parameter], Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str, UsePreviousTemplate => Bool])

Each argument is described in detail in: Paws::CloudFormation::UpdateStackSet

Returns: a Paws::CloudFormation::UpdateStackSetOutput instance

  Updates the stack set and I<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.

UpdateTerminationProtection(EnableTerminationProtection => Bool, StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::UpdateTerminationProtection

Returns: a Paws::CloudFormation::UpdateTerminationProtectionOutput instance

  Updates termination protection for the specified stack. If a user
attempts to delete a stack with termination protection enabled, the
operation fails and the stack remains unchanged. For more information,
see Protecting a Stack From Being Deleted in the I<AWS CloudFormation
User Guide>.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

ValidateTemplate([TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::ValidateTemplate

Returns: a Paws::CloudFormation::ValidateTemplateOutput instance

  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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results