Expand description
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.
If you’re using the service, you’re probably looking for CloudFormationClient and CloudFormation.
Structs§
- Account
Gate Result Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.
For each account and Region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns
FAILED, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region toFAILED.For more information, see Configuring a target account gate.
- Account
Limit The AccountLimit data type.
CloudFormation has the following limits per account:
-
Number of concurrent resources
-
Number of stacks
-
Number of stack outputs
For more information about these account limits, and other CloudFormation limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.
-
- Activate
Type Input - Activate
Type Output - Auto
Deployment [Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
- Batch
Describe Type Configurations Input - Batch
Describe Type Configurations Output - Cancel
Update Stack Input The input for the CancelUpdateStack action.
- Change
The
Changestructure describes the changes AWS CloudFormation will perform if you execute the change set.- Change
SetSummary The
ChangeSetSummarystructure describes a change set, its status, and the stack with which it's associated.- Cloud
Formation Batch Describe Type Configurations Error Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
- Cloud
Formation Client - A client for the AWS CloudFormation API.
- Continue
Update Rollback Input The input for the ContinueUpdateRollback action.
- Continue
Update Rollback Output The output for a ContinueUpdateRollback action.
- Create
Change SetInput The input for the CreateChangeSet action.
- Create
Change SetOutput The output for the CreateChangeSet action.
- Create
Stack Input The input for CreateStack action.
- Create
Stack Instances Input - Create
Stack Instances Output - Create
Stack Output The output for a CreateStack action.
- Create
Stack SetInput - Create
Stack SetOutput - Deactivate
Type Input - Deactivate
Type Output - Delete
Change SetInput The input for the DeleteChangeSet action.
- Delete
Change SetOutput The output for the DeleteChangeSet action.
- Delete
Stack Input The input for DeleteStack action.
- Delete
Stack Instances Input - Delete
Stack Instances Output - Delete
Stack SetInput - Delete
Stack SetOutput - Deployment
Targets [Service-managed permissions] The AWS Organizations accounts to which StackSets deploys. StackSets does not deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
For update operations, you can specify either
AccountsorOrganizationalUnitIds. For create and delete operations, specifyOrganizationalUnitIds.- Deregister
Type Input - Deregister
Type Output - Describe
Account Limits Input The input for the DescribeAccountLimits action.
- Describe
Account Limits Output The output for the DescribeAccountLimits action.
- Describe
Change SetInput The input for the DescribeChangeSet action.
- Describe
Change SetOutput The output for the DescribeChangeSet action.
- Describe
Publisher Input - Describe
Publisher Output - Describe
Stack Drift Detection Status Input - Describe
Stack Drift Detection Status Output - Describe
Stack Events Input The input for DescribeStackEvents action.
- Describe
Stack Events Output The output for a DescribeStackEvents action.
- Describe
Stack Instance Input - Describe
Stack Instance Output - Describe
Stack Resource Drifts Input - Describe
Stack Resource Drifts Output - Describe
Stack Resource Input The input for DescribeStackResource action.
- Describe
Stack Resource Output The output for a DescribeStackResource action.
- Describe
Stack Resources Input The input for DescribeStackResources action.
- Describe
Stack Resources Output The output for a DescribeStackResources action.
- Describe
Stack SetInput - Describe
Stack SetOperation Input - Describe
Stack SetOperation Output - Describe
Stack SetOutput - Describe
Stacks Input The input for DescribeStacks action.
- Describe
Stacks Output The output for a DescribeStacks action.
- Describe
Type Input - Describe
Type Output - Describe
Type Registration Input - Describe
Type Registration Output - Detect
Stack Drift Input - Detect
Stack Drift Output - Detect
Stack Resource Drift Input - Detect
Stack Resource Drift Output - Detect
Stack SetDrift Input - Detect
Stack SetDrift Output - Estimate
Template Cost Input The input for an EstimateTemplateCost action.
- Estimate
Template Cost Output The output for a EstimateTemplateCost action.
- Execute
Change SetInput The input for the ExecuteChangeSet action.
- Execute
Change SetOutput The output for the ExecuteChangeSet action.
- Export
The
Exportstructure describes the exported output values for a stack.- GetStack
Policy Input The input for the GetStackPolicy action.
- GetStack
Policy Output The output for the GetStackPolicy action.
- GetTemplate
Input The input for a GetTemplate action.
- GetTemplate
Output The output for GetTemplate action.
- GetTemplate
Summary Input The input for the GetTemplateSummary action.
- GetTemplate
Summary Output The output for the GetTemplateSummary action.
- List
Change Sets Input The input for the ListChangeSets action.
- List
Change Sets Output The output for the ListChangeSets action.
- List
Exports Input - List
Exports Output - List
Imports Input - List
Imports Output - List
Stack Instances Input - List
Stack Instances Output - List
Stack Resources Input The input for the ListStackResource action.
- List
Stack Resources Output The output for a ListStackResources action.
- List
Stack SetOperation Results Input - List
Stack SetOperation Results Output - List
Stack SetOperations Input - List
Stack SetOperations Output - List
Stack Sets Input - List
Stack Sets Output - List
Stacks Input The input for ListStacks action.
- List
Stacks Output The output for ListStacks action.
- List
Type Registrations Input - List
Type Registrations Output - List
Type Versions Input - List
Type Versions Output - List
Types Input - List
Types Output - Logging
Config Contains logging configuration information for an extension.
- Module
Info Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
For more information on modules, see Using modules to encapsulate and reuse resource configurations in the CloudFormation User Guide.
- Output
The Output data type.
- Parameter
The Parameter data type.
- Parameter
Constraints A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the
AllowedValuesproperty.- Parameter
Declaration The ParameterDeclaration data type.
- Physical
Resource IdContext KeyValue Pair Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.
- Property
Difference Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose
StackResourceDriftStatusisMODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.- Publish
Type Input - Publish
Type Output - Record
Handler Progress Input - Record
Handler Progress Output - Register
Publisher Input - Register
Publisher Output - Register
Type Input - Register
Type Output - Required
Activated Type For extensions that are modules, a public third-party extension that must be activated in your account in order for the module itself to be activated.
For more information, see Activating public modules for use in your account in the AWS CloudFormation User Guide.
- Resource
Change The
ResourceChangestructure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.- Resource
Change Detail For a resource with
Modifyas the action, theResourceChangestructure describes the changes AWS CloudFormation will make to that resource.- Resource
Identifier Summary Describes the target resources of a specific type in your import template (for example, all
AWS::S3::Bucketresources) and the properties you can provide during the import to identify resources of that type.- Resource
Target Definition The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
- Resource
ToImport Describes the target resource of an import operation.
- Rollback
Configuration Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.
- Rollback
Trigger A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
- SetStack
Policy Input The input for the SetStackPolicy action.
- SetType
Configuration Input - SetType
Configuration Output - SetType
Default Version Input - SetType
Default Version Output - Signal
Resource Input The input for the SignalResource action.
- Stack
The Stack data type.
- Stack
Drift Information Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.
- Stack
Drift Information Summary Contains information about whether the stack's actual configuration differs, or has drifted, from its 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.
- Stack
Event The StackEvent data type.
- Stack
Instance An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.
- Stack
Instance Comprehensive Status The detailed status of the stack instance.
- Stack
Instance Filter The status that stack instances are filtered by.
- Stack
Instance Summary The structure that contains summary information about a stack instance.
- Stack
Resource The StackResource data type.
- Stack
Resource Detail Contains detailed information about the specified stack resource.
- Stack
Resource Drift Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
- Stack
Resource Drift Information Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
- Stack
Resource Drift Information Summary Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.
- Stack
Resource Summary Contains high-level information about the specified stack resource.
- Stack
Set A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.
- Stack
SetDrift Detection Details Detailed information about the drift status of the stack set.
For stack sets, contains information about the last completed drift operation performed on the stack set. Information about drift operations in-progress is not included.
For stack set operations, includes information about drift operations currently being performed on the stack set.
For more information, see Detecting Unmanaged Changes in Stack Sets in the AWS CloudFormation User Guide.
- Stack
SetOperation The structure that contains information about a stack set operation.
- Stack
SetOperation Preferences The user-specified preferences for how AWS CloudFormation performs a stack set operation.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
- Stack
SetOperation Result Summary The structure that contains information about a specified operation's results for a given account in a given Region.
- Stack
SetOperation Summary The structures that contain summary information about the specified operation.
- Stack
SetSummary The structures that contain summary information about the specified stack set.
- Stack
Summary The StackSummary Data Type
- Stop
Stack SetOperation Input - Stop
Stack SetOperation Output - Tag
The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
- Template
Parameter The TemplateParameter data type.
- Test
Type Input - Test
Type Output - Type
Configuration Details Detailed information concerning the specification of a CloudFormation extension in a given account and region.
For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
- Type
Configuration Identifier Identifying information for the configuration of a CloudFormation extension.
- Type
Filters Filter criteria to use in determining which extensions to return.
- Type
Summary Contains summary information about the specified CloudFormation extension.
- Type
Version Summary Contains summary information about a specific version of a CloudFormation extension.
- Update
Stack Input The input for an UpdateStack action.
- Update
Stack Instances Input - Update
Stack Instances Output - Update
Stack Output The output for an UpdateStack action.
- Update
Stack SetInput - Update
Stack SetOutput - Update
Termination Protection Input - Update
Termination Protection Output - Validate
Template Input The input for ValidateTemplate action.
- Validate
Template Output The output for ValidateTemplate action.
Enums§
- Activate
Type Error - Errors returned by ActivateType
- Batch
Describe Type Configurations Error - Errors returned by BatchDescribeTypeConfigurations
- Cancel
Update Stack Error - Errors returned by CancelUpdateStack
- Continue
Update Rollback Error - Errors returned by ContinueUpdateRollback
- Create
Change SetError - Errors returned by CreateChangeSet
- Create
Stack Error - Errors returned by CreateStack
- Create
Stack Instances Error - Errors returned by CreateStackInstances
- Create
Stack SetError - Errors returned by CreateStackSet
- Deactivate
Type Error - Errors returned by DeactivateType
- Delete
Change SetError - Errors returned by DeleteChangeSet
- Delete
Stack Error - Errors returned by DeleteStack
- Delete
Stack Instances Error - Errors returned by DeleteStackInstances
- Delete
Stack SetError - Errors returned by DeleteStackSet
- Deregister
Type Error - Errors returned by DeregisterType
- Describe
Account Limits Error - Errors returned by DescribeAccountLimits
- Describe
Change SetError - Errors returned by DescribeChangeSet
- Describe
Publisher Error - Errors returned by DescribePublisher
- Describe
Stack Drift Detection Status Error - Errors returned by DescribeStackDriftDetectionStatus
- Describe
Stack Events Error - Errors returned by DescribeStackEvents
- Describe
Stack Instance Error - Errors returned by DescribeStackInstance
- Describe
Stack Resource Drifts Error - Errors returned by DescribeStackResourceDrifts
- Describe
Stack Resource Error - Errors returned by DescribeStackResource
- Describe
Stack Resources Error - Errors returned by DescribeStackResources
- Describe
Stack SetError - Errors returned by DescribeStackSet
- Describe
Stack SetOperation Error - Errors returned by DescribeStackSetOperation
- Describe
Stacks Error - Errors returned by DescribeStacks
- Describe
Type Error - Errors returned by DescribeType
- Describe
Type Registration Error - Errors returned by DescribeTypeRegistration
- Detect
Stack Drift Error - Errors returned by DetectStackDrift
- Detect
Stack Resource Drift Error - Errors returned by DetectStackResourceDrift
- Detect
Stack SetDrift Error - Errors returned by DetectStackSetDrift
- Estimate
Template Cost Error - Errors returned by EstimateTemplateCost
- Execute
Change SetError - Errors returned by ExecuteChangeSet
- GetStack
Policy Error - Errors returned by GetStackPolicy
- GetTemplate
Error - Errors returned by GetTemplate
- GetTemplate
Summary Error - Errors returned by GetTemplateSummary
- List
Change Sets Error - Errors returned by ListChangeSets
- List
Exports Error - Errors returned by ListExports
- List
Imports Error - Errors returned by ListImports
- List
Stack Instances Error - Errors returned by ListStackInstances
- List
Stack Resources Error - Errors returned by ListStackResources
- List
Stack SetOperation Results Error - Errors returned by ListStackSetOperationResults
- List
Stack SetOperations Error - Errors returned by ListStackSetOperations
- List
Stack Sets Error - Errors returned by ListStackSets
- List
Stacks Error - Errors returned by ListStacks
- List
Type Registrations Error - Errors returned by ListTypeRegistrations
- List
Type Versions Error - Errors returned by ListTypeVersions
- List
Types Error - Errors returned by ListTypes
- Publish
Type Error - Errors returned by PublishType
- Record
Handler Progress Error - Errors returned by RecordHandlerProgress
- Register
Publisher Error - Errors returned by RegisterPublisher
- Register
Type Error - Errors returned by RegisterType
- SetStack
Policy Error - Errors returned by SetStackPolicy
- SetType
Configuration Error - Errors returned by SetTypeConfiguration
- SetType
Default Version Error - Errors returned by SetTypeDefaultVersion
- Signal
Resource Error - Errors returned by SignalResource
- Stop
Stack SetOperation Error - Errors returned by StopStackSetOperation
- Test
Type Error - Errors returned by TestType
- Update
Stack Error - Errors returned by UpdateStack
- Update
Stack Instances Error - Errors returned by UpdateStackInstances
- Update
Stack SetError - Errors returned by UpdateStackSet
- Update
Termination Protection Error - Errors returned by UpdateTerminationProtection
- Validate
Template Error - Errors returned by ValidateTemplate
Traits§
- Cloud
Formation - Trait representing the capabilities of the AWS CloudFormation API. AWS CloudFormation clients implement this trait.