ExAws.Cloudformation.Core
AWS CloudFormation
AWS CloudFormation
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and 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 this product, go to the 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 http://aws.amazon.com/documentation/.
Summary↑
Types ↑
capabilities :: [capability]
url :: binary
allowed_value :: binary
stack_name :: binary
create_stack_input :: [capabilities: capabilities, disable_rollback: disable_rollback, notification_ar_ns: notification_ar_ns, on_failure: on_failure, parameters: parameters, stack_name: stack_name, stack_policy_body: stack_policy_body, stack_policy_url: stack_policy_url, tags: tags, template_body: template_body, template_url: template_url, timeout_in_minutes: timeout_minutes]
stack_event :: [event_id: event_id, logical_resource_id: logical_resource_id, physical_resource_id: physical_resource_id, resource_properties: resource_properties, resource_status: resource_status, resource_status_reason: resource_status_reason, resource_type: resource_type, stack_id: stack_id, stack_name: stack_name, timestamp: timestamp]
parameter_constraints :: [{:allowed_values, allowed_values}]
resource_type :: binary
resource_signal_unique_id :: binary
parameter :: [parameter_key: parameter_key, parameter_value: parameter_value, use_previous_value: use_previous_value]
list_stack_resources_output :: [next_token: next_token, stack_resource_summaries: stack_resource_summaries]
parameter_type :: binary
creation_time :: integer
stack_events :: [stack_event]
describe_stack_resources_output :: [{:stack_resources, stack_resources}]
on_failure :: binary
describe_stack_events_output :: [next_token: next_token, stack_events: stack_events]
metadata :: binary
estimate_template_cost_input :: [parameters: parameters, template_body: template_body, template_url: template_url]
notification_arn :: binary
stack_status_reason :: binary
timeout_minutes :: integer
delete_stack_input :: [{:stack_name, stack_name}]
event_id :: binary
stack :: [capabilities: capabilities, creation_time: creation_time, description: description, disable_rollback: disable_rollback, last_updated_time: last_updated_time, notification_ar_ns: notification_ar_ns, outputs: outputs, parameters: parameters, stack_id: stack_id, stack_name: stack_name, stack_status: stack_status, stack_status_reason: stack_status_reason, tags: tags, timeout_in_minutes: timeout_minutes]
already_exists_exception :: []
parameter_value :: binary
stack_id :: binary
get_template_summary_input :: [stack_name: stack_name_or_id, template_body: template_body, template_url: template_url]
description :: binary
version :: binary
resource_properties :: binary
use_previous_template :: boolean
stack_resource_detail :: [description: description, last_updated_timestamp: timestamp, logical_resource_id: logical_resource_id, metadata: metadata, physical_resource_id: physical_resource_id, resource_status: resource_status, resource_status_reason: resource_status_reason, resource_type: resource_type, stack_id: stack_id, stack_name: stack_name]
validate_template_output :: [capabilities: capabilities, capabilities_reason: capabilities_reason, description: description, parameters: template_parameters]
timestamp :: integer
create_stack_output :: [{:stack_id, stack_id}]
stack_policy_body :: binary
get_template_summary_output :: [capabilities: capabilities, capabilities_reason: capabilities_reason, description: description, metadata: metadata, parameters: parameter_declarations, version: version]
stack_resource :: [description: description, logical_resource_id: logical_resource_id, physical_resource_id: physical_resource_id, resource_status: resource_status, resource_status_reason: resource_status_reason, resource_type: resource_type, stack_id: stack_id, stack_name: stack_name, timestamp: timestamp]
tag_value :: binary
template_body :: binary
describe_stack_resource_output :: [{:stack_resource_detail, stack_resource_detail}]
parameter_key :: binary
disable_rollback :: boolean
template_parameter :: [default_value: parameter_value, description: description, no_echo: no_echo, parameter_key: parameter_key]
resource_status :: binary
limit_exceeded_exception :: []
set_stack_policy_input :: [stack_name: stack_name, stack_policy_body: stack_policy_body, stack_policy_url: stack_policy_url]
stack_policy_url :: binary
cancel_update_stack_input :: [{:stack_name, stack_name}]
resource_status_reason :: binary
stack_name_or_id :: binary
output_key :: binary
list_stacks_input :: [next_token: next_token, stack_status_filter: stack_status_filter]
list_stacks_output :: [next_token: next_token, stack_summaries: stack_summaries]
get_template_output :: [{:template_body, template_body}]
template_description :: binary
capability :: binary
describe_stack_resource_input :: [logical_resource_id: logical_resource_id, stack_name: stack_name]
describe_stack_resources_input :: [logical_resource_id: logical_resource_id, physical_resource_id: physical_resource_id, stack_name: stack_name]
template_url :: binary
last_updated_time :: integer
deletion_time :: integer
logical_resource_id :: binary
describe_stacks_input :: [next_token: next_token, stack_name: stack_name]
parameters :: [parameter]
output_value :: binary
estimate_template_cost_output :: [{:url, url}]
parameter_declaration :: [default_value: parameter_value, description: description, no_echo: no_echo, parameter_constraints: parameter_constraints, parameter_key: parameter_key, parameter_type: parameter_type]
tag_key :: binary
resource_signal_status :: binary
update_stack_input :: [capabilities: capabilities, notification_ar_ns: notification_ar_ns, parameters: parameters, stack_name: stack_name, stack_policy_body: stack_policy_body, stack_policy_during_update_body: stack_policy_during_update_body, stack_policy_during_update_url: stack_policy_during_update_url, stack_policy_url: stack_policy_url, template_body: template_body, template_url: template_url, use_previous_template: use_previous_template]
describe_stack_events_input :: [next_token: next_token, stack_name: stack_name]
list_stack_resources_input :: [next_token: next_token, stack_name: stack_name]
validate_template_input :: [template_body: template_body, template_url: template_url]
no_echo :: boolean
update_stack_output :: [{:stack_id, stack_id}]
use_previous_value :: boolean
stack_resource_summary :: [last_updated_timestamp: timestamp, logical_resource_id: logical_resource_id, physical_resource_id: physical_resource_id, resource_status: resource_status, resource_status_reason: resource_status_reason, resource_type: resource_type]
output :: [description: description, output_key: output_key, output_value: output_value]
describe_stacks_output :: [next_token: next_token, stacks: stacks]
stack_summary :: [creation_time: creation_time, deletion_time: deletion_time, last_updated_time: last_updated_time, stack_id: stack_id, stack_name: stack_name, stack_status: stack_status, stack_status_reason: stack_status_reason, template_description: template_description]
stack_policy_during_update_body :: binary
get_stack_policy_output :: [{:stack_policy_body, stack_policy_body}]
get_template_input :: [{:stack_name, stack_name}]
next_token :: binary
get_stack_policy_input :: [{:stack_name, stack_name}]
stack_policy_during_update_url :: binary
signal_resource_input :: [logical_resource_id: logical_resource_id, stack_name: stack_name_or_id, status: resource_signal_status, unique_id: resource_signal_unique_id]
stack_status :: binary
capabilities_reason :: binary
physical_resource_id :: binary
Functions
Specs:
- cancel_update_stack(client :: ExAws.Cloudformation.t, input :: cancel_update_stack_input) :: ExAws.Request.Query.response_t
CancelUpdateStack
Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.
Note:Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.
Specs:
- cancel_update_stack!(client :: ExAws.Cloudformation.t, input :: cancel_update_stack_input) :: ExAws.Request.Query.success_t | no_return
Same as cancel_update_stack/2
but raise on error.
Specs:
- create_stack(client :: ExAws.Cloudformation.t, input :: create_stack_input) :: ExAws.Request.Query.response_t
CreateStack
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.
Specs:
- create_stack!(client :: ExAws.Cloudformation.t, input :: create_stack_input) :: ExAws.Request.Query.success_t | no_return
Same as create_stack/2
but raise on error.
Specs:
- delete_stack(client :: ExAws.Cloudformation.t, input :: delete_stack_input) :: ExAws.Request.Query.response_t
DeleteStack
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.
Specs:
- delete_stack!(client :: ExAws.Cloudformation.t, input :: delete_stack_input) :: ExAws.Request.Query.success_t | no_return
Same as delete_stack/2
but raise on error.
Specs:
- describe_stack_events(client :: ExAws.Cloudformation.t, input :: describe_stack_events_input) :: ExAws.Request.Query.response_t
DescribeStackEvents
Returns all stack related events for a specified stack. For more information about a stack’s event history, go to Stacks in the AWS CloudFormation User Guide.
Note:You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).
Specs:
- describe_stack_events!(client :: ExAws.Cloudformation.t, input :: describe_stack_events_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_stack_events/2
but raise on error.
Specs:
- describe_stack_resource(client :: ExAws.Cloudformation.t, input :: describe_stack_resource_input) :: ExAws.Request.Query.response_t
DescribeStackResource
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.
Specs:
- describe_stack_resource!(client :: ExAws.Cloudformation.t, input :: describe_stack_resource_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_stack_resource/2
but raise on error.
Specs:
- describe_stack_resources(client :: ExAws.Cloudformation.t, input :: describe_stack_resources_input) :: ExAws.Request.Query.response_t
DescribeStackResources
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.
Note: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.
Note:A ValidationError
is returned if you specify both StackName
and
PhysicalResourceId
in the same request.
Specs:
- describe_stack_resources!(client :: ExAws.Cloudformation.t, input :: describe_stack_resources_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_stack_resources/2
but raise on error.
Specs:
- describe_stacks(client :: ExAws.Cloudformation.t, input :: describe_stacks_input) :: ExAws.Request.Query.response_t
DescribeStacks
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
Specs:
- describe_stacks!(client :: ExAws.Cloudformation.t, input :: describe_stacks_input) :: ExAws.Request.Query.success_t | no_return
Same as describe_stacks/2
but raise on error.
Specs:
- estimate_template_cost(client :: ExAws.Cloudformation.t, input :: estimate_template_cost_input) :: ExAws.Request.Query.response_t
EstimateTemplateCost
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.
Specs:
- estimate_template_cost!(client :: ExAws.Cloudformation.t, input :: estimate_template_cost_input) :: ExAws.Request.Query.success_t | no_return
Same as estimate_template_cost/2
but raise on error.
Specs:
- get_stack_policy(client :: ExAws.Cloudformation.t, input :: get_stack_policy_input) :: ExAws.Request.Query.response_t
GetStackPolicy
Returns the stack policy for a specified stack. If a stack doesn’t have a policy, a null value is returned.
Specs:
- get_stack_policy!(client :: ExAws.Cloudformation.t, input :: get_stack_policy_input) :: ExAws.Request.Query.success_t | no_return
Same as get_stack_policy/2
but raise on error.
Specs:
- get_template(client :: ExAws.Cloudformation.t, input :: get_template_input) :: ExAws.Request.Query.response_t
GetTemplate
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.
Note: If the template does not exist, a ValidationError
is returned.
Specs:
- get_template!(client :: ExAws.Cloudformation.t, input :: get_template_input) :: ExAws.Request.Query.success_t | no_return
Same as get_template/2
but raise on error.
Specs:
- get_template_summary(client :: ExAws.Cloudformation.t, input :: get_template_summary_input) :: ExAws.Request.Query.response_t
GetTemplateSummary
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.
You can use the GetTemplateSummary
action when you submit a template, or
you can get template information for 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.
Specs:
- get_template_summary!(client :: ExAws.Cloudformation.t, input :: get_template_summary_input) :: ExAws.Request.Query.success_t | no_return
Same as get_template_summary/2
but raise on error.
Specs:
- list_stack_resources(client :: ExAws.Cloudformation.t, input :: list_stack_resources_input) :: ExAws.Request.Query.response_t
ListStackResources
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.
Specs:
- list_stack_resources!(client :: ExAws.Cloudformation.t, input :: list_stack_resources_input) :: ExAws.Request.Query.success_t | no_return
Same as list_stack_resources/2
but raise on error.
Specs:
- list_stacks(client :: ExAws.Cloudformation.t, input :: list_stacks_input) :: ExAws.Request.Query.response_t
ListStacks
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).
Specs:
- list_stacks!(client :: ExAws.Cloudformation.t, input :: list_stacks_input) :: ExAws.Request.Query.success_t | no_return
Same as list_stacks/2
but raise on error.
Specs:
- set_stack_policy(client :: ExAws.Cloudformation.t, input :: set_stack_policy_input) :: ExAws.Request.Query.response_t
SetStackPolicy
Sets a stack policy for a specified stack.
Specs:
- set_stack_policy!(client :: ExAws.Cloudformation.t, input :: set_stack_policy_input) :: ExAws.Request.Query.success_t | no_return
Same as set_stack_policy/2
but raise on error.
Specs:
- signal_resource(client :: ExAws.Cloudformation.t, input :: signal_resource_input) :: ExAws.Request.Query.response_t
SignalResource
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.
Specs:
- signal_resource!(client :: ExAws.Cloudformation.t, input :: signal_resource_input) :: ExAws.Request.Query.success_t | no_return
Same as signal_resource/2
but raise on error.
Specs:
- update_stack(client :: ExAws.Cloudformation.t, input :: update_stack_input) :: ExAws.Request.Query.response_t
UpdateStack
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.
Tags that were associated with this stack during creation time will still
be associated with the stack after an UpdateStack
operation.
For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.
Specs:
- update_stack!(client :: ExAws.Cloudformation.t, input :: update_stack_input) :: ExAws.Request.Query.success_t | no_return
Same as update_stack/2
but raise on error.
Specs:
- validate_template(client :: ExAws.Cloudformation.t, input :: validate_template_input) :: ExAws.Request.Query.response_t
ValidateTemplate
Validates a specified template.
Specs:
- validate_template!(client :: ExAws.Cloudformation.t, input :: validate_template_input) :: ExAws.Request.Query.success_t | no_return
Same as validate_template/2
but raise on error.