README
@datafire/amazonaws_cloudformation
Client library for AWS CloudFormation
Installation and Usage
npm install --save @datafire/amazonaws_cloudformation
let amazonaws_cloudformation = require('@datafire/amazonaws_cloudformation').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_cloudformation.CancelUpdateStack({
"StackName": ""
}).then(data => {
console.log(data);
});
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.
Actions
CancelUpdateStack
amazonaws_cloudformation.CancelUpdateStack({
"StackName": ""
}, context)
Input
- input
object
- ClientRequestToken ClientRequestToken
- StackName required StackName
Output
Output schema unknown
ContinueUpdateRollback
amazonaws_cloudformation.ContinueUpdateRollback({
"StackName": ""
}, context)
Input
- input
object
- ClientRequestToken ClientRequestToken
- ResourcesToSkip ResourcesToSkip
- RoleARN RoleARN
- StackName required StackNameOrId
Output
- output ContinueUpdateRollbackOutput
CreateChangeSet
amazonaws_cloudformation.CreateChangeSet({
"StackName": "",
"ChangeSetName": ""
}, context)
Input
- input
object
- Capabilities Capabilities
- ChangeSetName required ChangeSetName
- ChangeSetType ChangeSetType
- ClientToken ClientToken
- Description Description
- NotificationARNs NotificationARNs
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackNameOrId
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
Output
- output CreateChangeSetOutput
CreateStack
amazonaws_cloudformation.CreateStack({
"StackName": ""
}, context)
Input
- input
object
- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- DisableRollback DisableRollback
- EnableTerminationProtection EnableTerminationProtection
- NotificationARNs NotificationARNs
- OnFailure OnFailure
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyURL StackPolicyURL
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- TimeoutInMinutes TimeoutMinutes
Output
- output CreateStackOutput
CreateStackInstances
amazonaws_cloudformation.CreateStackInstances({
"StackSetName": "",
"Accounts": [],
"Regions": []
}, context)
Input
- input
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- ParameterOverrides Parameters
- Regions required RegionList
- StackSetName required StackSetName
Output
- output CreateStackInstancesOutput
CreateStackSet
amazonaws_cloudformation.CreateStackSet({
"StackSetName": ""
}, context)
Input
- input
object
- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- Description Description
- Parameters Parameters
- StackSetName required StackSetName
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
Output
- output CreateStackSetOutput
DeleteChangeSet
amazonaws_cloudformation.DeleteChangeSet({
"ChangeSetName": ""
}, context)
Input
- input
object
- ChangeSetName required ChangeSetNameOrId
- StackName StackNameOrId
Output
- output DeleteChangeSetOutput
DeleteStack
amazonaws_cloudformation.DeleteStack({
"StackName": ""
}, context)
Input
- input
object
- ClientRequestToken ClientRequestToken
- RetainResources RetainResources
- RoleARN RoleARN
- StackName required StackName
Output
Output schema unknown
DeleteStackInstances
amazonaws_cloudformation.DeleteStackInstances({
"StackSetName": "",
"Accounts": [],
"Regions": [],
"RetainStacks": true
}, context)
Input
- input
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- Regions required RegionList
- RetainStacks required RetainStacks
- StackSetName required StackSetName
Output
- output DeleteStackInstancesOutput
DeleteStackSet
amazonaws_cloudformation.DeleteStackSet({
"StackSetName": ""
}, context)
Input
- input
object
- StackSetName required StackSetName
Output
- output DeleteStackSetOutput
DescribeAccountLimits
amazonaws_cloudformation.DescribeAccountLimits({}, context)
Input
- input
object
- NextToken NextToken
Output
- output DescribeAccountLimitsOutput
DescribeChangeSet
amazonaws_cloudformation.DescribeChangeSet({
"ChangeSetName": ""
}, context)
Input
- input
object
- ChangeSetName required ChangeSetNameOrId
- NextToken NextToken
- StackName StackNameOrId
Output
- output DescribeChangeSetOutput
DescribeStackEvents
amazonaws_cloudformation.DescribeStackEvents({}, context)
Input
Output
- output DescribeStackEventsOutput
DescribeStackInstance
amazonaws_cloudformation.DescribeStackInstance({
"StackSetName": "",
"StackInstanceAccount": "",
"StackInstanceRegion": ""
}, context)
Input
- input
object
- StackInstanceAccount required Account
- StackInstanceRegion required Region
- StackSetName required StackSetName
Output
- output DescribeStackInstanceOutput
DescribeStackResource
amazonaws_cloudformation.DescribeStackResource({
"StackName": "",
"LogicalResourceId": ""
}, context)
Input
- input
object
- LogicalResourceId required LogicalResourceId
- StackName required StackName
Output
- output DescribeStackResourceOutput
DescribeStackResources
amazonaws_cloudformation.DescribeStackResources({}, context)
Input
- input
object
- LogicalResourceId LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- StackName StackName
Output
- output DescribeStackResourcesOutput
DescribeStackSet
amazonaws_cloudformation.DescribeStackSet({
"StackSetName": ""
}, context)
Input
- input
object
- StackSetName required StackSetName
Output
- output DescribeStackSetOutput
DescribeStackSetOperation
amazonaws_cloudformation.DescribeStackSetOperation({
"StackSetName": "",
"OperationId": ""
}, context)
Input
- input
object
- OperationId required ClientRequestToken
- StackSetName required StackSetName
Output
DescribeStacks
amazonaws_cloudformation.DescribeStacks({}, context)
Input
Output
- output DescribeStacksOutput
EstimateTemplateCost
amazonaws_cloudformation.EstimateTemplateCost({}, context)
Input
- input
object
- Parameters Parameters
- TemplateBody TemplateBody
- TemplateURL TemplateURL
Output
- output EstimateTemplateCostOutput
ExecuteChangeSet
amazonaws_cloudformation.ExecuteChangeSet({
"ChangeSetName": ""
}, context)
Input
- input
object
- ChangeSetName required ChangeSetNameOrId
- ClientRequestToken ClientRequestToken
- StackName StackNameOrId
Output
- output ExecuteChangeSetOutput
GetStackPolicy
amazonaws_cloudformation.GetStackPolicy({
"StackName": ""
}, context)
Input
- input
object
- StackName required StackName
Output
- output GetStackPolicyOutput
GetTemplate
amazonaws_cloudformation.GetTemplate({}, context)
Input
- input
object
- ChangeSetName ChangeSetNameOrId
- StackName StackName
- TemplateStage TemplateStage
Output
- output GetTemplateOutput
GetTemplateSummary
amazonaws_cloudformation.GetTemplateSummary({}, context)
Input
- input
object
- StackName StackNameOrId
- StackSetName StackSetNameOrId
- TemplateBody TemplateBody
- TemplateURL TemplateURL
Output
- output GetTemplateSummaryOutput
ListChangeSets
amazonaws_cloudformation.ListChangeSets({
"StackName": ""
}, context)
Input
- input
object
- NextToken NextToken
- StackName required StackNameOrId
Output
- output ListChangeSetsOutput
ListExports
amazonaws_cloudformation.ListExports({}, context)
Input
- input
object
- NextToken
string
- NextToken NextToken
- NextToken
Output
- output ListExportsOutput
ListImports
amazonaws_cloudformation.ListImports({
"ExportName": ""
}, context)
Input
- input
object
- NextToken
string
- ExportName required ExportName
- NextToken NextToken
- NextToken
Output
- output ListImportsOutput
ListStackInstances
amazonaws_cloudformation.ListStackInstances({
"StackSetName": ""
}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- StackInstanceAccount Account
- StackInstanceRegion Region
- StackSetName required StackSetName
Output
- output ListStackInstancesOutput
ListStackResources
amazonaws_cloudformation.ListStackResources({
"StackName": ""
}, context)
Input
Output
- output ListStackResourcesOutput
ListStackSetOperationResults
amazonaws_cloudformation.ListStackSetOperationResults({
"StackSetName": "",
"OperationId": ""
}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- OperationId required ClientRequestToken
- StackSetName required StackSetName
Output
ListStackSetOperations
amazonaws_cloudformation.ListStackSetOperations({
"StackSetName": ""
}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- StackSetName required StackSetName
Output
- output ListStackSetOperationsOutput
ListStackSets
amazonaws_cloudformation.ListStackSets({}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
- Status StackSetStatus
Output
- output ListStackSetsOutput
ListStacks
amazonaws_cloudformation.ListStacks({}, context)
Input
- input
object
- NextToken
string
- NextToken NextToken
- StackStatusFilter StackStatusFilter
- NextToken
Output
- output ListStacksOutput
SetStackPolicy
amazonaws_cloudformation.SetStackPolicy({
"StackName": ""
}, context)
Input
- input
object
- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyURL StackPolicyURL
Output
Output schema unknown
SignalResource
amazonaws_cloudformation.SignalResource({
"StackName": "",
"LogicalResourceId": "",
"UniqueId": "",
"Status": ""
}, context)
Input
- input
object
- LogicalResourceId required LogicalResourceId
- StackName required StackNameOrId
- Status required ResourceSignalStatus
- UniqueId required ResourceSignalUniqueId
Output
Output schema unknown
StopStackSetOperation
amazonaws_cloudformation.StopStackSetOperation({
"StackSetName": "",
"OperationId": ""
}, context)
Input
- input
object
- OperationId required ClientRequestToken
- StackSetName required StackSetName
Output
- output StopStackSetOperationOutput
UpdateStack
amazonaws_cloudformation.UpdateStack({
"StackName": ""
}, context)
Input
- input
object
- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- NotificationARNs NotificationARNs
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyDuringUpdateBody StackPolicyDuringUpdateBody
- StackPolicyDuringUpdateURL StackPolicyDuringUpdateURL
- StackPolicyURL StackPolicyURL
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
Output
- output UpdateStackOutput
UpdateStackInstances
amazonaws_cloudformation.UpdateStackInstances({
"StackSetName": "",
"Accounts": [],
"Regions": []
}, context)
Input
- input
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- ParameterOverrides Parameters
- Regions required RegionList
- StackSetName required StackSetName
Output
- output UpdateStackInstancesOutput
UpdateStackSet
amazonaws_cloudformation.UpdateStackSet({
"StackSetName": ""
}, context)
Input
- input
object
- Capabilities Capabilities
- Description Description
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- Parameters Parameters
- StackSetName required StackSetName
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
Output
- output UpdateStackSetOutput
UpdateTerminationProtection
amazonaws_cloudformation.UpdateTerminationProtection({
"EnableTerminationProtection": true,
"StackName": ""
}, context)
Input
- input
object
- EnableTerminationProtection required EnableTerminationProtection
- StackName required StackNameOrId
Output
ValidateTemplate
amazonaws_cloudformation.ValidateTemplate({}, context)
Input
- input
object
- TemplateBody TemplateBody
- TemplateURL TemplateURL
Output
- output ValidateTemplateOutput
Definitions
Account
- Account
string
AccountGateResult
- AccountGateResult
object
: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.
- Status AccountGateStatus
- StatusReason AccountGateStatusReason
AccountGateStatus
- AccountGateStatus
string
(values: SUCCEEDED, FAILED, SKIPPED)
AccountGateStatusReason
- AccountGateStatusReason
string
AccountLimit
- AccountLimit
object
: The AccountLimit data type.- Name LimitName
- Value LimitValue
AccountLimitList
- AccountLimitList
array
- items AccountLimit
AccountList
- AccountList
array
- items Account
AllowedValue
- AllowedValue
string
AllowedValues
- AllowedValues
array
- items AllowedValue
AlreadyExistsException
- AlreadyExistsException
object
: The resource with the name requested already exists.
Arn
- Arn
string
CancelUpdateStackInput
- CancelUpdateStackInput
object
: The input for the CancelUpdateStack action.- ClientRequestToken ClientRequestToken
- StackName required StackName
Capabilities
- Capabilities
array
- items Capability
CapabilitiesReason
- CapabilitiesReason
string
Capability
- Capability
string
(values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM)
CausingEntity
- CausingEntity
string
Change
- Change
object
: TheChange
structure describes the changes AWS CloudFormation will perform if you execute the change set.- ResourceChange ResourceChange
- Type ChangeType
ChangeAction
- ChangeAction
string
(values: Add, Modify, Remove)
ChangeSetId
- ChangeSetId
string
ChangeSetName
- ChangeSetName
string
ChangeSetNameOrId
- ChangeSetNameOrId
string
ChangeSetNotFoundException
- ChangeSetNotFoundException
object
: The specified change set name or ID doesn't exit. To view valid change sets for a stack, use theListChangeSets
action.
ChangeSetStatus
- ChangeSetStatus
string
(values: CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, DELETE_COMPLETE, FAILED)
ChangeSetStatusReason
- ChangeSetStatusReason
string
ChangeSetSummaries
- ChangeSetSummaries
array
- items ChangeSetSummary
ChangeSetSummary
- ChangeSetSummary
object
: TheChangeSetSummary
structure describes a change set, its status, and the stack with which it's associated.- ChangeSetId ChangeSetId
- ChangeSetName ChangeSetName
- CreationTime CreationTime
- Description Description
- ExecutionStatus ExecutionStatus
- StackId StackId
- StackName StackName
- Status ChangeSetStatus
- StatusReason ChangeSetStatusReason
ChangeSetType
- ChangeSetType
string
(values: CREATE, UPDATE)
ChangeSource
- ChangeSource
string
(values: ResourceReference, ParameterReference, ResourceAttribute, DirectModification, Automatic)
ChangeType
- ChangeType
string
(values: Resource)
Changes
- Changes
array
- items Change
ClientRequestToken
- ClientRequestToken
string
ClientToken
- ClientToken
string
ContinueUpdateRollbackInput
- ContinueUpdateRollbackInput
object
: The input for the ContinueUpdateRollback action.- ClientRequestToken ClientRequestToken
- ResourcesToSkip ResourcesToSkip
- RoleARN RoleARN
- StackName required StackNameOrId
ContinueUpdateRollbackOutput
- ContinueUpdateRollbackOutput
object
: The output for a ContinueUpdateRollback action.
CreateChangeSetInput
- CreateChangeSetInput
object
: The input for the CreateChangeSet action.- Capabilities Capabilities
- ChangeSetName required ChangeSetName
- ChangeSetType ChangeSetType
- ClientToken ClientToken
- Description Description
- NotificationARNs NotificationARNs
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackNameOrId
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
CreateChangeSetOutput
- CreateChangeSetOutput
object
: The output for the CreateChangeSet action.- Id ChangeSetId
- StackId StackId
CreateStackInput
- CreateStackInput
object
: The input for CreateStack action.- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- DisableRollback DisableRollback
- EnableTerminationProtection EnableTerminationProtection
- NotificationARNs NotificationARNs
- OnFailure OnFailure
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyURL StackPolicyURL
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- TimeoutInMinutes TimeoutMinutes
CreateStackInstancesInput
- CreateStackInstancesInput
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- ParameterOverrides Parameters
- Regions required RegionList
- StackSetName required StackSetName
CreateStackInstancesOutput
- CreateStackInstancesOutput
object
- OperationId ClientRequestToken
CreateStackOutput
- CreateStackOutput
object
: The output for a CreateStack action.- StackId StackId
CreateStackSetInput
- CreateStackSetInput
object
- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- Description Description
- Parameters Parameters
- StackSetName required StackSetName
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
CreateStackSetOutput
- CreateStackSetOutput
object
- StackSetId StackSetId
CreatedButModifiedException
- CreatedButModifiedException
object
: The specified resource exists, but has been changed.
CreationTime
- CreationTime
string
DeleteChangeSetInput
- DeleteChangeSetInput
object
: The input for the DeleteChangeSet action.- ChangeSetName required ChangeSetNameOrId
- StackName StackNameOrId
DeleteChangeSetOutput
- DeleteChangeSetOutput
object
: The output for the DeleteChangeSet action.
DeleteStackInput
- DeleteStackInput
object
: The input for DeleteStack action.- ClientRequestToken ClientRequestToken
- RetainResources RetainResources
- RoleARN RoleARN
- StackName required StackName
DeleteStackInstancesInput
- DeleteStackInstancesInput
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- Regions required RegionList
- RetainStacks required RetainStacks
- StackSetName required StackSetName
DeleteStackInstancesOutput
- DeleteStackInstancesOutput
object
- OperationId ClientRequestToken
DeleteStackSetInput
- DeleteStackSetInput
object
- StackSetName required StackSetName
DeleteStackSetOutput
- DeleteStackSetOutput
object
DeletionTime
- DeletionTime
string
DescribeAccountLimitsInput
- DescribeAccountLimitsInput
object
: The input for the DescribeAccountLimits action.- NextToken NextToken
DescribeAccountLimitsOutput
- DescribeAccountLimitsOutput
object
: The output for the DescribeAccountLimits action.- AccountLimits AccountLimitList
- NextToken NextToken
DescribeChangeSetInput
- DescribeChangeSetInput
object
: The input for the DescribeChangeSet action.- ChangeSetName required ChangeSetNameOrId
- NextToken NextToken
- StackName StackNameOrId
DescribeChangeSetOutput
- DescribeChangeSetOutput
object
: The output for the DescribeChangeSet action.- Capabilities Capabilities
- ChangeSetId ChangeSetId
- ChangeSetName ChangeSetName
- Changes Changes
- CreationTime CreationTime
- Description Description
- ExecutionStatus ExecutionStatus
- NextToken NextToken
- NotificationARNs NotificationARNs
- Parameters Parameters
- RollbackConfiguration RollbackConfiguration
- StackId StackId
- StackName StackName
- Status ChangeSetStatus
- StatusReason ChangeSetStatusReason
- Tags Tags
DescribeStackEventsInput
- DescribeStackEventsInput
object
: The input for DescribeStackEvents action.
DescribeStackEventsOutput
- DescribeStackEventsOutput
object
: The output for a DescribeStackEvents action.- NextToken NextToken
- StackEvents StackEvents
DescribeStackInstanceInput
- DescribeStackInstanceInput
object
- StackInstanceAccount required Account
- StackInstanceRegion required Region
- StackSetName required StackSetName
DescribeStackInstanceOutput
- DescribeStackInstanceOutput
object
- StackInstance StackInstance
DescribeStackResourceInput
- DescribeStackResourceInput
object
: The input for DescribeStackResource action.- LogicalResourceId required LogicalResourceId
- StackName required StackName
DescribeStackResourceOutput
- DescribeStackResourceOutput
object
: The output for a DescribeStackResource action.- StackResourceDetail StackResourceDetail
DescribeStackResourcesInput
- DescribeStackResourcesInput
object
: The input for DescribeStackResources action.- LogicalResourceId LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- StackName StackName
DescribeStackResourcesOutput
- DescribeStackResourcesOutput
object
: The output for a DescribeStackResources action.- StackResources StackResources
DescribeStackSetInput
- DescribeStackSetInput
object
- StackSetName required StackSetName
DescribeStackSetOperationInput
- DescribeStackSetOperationInput
object
- OperationId required ClientRequestToken
- StackSetName required StackSetName
DescribeStackSetOperationOutput
- DescribeStackSetOperationOutput
object
- StackSetOperation StackSetOperation
DescribeStackSetOutput
- DescribeStackSetOutput
object
- StackSet StackSet
DescribeStacksInput
- DescribeStacksInput
object
: The input for DescribeStacks action.
DescribeStacksOutput
- DescribeStacksOutput
object
: The output for a DescribeStacks action.
Description
- Description
string
DisableRollback
- DisableRollback
boolean
EnableTerminationProtection
- EnableTerminationProtection
boolean
EstimateTemplateCostInput
- EstimateTemplateCostInput
object
: The input for an EstimateTemplateCost action.- Parameters Parameters
- TemplateBody TemplateBody
- TemplateURL TemplateURL
EstimateTemplateCostOutput
- EstimateTemplateCostOutput
object
: The output for a EstimateTemplateCost action.- Url Url
EvaluationType
- EvaluationType
string
(values: Static, Dynamic)
EventId
- EventId
string
ExecuteChangeSetInput
- ExecuteChangeSetInput
object
: The input for the ExecuteChangeSet action.- ChangeSetName required ChangeSetNameOrId
- ClientRequestToken ClientRequestToken
- StackName StackNameOrId
ExecuteChangeSetOutput
- ExecuteChangeSetOutput
object
: The output for the ExecuteChangeSet action.
ExecutionStatus
- ExecutionStatus
string
(values: UNAVAILABLE, AVAILABLE, EXECUTE_IN_PROGRESS, EXECUTE_COMPLETE, EXECUTE_FAILED, OBSOLETE)
Export
- Export
object
: TheExport
structure describes the exported output values for a stack.- ExportingStackId StackId
- Name ExportName
- Value ExportValue
ExportName
- ExportName
string
ExportValue
- ExportValue
string
Exports
- Exports
array
- items Export
FailureToleranceCount
- FailureToleranceCount
integer
FailureTolerancePercentage
- FailureTolerancePercentage
integer
GetStackPolicyInput
- GetStackPolicyInput
object
: The input for the GetStackPolicy action.- StackName required StackName
GetStackPolicyOutput
- GetStackPolicyOutput
object
: The output for the GetStackPolicy action.- StackPolicyBody StackPolicyBody
GetTemplateInput
- GetTemplateInput
object
: The input for a GetTemplate action.- ChangeSetName ChangeSetNameOrId
- StackName StackName
- TemplateStage TemplateStage
GetTemplateOutput
- GetTemplateOutput
object
: The output for GetTemplate action.- StagesAvailable StageList
- TemplateBody TemplateBody
GetTemplateSummaryInput
- GetTemplateSummaryInput
object
: The input for the GetTemplateSummary action.- StackName StackNameOrId
- StackSetName StackSetNameOrId
- TemplateBody TemplateBody
- TemplateURL TemplateURL
GetTemplateSummaryOutput
- GetTemplateSummaryOutput
object
: The output for the GetTemplateSummary action.- Capabilities Capabilities
- CapabilitiesReason CapabilitiesReason
- DeclaredTransforms TransformsList
- Description Description
- Metadata Metadata
- Parameters ParameterDeclarations
- ResourceTypes ResourceTypes
- Version Version
Imports
- Imports
array
- items StackName
InsufficientCapabilitiesException
- InsufficientCapabilitiesException
object
: The template contains resources with capabilities that weren't specified in the Capabilities parameter.
InvalidChangeSetStatusException
- InvalidChangeSetStatusException
object
: The specified change set can't be used to update the stack. For example, the change set status might beCREATE_IN_PROGRESS
, or the stack status might beUPDATE_IN_PROGRESS
.
InvalidOperationException
- InvalidOperationException
object
: The specified operation isn't valid.
LastUpdatedTime
- LastUpdatedTime
string
LimitExceededException
- LimitExceededException
object
:The quota for the resource has already been reached.
For information on stack set limitations, see Limitations of StackSets.
LimitName
- LimitName
string
LimitValue
- LimitValue
integer
ListChangeSetsInput
- ListChangeSetsInput
object
: The input for the ListChangeSets action.- NextToken NextToken
- StackName required StackNameOrId
ListChangeSetsOutput
- ListChangeSetsOutput
object
: The output for the ListChangeSets action.- NextToken NextToken
- Summaries ChangeSetSummaries
ListExportsInput
- ListExportsInput
object
- NextToken NextToken
ListExportsOutput
ListImportsInput
- ListImportsInput
object
- ExportName required ExportName
- NextToken NextToken
ListImportsOutput
ListStackInstancesInput
- ListStackInstancesInput
object
- MaxResults MaxResults
- NextToken NextToken
- StackInstanceAccount Account
- StackInstanceRegion Region
- StackSetName required StackSetName
ListStackInstancesOutput
- ListStackInstancesOutput
object
- NextToken NextToken
- Summaries StackInstanceSummaries
ListStackResourcesInput
- ListStackResourcesInput
object
: The input for the ListStackResource action.
ListStackResourcesOutput
- ListStackResourcesOutput
object
: The output for a ListStackResources action.- NextToken NextToken
- StackResourceSummaries StackResourceSummaries
ListStackSetOperationResultsInput
- ListStackSetOperationResultsInput
object
- MaxResults MaxResults
- NextToken NextToken
- OperationId required ClientRequestToken
- StackSetName required StackSetName
ListStackSetOperationResultsOutput
- ListStackSetOperationResultsOutput
object
- NextToken NextToken
- Summaries StackSetOperationResultSummaries
ListStackSetOperationsInput
- ListStackSetOperationsInput
object
- MaxResults MaxResults
- NextToken NextToken
- StackSetName required StackSetName
ListStackSetOperationsOutput
- ListStackSetOperationsOutput
object
- NextToken NextToken
- Summaries StackSetOperationSummaries
ListStackSetsInput
- ListStackSetsInput
object
- MaxResults MaxResults
- NextToken NextToken
- Status StackSetStatus
ListStackSetsOutput
- ListStackSetsOutput
object
- NextToken NextToken
- Summaries StackSetSummaries
ListStacksInput
- ListStacksInput
object
: The input for ListStacks action.- NextToken NextToken
- StackStatusFilter StackStatusFilter
ListStacksOutput
- ListStacksOutput
object
: The output for ListStacks action.- NextToken NextToken
- StackSummaries StackSummaries
LogicalResourceId
- LogicalResourceId
string
MaxConcurrentCount
- MaxConcurrentCount
integer
MaxConcurrentPercentage
- MaxConcurrentPercentage
integer
MaxResults
- MaxResults
integer
Metadata
- Metadata
string
MonitoringTimeInMinutes
- MonitoringTimeInMinutes
integer
NameAlreadyExistsException
- NameAlreadyExistsException
object
: The specified name is already in use.
NextToken
- NextToken
string
NoEcho
- NoEcho
boolean
NotificationARN
- NotificationARN
string
NotificationARNs
- NotificationARNs
array
- items NotificationARN
OnFailure
- OnFailure
string
(values: DO_NOTHING, ROLLBACK, DELETE)
OperationIdAlreadyExistsException
- OperationIdAlreadyExistsException
object
: The specified operation ID already exists.
OperationInProgressException
- OperationInProgressException
object
: Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.
OperationNotFoundException
- OperationNotFoundException
object
: The specified ID refers to an operation that doesn't exist.
Output
- Output
object
: The Output data type.- Description Description
- ExportName ExportName
- OutputKey OutputKey
- OutputValue OutputValue
OutputKey
- OutputKey
string
OutputValue
- OutputValue
string
Outputs
- Outputs
array
- items Output
Parameter
- Parameter
object
: The Parameter data type.- ParameterKey ParameterKey
- ParameterValue ParameterValue
- ResolvedValue ParameterValue
- UsePreviousValue UsePreviousValue
ParameterConstraints
- ParameterConstraints
object
: 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 theAllowedValues
property.- AllowedValues AllowedValues
ParameterDeclaration
- ParameterDeclaration
object
: The ParameterDeclaration data type.- DefaultValue ParameterValue
- Description Description
- NoEcho NoEcho
- ParameterConstraints ParameterConstraints
- ParameterKey ParameterKey
- ParameterType ParameterType
ParameterDeclarations
- ParameterDeclarations
array
- items ParameterDeclaration
ParameterKey
- ParameterKey
string
ParameterType
- ParameterType
string
ParameterValue
- ParameterValue
string
Parameters
- Parameters
array
- items Parameter
PhysicalResourceId
- PhysicalResourceId
string
PropertyName
- PropertyName
string
Reason
- Reason
string
Region
- Region
string
RegionList
- RegionList
array
- items Region
Replacement
- Replacement
string
(values: True, False, Conditional)
RequiresRecreation
- RequiresRecreation
string
(values: Never, Conditionally, Always)
ResourceAttribute
- ResourceAttribute
string
(values: Properties, Metadata, CreationPolicy, UpdatePolicy, DeletionPolicy, Tags)
ResourceChange
- ResourceChange
object
: TheResourceChange
structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.- Action ChangeAction
- Details ResourceChangeDetails
- LogicalResourceId LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- Replacement Replacement
- ResourceType ResourceType
- Scope Scope
ResourceChangeDetail
- ResourceChangeDetail
object
: For a resource withModify
as the action, theResourceChange
structure describes the changes AWS CloudFormation will make to that resource.- CausingEntity CausingEntity
- ChangeSource ChangeSource
- Evaluation EvaluationType
- Target ResourceTargetDefinition
ResourceChangeDetails
- ResourceChangeDetails
array
- items ResourceChangeDetail
ResourceProperties
- ResourceProperties
string
ResourceSignalStatus
- ResourceSignalStatus
string
(values: SUCCESS, FAILURE)
ResourceSignalUniqueId
- ResourceSignalUniqueId
string
ResourceStatus
- ResourceStatus
string
(values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, DELETE_SKIPPED, UPDATE_IN_PROGRESS, UPDATE_FAILED, UPDATE_COMPLETE)
ResourceStatusReason
- ResourceStatusReason
string
ResourceTargetDefinition
- ResourceTargetDefinition
object
: The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.- Attribute ResourceAttribute
- Name PropertyName
- RequiresRecreation RequiresRecreation
ResourceToSkip
- ResourceToSkip
string
ResourceType
- ResourceType
string
ResourceTypes
- ResourceTypes
array
- items ResourceType
ResourcesToSkip
- ResourcesToSkip
array
- items ResourceToSkip
RetainResources
- RetainResources
array
- items LogicalResourceId
RetainStacks
- RetainStacks
boolean
RetainStacksNullable
- RetainStacksNullable
boolean
RoleARN
- RoleARN
string
RollbackConfiguration
- RollbackConfiguration
object
: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 each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.
By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as
breaching
. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.
- MonitoringTimeInMinutes MonitoringTimeInMinutes
- RollbackTriggers RollbackTriggers
RollbackTrigger
- RollbackTrigger
object
: A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALERT state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
RollbackTriggers
- RollbackTriggers
array
- items RollbackTrigger
Scope
- Scope
array
- items ResourceAttribute
SetStackPolicyInput
- SetStackPolicyInput
object
: The input for the SetStackPolicy action.- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyURL StackPolicyURL
SignalResourceInput
- SignalResourceInput
object
: The input for the SignalResource action.- LogicalResourceId required LogicalResourceId
- StackName required StackNameOrId
- Status required ResourceSignalStatus
- UniqueId required ResourceSignalUniqueId
Stack
- Stack
object
: The Stack data type.- Capabilities Capabilities
- ChangeSetId ChangeSetId
- CreationTime required CreationTime
- DeletionTime DeletionTime
- Description Description
- DisableRollback DisableRollback
- EnableTerminationProtection EnableTerminationProtection
- LastUpdatedTime LastUpdatedTime
- NotificationARNs NotificationARNs
- Outputs Outputs
- Parameters Parameters
- ParentId StackId
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- RootId StackId
- StackId StackId
- StackName required StackName
- StackStatus required StackStatus
- StackStatusReason StackStatusReason
- Tags Tags
- TimeoutInMinutes TimeoutMinutes
StackEvent
- StackEvent
object
: The StackEvent data type.- ClientRequestToken ClientRequestToken
- EventId required EventId
- LogicalResourceId LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- ResourceProperties ResourceProperties
- ResourceStatus ResourceStatus
- ResourceStatusReason ResourceStatusReason
- ResourceType ResourceType
- StackId required StackId
- StackName required StackName
- Timestamp required Timestamp
StackEvents
- StackEvents
array
- items StackEvent
StackId
- StackId
string
StackInstance
- StackInstance
object
: 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.- Account Account
- ParameterOverrides Parameters
- Region Region
- StackId StackId
- StackSetId StackSetId
- Status StackInstanceStatus
- StatusReason Reason
StackInstanceNotFoundException
- StackInstanceNotFoundException
object
: The specified stack instance doesn't exist.
StackInstanceStatus
- StackInstanceStatus
string
(values: CURRENT, OUTDATED, INOPERABLE)
StackInstanceSummaries
- StackInstanceSummaries
array
- items StackInstanceSummary
StackInstanceSummary
- StackInstanceSummary
object
: The structure that contains summary information about a stack instance.- Account Account
- Region Region
- StackId StackId
- StackSetId StackSetId
- Status StackInstanceStatus
- StatusReason Reason
StackName
- StackName
string
StackNameOrId
- StackNameOrId
string
StackPolicyBody
- StackPolicyBody
string
StackPolicyDuringUpdateBody
- StackPolicyDuringUpdateBody
string
StackPolicyDuringUpdateURL
- StackPolicyDuringUpdateURL
string
StackPolicyURL
- StackPolicyURL
string
StackResource
- StackResource
object
: The StackResource data type.- Description Description
- LogicalResourceId required LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- ResourceStatus required ResourceStatus
- ResourceStatusReason ResourceStatusReason
- ResourceType required ResourceType
- StackId StackId
- StackName StackName
- Timestamp required Timestamp
StackResourceDetail
- StackResourceDetail
object
: Contains detailed information about the specified stack resource.- Description Description
- LastUpdatedTimestamp required Timestamp
- LogicalResourceId required LogicalResourceId
- Metadata Metadata
- PhysicalResourceId PhysicalResourceId
- ResourceStatus required ResourceStatus
- ResourceStatusReason ResourceStatusReason
- ResourceType required ResourceType
- StackId StackId
- StackName StackName
StackResourceSummaries
- StackResourceSummaries
array
- items StackResourceSummary
StackResourceSummary
- StackResourceSummary
object
: Contains high-level information about the specified stack resource.- LastUpdatedTimestamp required Timestamp
- LogicalResourceId required LogicalResourceId
- PhysicalResourceId PhysicalResourceId
- ResourceStatus required ResourceStatus
- ResourceStatusReason ResourceStatusReason
- ResourceType required ResourceType
StackResources
- StackResources
array
- items StackResource
StackSet
- StackSet
object
: 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.- Capabilities Capabilities
- Description Description
- Parameters Parameters
- StackSetId StackSetId
- StackSetName StackSetName
- Status StackSetStatus
- Tags Tags
- TemplateBody TemplateBody
StackSetId
- StackSetId
string
StackSetName
- StackSetName
string
StackSetNameOrId
- StackSetNameOrId
string
StackSetNotEmptyException
- StackSetNotEmptyException
object
: You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.
StackSetNotFoundException
- StackSetNotFoundException
object
: The specified stack set doesn't exist.
StackSetOperation
- StackSetOperation
object
: The structure that contains information about a stack set operation.- Action StackSetOperationAction
- CreationTimestamp Timestamp
- EndTimestamp Timestamp
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- RetainStacks RetainStacksNullable
- StackSetId StackSetId
- Status StackSetOperationStatus
StackSetOperationAction
- StackSetOperationAction
string
(values: CREATE, UPDATE, DELETE)
StackSetOperationPreferences
- StackSetOperationPreferences
object
: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.
- FailureToleranceCount FailureToleranceCount
- FailureTolerancePercentage FailureTolerancePercentage
- MaxConcurrentCount MaxConcurrentCount
- MaxConcurrentPercentage MaxConcurrentPercentage
- RegionOrder RegionList
StackSetOperationResultStatus
- StackSetOperationResultStatus
string
(values: PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED)
StackSetOperationResultSummaries
- StackSetOperationResultSummaries
array
StackSetOperationResultSummary
- StackSetOperationResultSummary
object
: The structure that contains information about a specified operation's results for a given account in a given region.- Account Account
- AccountGateResult AccountGateResult
- Region Region
- Status StackSetOperationResultStatus
- StatusReason Reason
StackSetOperationStatus
- StackSetOperationStatus
string
(values: RUNNING, SUCCEEDED, FAILED, STOPPING, STOPPED)
StackSetOperationSummaries
- StackSetOperationSummaries
array
- items StackSetOperationSummary
StackSetOperationSummary
- StackSetOperationSummary
object
: The structures that contain summary information about the specified operation.- Action StackSetOperationAction
- CreationTimestamp Timestamp
- EndTimestamp Timestamp
- OperationId ClientRequestToken
- Status StackSetOperationStatus
StackSetStatus
- StackSetStatus
string
(values: ACTIVE, DELETED)
StackSetSummaries
- StackSetSummaries
array
- items StackSetSummary
StackSetSummary
- StackSetSummary
object
: The structures that contain summary information about the specified stack set.- Description Description
- StackSetId StackSetId
- StackSetName StackSetName
- Status StackSetStatus
StackStatus
- StackStatus
string
(values: CREATE_IN_PROGRESS, CREATE_FAILED, CREATE_COMPLETE, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETE_COMPLETE, UPDATE_IN_PROGRESS, UPDATE_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_ROLLBACK_IN_PROGRESS, UPDATE_ROLLBACK_FAILED, UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS, UPDATE_ROLLBACK_COMPLETE, REVIEW_IN_PROGRESS)
StackStatusFilter
- StackStatusFilter
array
- items StackStatus
StackStatusReason
- StackStatusReason
string
StackSummaries
- StackSummaries
array
- items StackSummary
StackSummary
- StackSummary
object
: The StackSummary Data Type- CreationTime required CreationTime
- DeletionTime DeletionTime
- LastUpdatedTime LastUpdatedTime
- ParentId StackId
- RootId StackId
- StackId StackId
- StackName required StackName
- StackStatus required StackStatus
- StackStatusReason StackStatusReason
- TemplateDescription TemplateDescription
Stacks
- Stacks
array
- items Stack
StageList
- StageList
array
- items TemplateStage
StaleRequestException
- StaleRequestException
object
: Another operation has been performed on this stack set since the specified operation was performed.
StopStackSetOperationInput
- StopStackSetOperationInput
object
- OperationId required ClientRequestToken
- StackSetName required StackSetName
StopStackSetOperationOutput
- StopStackSetOperationOutput
object
Tag
- Tag
object
: The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
TagKey
- TagKey
string
TagValue
- TagValue
string
Tags
- Tags
array
- items Tag
TemplateBody
- TemplateBody
string
TemplateDescription
- TemplateDescription
string
TemplateParameter
- TemplateParameter
object
: The TemplateParameter data type.- DefaultValue ParameterValue
- Description Description
- NoEcho NoEcho
- ParameterKey ParameterKey
TemplateParameters
- TemplateParameters
array
- items TemplateParameter
TemplateStage
- TemplateStage
string
(values: Original, Processed)
TemplateURL
- TemplateURL
string
TimeoutMinutes
- TimeoutMinutes
integer
Timestamp
- Timestamp
string
TokenAlreadyExistsException
- TokenAlreadyExistsException
object
: A client request token already exists.
TransformName
- TransformName
string
TransformsList
- TransformsList
array
- items TransformName
Type
- Type
string
UpdateStackInput
- UpdateStackInput
object
: The input for an UpdateStack action.- Capabilities Capabilities
- ClientRequestToken ClientRequestToken
- NotificationARNs NotificationARNs
- Parameters Parameters
- ResourceTypes ResourceTypes
- RoleARN RoleARN
- RollbackConfiguration RollbackConfiguration
- StackName required StackName
- StackPolicyBody StackPolicyBody
- StackPolicyDuringUpdateBody StackPolicyDuringUpdateBody
- StackPolicyDuringUpdateURL StackPolicyDuringUpdateURL
- StackPolicyURL StackPolicyURL
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
UpdateStackInstancesInput
- UpdateStackInstancesInput
object
- Accounts required AccountList
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- ParameterOverrides Parameters
- Regions required RegionList
- StackSetName required StackSetName
UpdateStackInstancesOutput
- UpdateStackInstancesOutput
object
- OperationId ClientRequestToken
UpdateStackOutput
- UpdateStackOutput
object
: The output for an UpdateStack action.- StackId StackId
UpdateStackSetInput
- UpdateStackSetInput
object
- Capabilities Capabilities
- Description Description
- OperationId ClientRequestToken
- OperationPreferences StackSetOperationPreferences
- Parameters Parameters
- StackSetName required StackSetName
- Tags Tags
- TemplateBody TemplateBody
- TemplateURL TemplateURL
- UsePreviousTemplate UsePreviousTemplate
UpdateStackSetOutput
- UpdateStackSetOutput
object
- OperationId ClientRequestToken
UpdateTerminationProtectionInput
- UpdateTerminationProtectionInput
object
- EnableTerminationProtection required EnableTerminationProtection
- StackName required [StackNameOrId](#sta