aws_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.Summary
Functions
-
cancel_update_stack(Client, Input)
Cancels an update on the specified stack.
- cancel_update_stack(Client, Input, Options)
-
continue_update_rollback(Client, Input)
For a specified stack that is in the
UPDATE_ROLLBACK_FAILED
state, continues rolling it back to theUPDATE_ROLLBACK_COMPLETE
state. - continue_update_rollback(Client, Input, Options)
-
create_change_set(Client, Input)
Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.
- create_change_set(Client, Input, Options)
-
create_stack(Client, Input)
Creates a stack as specified in the template.
- create_stack(Client, Input, Options)
-
create_stack_instances(Client, Input)
Creates stack instances for the specified accounts, within the specified Regions.
- create_stack_instances(Client, Input, Options)
-
create_stack_set(Client, Input)
Creates a stack set.
- create_stack_set(Client, Input, Options)
-
delete_change_set(Client, Input)
Deletes the specified change set.
- delete_change_set(Client, Input, Options)
-
delete_stack(Client, Input)
Deletes a specified stack.
- delete_stack(Client, Input, Options)
-
delete_stack_instances(Client, Input)
Deletes stack instances for the specified accounts, in the specified Regions.
- delete_stack_instances(Client, Input, Options)
-
delete_stack_set(Client, Input)
Deletes a stack set.
- delete_stack_set(Client, Input, Options)
-
deregister_type(Client, Input)
Marks an extension or extension version as
DEPRECATED
in the CloudFormation registry, removing it from active use. - deregister_type(Client, Input, Options)
-
describe_account_limits(Client, Input)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
- describe_account_limits(Client, Input, Options)
-
describe_change_set(Client, Input)
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set.
- describe_change_set(Client, Input, Options)
-
describe_stack_drift_detection_status(Client, Input)
Returns information about a stack drift detection operation.
- describe_stack_drift_detection_status(Client, Input, Options)
-
describe_stack_events(Client, Input)
Returns all stack related events for a specified stack in reverse chronological order.
- describe_stack_events(Client, Input, Options)
-
describe_stack_instance(Client, Input)
Returns the stack instance that's associated with the specified stack set, AWS account, and Region.
- describe_stack_instance(Client, Input, Options)
-
describe_stack_resource(Client, Input)
Returns a description of the specified resource in the specified stack.
- describe_stack_resource(Client, Input, Options)
-
describe_stack_resource_drifts(Client, Input)
Returns drift information for the resources that have been checked for drift in the specified stack.
- describe_stack_resource_drifts(Client, Input, Options)
-
describe_stack_resources(Client, Input)
Returns AWS resource descriptions for running and deleted stacks.
- describe_stack_resources(Client, Input, Options)
-
describe_stack_set(Client, Input)
Returns the description of the specified stack set.
- describe_stack_set(Client, Input, Options)
-
describe_stack_set_operation(Client, Input)
Returns the description of the specified stack set operation.
- describe_stack_set_operation(Client, Input, Options)
-
describe_stacks(Client, Input)
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
- describe_stacks(Client, Input, Options)
-
describe_type(Client, Input)
Returns detailed information about an extension that has been registered.
- describe_type(Client, Input, Options)
-
describe_type_registration(Client, Input)
Returns information about an extension's registration, including its current status and type and version identifiers.
- describe_type_registration(Client, Input, Options)
-
detect_stack_drift(Client, Input)
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters.
- detect_stack_drift(Client, Input, Options)
-
detect_stack_resource_drift(Client, Input)
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters.
- detect_stack_resource_drift(Client, Input, Options)
-
detect_stack_set_drift(Client, Input)
Detect drift on a stack set.
- detect_stack_set_drift(Client, Input, Options)
-
estimate_template_cost(Client, Input)
Returns the estimated monthly cost of a template.
- estimate_template_cost(Client, Input, Options)
-
execute_change_set(Client, Input)
Updates a stack using the input information that was provided when the specified change set was created.
- execute_change_set(Client, Input, Options)
-
get_stack_policy(Client, Input)
Returns the stack policy for a specified stack.
- get_stack_policy(Client, Input, Options)
-
get_template(Client, Input)
Returns the template body for a specified stack.
- get_template(Client, Input, Options)
-
get_template_summary(Client, Input)
Returns information about a new or existing template.
- get_template_summary(Client, Input, Options)
-
list_change_sets(Client, Input)
Returns the ID and status of each active change set for a stack.
- list_change_sets(Client, Input, Options)
-
list_exports(Client, Input)
Lists all exported output values in the account and Region in which you call this action.
- list_exports(Client, Input, Options)
-
list_imports(Client, Input)
Lists all stacks that are importing an exported output value.
- list_imports(Client, Input, Options)
-
list_stack_instances(Client, Input)
Returns summary information about stack instances that are associated with the specified stack set.
- list_stack_instances(Client, Input, Options)
-
list_stack_resources(Client, Input)
Returns descriptions of all resources of the specified stack.
- list_stack_resources(Client, Input, Options)
-
list_stack_set_operation_results(Client, Input)
Returns summary information about the results of a stack set operation.
- list_stack_set_operation_results(Client, Input, Options)
-
list_stack_set_operations(Client, Input)
Returns summary information about operations performed on a stack set.
- list_stack_set_operations(Client, Input, Options)
-
list_stack_sets(Client, Input)
Returns summary information about stack sets that are associated with the user.
- list_stack_sets(Client, Input, Options)
-
list_stacks(Client, Input)
Returns the summary information for stacks whose status matches the specified StackStatusFilter.
- list_stacks(Client, Input, Options)
-
list_type_registrations(Client, Input)
Returns a list of registration tokens for the specified extension(s).
- list_type_registrations(Client, Input, Options)
-
list_type_versions(Client, Input)
Returns summary information about the versions of an extension.
- list_type_versions(Client, Input, Options)
-
list_types(Client, Input)
Returns summary information about extension that have been registered with CloudFormation.
- list_types(Client, Input, Options)
-
record_handler_progress(Client, Input)
Reports progress of a resource handler to CloudFormation.
- record_handler_progress(Client, Input, Options)
-
register_type(Client, Input)
Registers an extension with the CloudFormation service.
- register_type(Client, Input, Options)
-
set_stack_policy(Client, Input)
Sets a stack policy for a specified stack.
- set_stack_policy(Client, Input, Options)
-
set_type_default_version(Client, Input)
Specify the default version of an extension.
- set_type_default_version(Client, Input, Options)
-
signal_resource(Client, Input)
Sends a signal to the specified resource with a success or failure status.
- signal_resource(Client, Input, Options)
-
stop_stack_set_operation(Client, Input)
Stops an in-progress operation on a stack set and its associated stack instances.
- stop_stack_set_operation(Client, Input, Options)
-
update_stack(Client, Input)
Updates a stack as specified in the template.
- update_stack(Client, Input, Options)
-
update_stack_instances(Client, Input)
Updates the parameter values for stack instances for the specified accounts, within the specified Regions.
- update_stack_instances(Client, Input, Options)
-
update_stack_set(Client, Input)
Updates the stack set, and associated stack instances in the specified accounts and Regions.
- update_stack_set(Client, Input, Options)
-
update_termination_protection(Client, Input)
Updates termination protection for the specified stack.
- update_termination_protection(Client, Input, Options)
-
validate_template(Client, Input)
Validates a specified template.
- validate_template(Client, Input, Options)
Functions
cancel_update_stack(Client, Input)
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.cancel_update_stack(Client, Input, Options)
continue_update_rollback(Client, Input)
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.
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.
continue_update_rollback(Client, Input, Options)
create_change_set(Client, Input)
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. To
create a change set for an import operation, specify IMPORT
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.
IncludeNestedStacks
to True
.
create_change_set(Client, Input, Options)
create_stack(Client, Input)
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 theDescribeStacks
API.
create_stack(Client, Input, Options)
create_stack_instances(Client, Input)
Creates stack instances for the specified accounts, within the specified Regions.
A stack instance refers to a stack in a specific account and Region. You must specify at least one value for eitherAccounts
or
DeploymentTargets
, and you must specify at least one value for
Regions
.
create_stack_instances(Client, Input, Options)
create_stack_set(Client, Input)
Creates a stack set.
create_stack_set(Client, Input, Options)
delete_change_set(Client, Input)
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.
IfIncludeNestedStacks
specifies True
during the creation of the
nested change set, then DeleteChangeSet
will delete all change sets that
belong to the stacks hierarchy and will also delete all change sets for
nested stacks with the status of REVIEW_IN_PROGRESS
.
delete_change_set(Client, Input, Options)
delete_stack(Client, Input)
Deletes a specified stack.
Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in theDescribeStacks
API if the deletion has been
completed successfully.
delete_stack(Client, Input, Options)
delete_stack_instances(Client, Input)
Deletes stack instances for the specified accounts, in the specified Regions.
delete_stack_instances(Client, Input, Options)
delete_stack_set(Client, Input)
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, seeDeleteStackInstances
.
delete_stack_set(Client, Input, Options)
deregister_type(Client, Input)
Marks an extension or extension version as DEPRECATED
in the
CloudFormation registry, removing it from active use.
Deprecated extensions or extension versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.
You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated.
To view the deprecation status of an extension or extension version, use DescribeType.deregister_type(Client, Input, Options)
describe_account_limits(Client, Input)
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.describe_account_limits(Client, Input, Options)
describe_change_set(Client, Input)
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.describe_change_set(Client, Input, Options)
describe_stack_drift_detection_status(Client, Input)
Returns information about a stack drift detection operation.
A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
UseDetectStackDrift
to initiate a stack drift detection operation.
DetectStackDrift
returns a StackDriftDetectionId
you can use to
monitor the progress of the operation using
DescribeStackDriftDetectionStatus
. Once the drift detection operation
has completed, use DescribeStackResourceDrifts
to return drift
information about the stack and its resources.
describe_stack_drift_detection_status(Client, Input, Options)
describe_stack_events(Client, Input)
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).describe_stack_events(Client, Input, Options)
describe_stack_instance(Client, Input)
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, useListStackInstances
.
describe_stack_instance(Client, Input, Options)
describe_stack_resource(Client, Input)
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.describe_stack_resource(Client, Input, Options)
describe_stack_resource_drifts(Client, Input)
Returns drift information for the resources that have been checked for drift in the specified stack.
This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift.
For a given stack, there will be one StackResourceDrift
for each stack
resource that has been checked for drift. Resources that have not yet been
checked for drift are not included. Resources that do not currently
support drift detection are not checked, and so not included. For a list
of resources that support drift detection, see Resources that Support
Drift Detection.
DetectStackResourceDrift
to detect drift on individual resources, or
DetectStackDrift
to detect drift on all supported resources for a given
stack.
describe_stack_resource_drifts(Client, Input, Options)
describe_stack_resources(Client, Input)
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.
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.
ValidationError
is returned if you specify both StackName
and
PhysicalResourceId
in the same request.
describe_stack_resources(Client, Input, Options)
describe_stack_set(Client, Input)
Returns the description of the specified stack set.
describe_stack_set(Client, Input, Options)
describe_stack_set_operation(Client, Input)
Returns the description of the specified stack set operation.
describe_stack_set_operation(Client, Input, Options)
describe_stacks(Client, Input)
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, anAmazonCloudFormationException
is
returned.
describe_stacks(Client, Input, Options)
describe_type(Client, Input)
Returns detailed information about an extension that has been registered.
If you specify aVersionId
, DescribeType
returns information about
that specific extension version. Otherwise, it returns information about
the default extension version.
describe_type(Client, Input, Options)
describe_type_registration(Client, Input)
Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using `RegisterType
', you can
then use `DescribeTypeRegistration
' to monitor the progress of that
registration request.
`DescribeType
' to
return detailed information about an extension.
describe_type_registration(Client, Input, Options)
detect_stack_drift(Client, Input)
Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters.
For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackDrift
to detect drift on all supported resources for a
given stack, or DetectStackResourceDrift
to detect drift on individual
resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.
DetectStackDrift
can take up to several minutes, depending on the number
of resources contained within the stack. Use
DescribeStackDriftDetectionStatus
to monitor the progress of a detect
stack drift operation. Once the drift detection operation has completed,
use DescribeStackResourceDrifts
to return drift information about the
stack and its resources.
DetectStackDrift
directly on the nested stack itself.
detect_stack_drift(Client, Input, Options)
detect_stack_resource_drift(Client, Input)
Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters.
This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Use DetectStackResourceDrift
to detect drift on individual resources, or
DetectStackDrift
to detect drift on all resources in a given stack that
support drift detection.
detect_stack_resource_drift(Client, Input, Options)
detect_stack_set_drift(Client, Input)
Detect drift on a stack set.
When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation Performs Drift Detection on a Stack Set.
DetectStackSetDrift
returns the OperationId
of the stack set drift
detection operation. Use this operation id with `DescribeStackSetOperation
' to monitor the progress of the drift
detection operation. The drift detection operation may take some time,
depending on the number of stack instances included in the stack set, as
well as the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
Use
`DescribeStackSet
' to return detailed information about the stack set, including detailed information about the last completed drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)Use
`ListStackInstances
' to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.Use
`DescribeStackInstance
' to return detailed information about a specific stack instance, including its drift status and last drift time checked.
For more information on performing a drift detection operation on a stack set, see Detecting Unmanaged Changes in Stack Sets.
You can only run a single drift detection operation on a given stack set at one time.
To stop a drift detection stack set operation, use`StopStackSetOperation
'.
detect_stack_set_drift(Client, Input, Options)
estimate_template_cost(Client, Input)
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.estimate_template_cost(Client, Input, Options)
execute_change_set(Client, Input)
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.
To create a change set for the entire stack hierachy,IncludeNestedStacks
must have been set to True
.
execute_change_set(Client, Input, Options)
get_stack_policy(Client, Input)
Returns the stack policy for a specified stack.
If a stack doesn't have a policy, a null value is returned.get_stack_policy(Client, Input, Options)
get_template(Client, Input)
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, aValidationError
is returned.
get_template(Client, Input, Options)
get_template_summary(Client, Input)
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.
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.
get_template_summary(Client, Input, Options)
list_change_sets(Client, Input)
Returns the ID and status of each active change set for a stack.
For example, AWS CloudFormation lists change sets that are in theCREATE_IN_PROGRESS
or CREATE_PENDING
state.
list_change_sets(Client, Input, Options)
list_exports(Client, Input)
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.
list_exports(Client, Input, Options)
list_imports(Client, Input)
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
.
Fn::ImportValue
function.
list_imports(Client, Input, Options)
list_stack_instances(Client, Input)
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, or that have a specific status.list_stack_instances(Client, Input, Options)
list_stack_resources(Client, Input)
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.list_stack_resources(Client, Input, Options)
list_stack_set_operation_results(Client, Input)
Returns summary information about the results of a stack set operation.
list_stack_set_operation_results(Client, Input, Options)
list_stack_set_operations(Client, Input)
Returns summary information about operations performed on a stack set.
list_stack_set_operations(Client, Input, Options)
list_stack_sets(Client, Input)
Returns summary information about stack sets that are associated with the user.
[Self-managed permissions] If you set the
CallAs
parameter toSELF
while signed in to your AWS account,ListStackSets
returns all self-managed stack sets in your AWS account.[Service-managed permissions] If you set the
CallAs
parameter toSELF
while signed in to the organization's management account,ListStackSets
returns all stack sets in the management account.[Service-managed permissions] If you set the
CallAs
parameter toDELEGATED_ADMIN
while signed in to your member account,ListStackSets
returns all stack sets with service-managed permissions in the management account.
list_stack_sets(Client, Input, Options)
list_stacks(Client, Input)
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).list_stacks(Client, Input, Options)
list_type_registrations(Client, Input)
Returns a list of registration tokens for the specified extension(s).
list_type_registrations(Client, Input, Options)
list_type_versions(Client, Input)
Returns summary information about the versions of an extension.
list_type_versions(Client, Input, Options)
list_types(Client, Input)
Returns summary information about extension that have been registered with CloudFormation.
list_types(Client, Input, Options)
record_handler_progress(Client, Input)
Reports progress of a resource handler to CloudFormation.
Reserved for use by the CloudFormation CLI. Do not use this API in your code.record_handler_progress(Client, Input, Options)
register_type(Client, Input)
Registers an extension with the CloudFormation service.
Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:
Validating the extension schema
Determining which handlers, if any, have been specified for the extension
Making the extension available for use in your account
For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.
You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.
Once you have initiated a registration request using`RegisterType
',
you can use `DescribeTypeRegistration
' to monitor the progress of the
registration request.
register_type(Client, Input, Options)
set_stack_policy(Client, Input)
Sets a stack policy for a specified stack.
set_stack_policy(Client, Input, Options)
set_type_default_version(Client, Input)
Specify the default version of an extension.
The default version of an extension will be used in CloudFormation operations.set_type_default_version(Client, Input, Options)
signal_resource(Client, Input)
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.signal_resource(Client, Input, Options)
stop_stack_set_operation(Client, Input)
Stops an in-progress operation on a stack set and its associated stack instances.
stop_stack_set_operation(Client, Input, Options)
update_stack(Client, Input)
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.
update_stack(Client, Input, Options)
update_stack_instances(Client, Input)
Updates the parameter values for stack instances for the specified accounts, within the specified Regions.
A stack instance refers to a stack in a specific account and Region.
You can only update stack instances in Regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.
During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.
You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value usingUpdateStackInstances
.
update_stack_instances(Client, Input, Options)
update_stack_set(Client, Input)
Updates the stack set, and associated stack instances in the specified accounts and Regions.
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. SubsequentCreateStackInstances
calls on the specified stack set use the updated
stack set.
update_stack_set(Client, Input, Options)
update_termination_protection(Client, Input)
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 AWS CloudFormation User Guide.
For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.update_termination_protection(Client, Input, Options)
validate_template(Client, Input)
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.