Amazon Web Services, Inc.

AWS CloudFormation

CloudFormation CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

CloudFormation
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and
repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective
applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The
template defines a collection of resources as a single unit called a stack. CloudFormation creates
and deletes all member resources of the stack together and manages all dependencies between
the resources for you.
For more information about CloudFormation, see the CloudFormation product page .
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com .

Endpoints 92

  • POSTActivate organizations access/#Action=ActivateOrganizationsAccess?Action=ActivateOrganizationsAccess&Version=2010-05-15Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to…
  • POSTActivate type/#Action=ActivateType?Action=ActivateType&Version=2010-05-15Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It…
  • POSTBatch describe type configurations/#Action=BatchDescribeTypeConfigurations?Action=BatchDescribeTypeConfigurations&Version=2010-05-15Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region. For more…
  • POSTCancel update stack/#Action=CancelUpdateStack?Action=CancelUpdateStack&Version=2010-05-15Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.…
  • POSTContinue update rollback/#Action=ContinueUpdateRollback?Action=ContinueUpdateRollback&Version=2010-05-15Continues rolling back a stack from UPDATE_ROLLBACK_FAILED to UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the…
  • POSTCreate change set/#Action=CreateChangeSet?Action=CreateChangeSet&Version=2010-05-15Creates 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…
  • POSTCreate generated template/#Action=CreateGeneratedTemplate?Action=CreateGeneratedTemplate&Version=2010-05-15Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the…
  • POSTCreate stack/#Action=CreateStack?Action=CreateStack&Version=2010-05-15Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack through…
  • POSTCreate stack instances/#Action=CreateStackInstances?Action=CreateStackInstances&Version=2010-05-15Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account…
  • POSTCreate stack refactor/#Action=CreateStackRefactor?Action=CreateStackRefactor&Version=2010-05-15Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.
  • POSTCreate stack set/#Action=CreateStackSet?Action=CreateStackSet&Version=2010-05-15Creates a StackSet.
  • POSTDeactivate organizations access/#Action=DeactivateOrganizationsAccess?Action=DeactivateOrganizationsAccess&Version=2010-05-15Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage…
  • POSTDeactivate type/#Action=DeactivateType?Action=DeactivateType&Version=2010-05-15Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it. Deactivating an extension…
  • POSTDelete change set/#Action=DeleteChangeSet?Action=DeleteChangeSet&Version=2010-05-15Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set. If the call successfully completes, CloudFormation…
  • POSTDelete generated template/#Action=DeleteGeneratedTemplate?Action=DeleteGeneratedTemplate&Version=2010-05-15Deleted a generated template.
  • POSTDelete stack/#Action=DeleteStack?Action=DeleteStack&Version=2010-05-15Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't show up in the DescribeStacks operation if the…
  • POSTDelete stack instances/#Action=DeleteStackInstances?Action=DeleteStackInstances&Version=2010-05-15Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions. The maximum number of organizational unit (OUs) supported by…
  • POSTDelete stack set/#Action=DeleteStackSet?Action=DeleteStackSet&Version=2010-05-15Deletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see…
  • POSTDeregister type/#Action=DeregisterType?Action=DeregisterType&Version=2010-05-15Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions…
  • POSTDescribe account limits/#Action=DescribeAccountLimits?Action=DescribeAccountLimits&Version=2010-05-15Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account…
  • POSTDescribe change set/#Action=DescribeChangeSet?Action=DescribeChangeSet&Version=2010-05-15Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Update…
  • POSTDescribe change set hooks/#Action=DescribeChangeSetHooks?Action=DescribeChangeSetHooks&Version=2010-05-15Returns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
  • POSTDescribe events/#Action=DescribeEvents?Action=DescribeEvents&Version=2010-05-15Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during…
  • POSTDescribe generated template/#Action=DescribeGeneratedTemplate?Action=DescribeGeneratedTemplate&Version=2010-05-15Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate…
  • POSTDescribe organizations access/#Action=DescribeOrganizationsAccess?Action=DescribeOrganizationsAccess&Version=2010-05-15Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by…
  • POSTDescribe publisher/#Action=DescribePublisher?Action=DescribePublisher&Version=2010-05-15Returns information about a CloudFormation extension publisher. If you don't supply a PublisherId , and you have registered as an extension publisher,…
  • POSTDescribe resource scan/#Action=DescribeResourceScan?Action=DescribeResourceScan&Version=2010-05-15Describes details of a resource scan.
  • POSTDescribe stack drift detection status/#Action=DescribeStackDriftDetectionStatus?Action=DescribeStackDriftDetectionStatus&Version=2010-05-15Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has…
  • POSTDescribe stack events/#Action=DescribeStackEvents?Action=DescribeStackEvents&Version=2010-05-15Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand…
  • POSTDescribe stack instance/#Action=DescribeStackInstance?Action=DescribeStackInstance&Version=2010-05-15Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region. For a list of stack…
  • POSTDescribe stack refactor/#Action=DescribeStackRefactor?Action=DescribeStackRefactor&Version=2010-05-15Describes the stack refactor status.
  • POSTDescribe stack resource/#Action=DescribeStackResource?Action=DescribeStackResource&Version=2010-05-15Returns a description of the specified resource in the specified stack. For deleted stacks, DescribeStackResource returns resource information for up to 90…
  • POSTDescribe stack resource drifts/#Action=DescribeStackResourceDrifts?Action=DescribeStackResourceDrifts&Version=2010-05-15Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values…
  • POSTDescribe stack resources/#Action=DescribeStackResources?Action=DescribeStackResources&Version=2010-05-15Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the…
  • POSTDescribe stack set/#Action=DescribeStackSet?Action=DescribeStackSet&Version=2010-05-15Returns the description of the specified StackSet. This API provides strongly consistent reads meaning it will always return the most up-to-date data.
  • POSTDescribe stack set operation/#Action=DescribeStackSetOperation?Action=DescribeStackSetOperation&Version=2010-05-15Returns the description of the specified StackSet operation. This API provides strongly consistent reads meaning it will always return the most up-to-date data.
  • POSTDescribe stacks/#Action=DescribeStacks?Action=DescribeStacks&Version=2010-05-15Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more…
  • POSTDescribe type/#Action=DescribeType?Action=DescribeType&Version=2010-05-15Returns detailed information about an extension from the CloudFormation registry in your current account and Region. If you specify a VersionId , DescribeType…
  • POSTDescribe type registration/#Action=DescribeTypeRegistration?Action=DescribeTypeRegistration&Version=2010-05-15Returns information about an extension's registration, including its current status and type and version identifiers. When you initiate a registration request…
  • POSTDetect stack drift/#Action=DetectStackDrift?Action=DetectStackDrift&Version=2010-05-15Detects whether a stack's actual configuration differs, or has drifted , from its expected configuration, as defined in the stack template and any values…
  • POSTDetect stack resource drift/#Action=DetectStackResourceDrift?Action=DetectStackResourceDrift&Version=2010-05-15Returns information about whether a resource's actual configuration differs, or has drifted , from its expected configuration, as defined in the stack…
  • POSTDetect stack set drift/#Action=DetectStackSetDrift?Action=DetectStackSetDrift&Version=2010-05-15Detect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack…
  • POSTEstimate template cost/#Action=EstimateTemplateCost?Action=EstimateTemplateCost&Version=2010-05-15Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes…
  • POSTExecute change set/#Action=ExecuteChangeSet?Action=ExecuteChangeSet&Version=2010-05-15Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation…
  • POSTExecute stack refactor/#Action=ExecuteStackRefactor?Action=ExecuteStackRefactor&Version=2010-05-15Executes the stack refactor operation.
  • POSTGet generated template/#Action=GetGeneratedTemplate?Action=GetGeneratedTemplate&Version=2010-05-15Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was…
  • POSTGet hook result/#Action=GetHookResult?Action=GetHookResult&Version=2010-05-15Retrieves detailed information and remediation guidance for a Hook invocation result. If the Hook uses a KMS key to encrypt annotations, callers of the…
  • POSTGet stack policy/#Action=GetStackPolicy?Action=GetStackPolicy&Version=2010-05-15Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
  • POSTGet template/#Action=GetTemplate?Action=GetTemplate&Version=2010-05-15Returns the template body for a specified stack. You can get the template for running or deleted stacks. For deleted stacks, GetTemplate returns the template…
  • POSTGet template summary/#Action=GetTemplateSummary?Action=GetTemplateSummary&Version=2010-05-15Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter…
  • POSTImport stacks to stack set/#Action=ImportStacksToStackSet?Action=ImportStacksToStackSet&Version=2010-05-15Import existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet in the same account as the source…
  • POSTList change sets/#Action=ListChangeSets?Action=ListChangeSets&Version=2010-05-15Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or…
  • POSTList exports/#Action=ListExports?Action=ListExports&Version=2010-05-15Lists 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…
  • POSTList generated templates/#Action=ListGeneratedTemplates?Action=ListGeneratedTemplates&Version=2010-05-15Lists your generated templates in this Region.
  • POSTList hook results/#Action=ListHookResults?Action=ListHookResults&Version=2010-05-15Returns summaries of invoked Hooks. For more information, see View invocation summaries for CloudFormation Hooks in the CloudFormation Hooks User Guide . This…
  • POSTList imports/#Action=ListImports?Action=ListImports&Version=2010-05-15Lists 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…
  • POSTList resource scan related resources/#Action=ListResourceScanRelatedResources?Action=ListResourceScanRelatedResources&Version=2010-05-15Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by…
  • POSTList resource scan resources/#Action=ListResourceScanResources?Action=ListResourceScanResources&Version=2010-05-15Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources…
  • POSTList resource scans/#Action=ListResourceScans?Action=ListResourceScans&Version=2010-05-15List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
  • POSTList stack instance resource drifts/#Action=ListStackInstanceResourceDrifts?Action=ListStackInstanceResourceDrifts&Version=2010-05-15Returns drift information for resources in a stack instance. ListStackInstanceResourceDrifts returns drift information for the most recent drift detection…
  • POSTList stack instances/#Action=ListStackInstances?Action=ListStackInstances&Version=2010-05-15Returns summary information about stack instances that are associated with the specified StackSet. You can filter for stack instances that are associated with…
  • POSTList stack refactor actions/#Action=ListStackRefactorActions?Action=ListStackRefactorActions&Version=2010-05-15Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.
  • POSTList stack refactors/#Action=ListStackRefactors?Action=ListStackRefactors&Version=2010-05-15Lists all account stack refactor operations and their statuses.
  • POSTList stack resources/#Action=ListStackResources?Action=ListStackResources&Version=2010-05-15Returns descriptions of all resources of the specified stack. For deleted stacks, ListStackResources returns resource information for up to 90 days after the…
  • POSTList stack set auto deployment targets/#Action=ListStackSetAutoDeploymentTargets?Action=ListStackSetAutoDeploymentTargets&Version=2010-05-15Returns summary information about deployment targets for a StackSet.
  • POSTList stack set operation results/#Action=ListStackSetOperationResults?Action=ListStackSetOperationResults&Version=2010-05-15Returns summary information about the results of a StackSet operation. This API provides eventually consistent reads meaning it may take some time but will…
  • POSTList stack set operations/#Action=ListStackSetOperations?Action=ListStackSetOperations&Version=2010-05-15Returns summary information about operations performed on a StackSet. This API provides eventually consistent reads meaning it may take some time but will…
  • POSTList stack sets/#Action=ListStackSets?Action=ListStackSets&Version=2010-05-15Returns summary information about StackSets that are associated with the user. This API provides strongly consistent reads meaning it will always return the…
  • POSTList stacks/#Action=ListStacks?Action=ListStacks&Version=2010-05-15Returns the summary information for stacks whose status matches the specified StackStatusFilter . Summary information for stacks that have been deleted is…
  • POSTList type registrations/#Action=ListTypeRegistrations?Action=ListTypeRegistrations&Version=2010-05-15Returns a list of registration tokens for the specified extension(s).
  • POSTList type versions/#Action=ListTypeVersions?Action=ListTypeVersions&Version=2010-05-15Returns summary information about the versions of an extension.
  • POSTList types/#Action=ListTypes?Action=ListTypes&Version=2010-05-15Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web…
  • POSTPublish type/#Action=PublishType?Action=PublishType&Version=2010-05-15Publishes the specified extension to the CloudFormation registry as a public extension in this Region. Public extensions are available for use by all…
  • POSTRecord handler progress/#Action=RecordHandlerProgress?Action=RecordHandlerProgress&Version=2010-05-15Reports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI . Don't use this API in your code.
  • POSTRegister publisher/#Action=RegisterPublisher?Action=RegisterPublisher&Version=2010-05-15Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation…
  • POSTRegister type/#Action=RegisterType?Action=RegisterType&Version=2010-05-15Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web…
  • POSTRemove alias/#Action=RemoveAlias?Action=RemoveAlias&Version=2010-05-15Removes an alias from a stack. After the alias is removed successfully, it can no longer be used to reference the stack in API calls.
  • POSTRollback stack/#Action=RollbackStack?Action=RollbackStack&Version=2010-05-15When specifying RollbackStack , you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack…
  • POSTSet alias/#Action=SetAlias?Action=SetAlias&Version=2010-05-15Assigns an alias to an existing stack. An alias is an alternative name for a stack that can be used in place of the stack name in any CloudFormation API call…
  • POSTSet stack policy/#Action=SetStackPolicy?Action=SetStackPolicy&Version=2010-05-15Sets a stack policy for a specified stack.
  • POSTSet type configuration/#Action=SetTypeConfiguration?Action=SetTypeConfiguration&Version=2010-05-15Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region. For more information, see Edit…
  • POSTSet type default version/#Action=SetTypeDefaultVersion?Action=SetTypeDefaultVersion&Version=2010-05-15Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
  • POSTSignal resource/#Action=SignalResource?Action=SignalResource&Version=2010-05-15Sends a signal to the specified resource with a success or failure status. You can use the SignalResource operation in conjunction with a creation policy or…
  • POSTStart resource scan/#Action=StartResourceScan?Action=StartResourceScan&Version=2010-05-15Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.
  • POSTStop stack set operation/#Action=StopStackSetOperation?Action=StopStackSetOperation&Version=2010-05-15Stops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait…
  • POSTTest type/#Action=TestType?Action=TestType&Version=2010-05-15Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. For resource types, this…
  • POSTUpdate generated template/#Action=UpdateGeneratedTemplate?Action=UpdateGeneratedTemplate&Version=2010-05-15Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and…
  • POSTUpdate stack/#Action=UpdateStack?Action=UpdateStack&Version=2010-05-15Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack through…
  • POSTUpdate stack instances/#Action=UpdateStackInstances?Action=UpdateStackInstances&Version=2010-05-15Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a…
  • POSTUpdate stack set/#Action=UpdateStackSet?Action=UpdateStackSet&Version=2010-05-15Updates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions. Even if the StackSet operation created by…
  • POSTUpdate termination protection/#Action=UpdateTerminationProtection?Action=UpdateTerminationProtection&Version=2010-05-15Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the…
  • POSTValidate template/#Action=ValidateTemplate?Action=ValidateTemplate&Version=2010-05-15Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML.…

API details

Base URL
https://cloudformation.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
92 operations on 92 pathsPOST 92
Description format
AWS Smithy model, API version 2010-05-15

How to test the AWS CloudFormation in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CloudFormation collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Activate organizations access” (POST /#Action=ActivateOrganizationsAccess?Action=ActivateOrganizationsAccess&Version=2010-05-15), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS CloudFormation?

CloudFormation CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use… It is listed under Developer tools and has 92 endpoints.

Who publishes the AWS CloudFormation?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS CloudFormation?

Requests go to https://cloudformation.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS CloudFormation?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS CloudFormation have?

92 operations on 92 paths (92 POST).

Is forking the AWS CloudFormation free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.