@datafire/amazonaws_cloudformation

DataFire integration for AWS CloudFormation

Usage no npm install needed!

<script type="module">
  import datafireAmazonawsCloudformation from 'https://cdn.skypack.dev/@datafire/amazonaws_cloudformation';
</script>

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

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

Output

Output schema unknown

ContinueUpdateRollback

amazonaws_cloudformation.ContinueUpdateRollback({
  "StackName": ""
}, context)

Input

Output

CreateChangeSet

amazonaws_cloudformation.CreateChangeSet({
  "StackName": "",
  "ChangeSetName": ""
}, context)

Input

Output

CreateStack

amazonaws_cloudformation.CreateStack({
  "StackName": ""
}, context)

Input

Output

CreateStackInstances

amazonaws_cloudformation.CreateStackInstances({
  "StackSetName": "",
  "Accounts": [],
  "Regions": []
}, context)

Input

Output

CreateStackSet

amazonaws_cloudformation.CreateStackSet({
  "StackSetName": ""
}, context)

Input

Output

DeleteChangeSet

amazonaws_cloudformation.DeleteChangeSet({
  "ChangeSetName": ""
}, context)

Input

Output

DeleteStack

amazonaws_cloudformation.DeleteStack({
  "StackName": ""
}, context)

Input

Output

Output schema unknown

DeleteStackInstances

amazonaws_cloudformation.DeleteStackInstances({
  "StackSetName": "",
  "Accounts": [],
  "Regions": [],
  "RetainStacks": true
}, context)

Input

Output

DeleteStackSet

amazonaws_cloudformation.DeleteStackSet({
  "StackSetName": ""
}, context)

Input

Output

DescribeAccountLimits

amazonaws_cloudformation.DescribeAccountLimits({}, context)

Input

Output

DescribeChangeSet

amazonaws_cloudformation.DescribeChangeSet({
  "ChangeSetName": ""
}, context)

Input

Output

DescribeStackEvents

amazonaws_cloudformation.DescribeStackEvents({}, context)

Input

Output

DescribeStackInstance

amazonaws_cloudformation.DescribeStackInstance({
  "StackSetName": "",
  "StackInstanceAccount": "",
  "StackInstanceRegion": ""
}, context)

Input

Output

DescribeStackResource

amazonaws_cloudformation.DescribeStackResource({
  "StackName": "",
  "LogicalResourceId": ""
}, context)

Input

Output

DescribeStackResources

amazonaws_cloudformation.DescribeStackResources({}, context)

Input

Output

DescribeStackSet

amazonaws_cloudformation.DescribeStackSet({
  "StackSetName": ""
}, context)

Input

Output

DescribeStackSetOperation

amazonaws_cloudformation.DescribeStackSetOperation({
  "StackSetName": "",
  "OperationId": ""
}, context)

Input

Output

DescribeStacks

amazonaws_cloudformation.DescribeStacks({}, context)

Input

Output

EstimateTemplateCost

amazonaws_cloudformation.EstimateTemplateCost({}, context)

Input

Output

ExecuteChangeSet

amazonaws_cloudformation.ExecuteChangeSet({
  "ChangeSetName": ""
}, context)

Input

Output

GetStackPolicy

amazonaws_cloudformation.GetStackPolicy({
  "StackName": ""
}, context)

Input

Output

GetTemplate

amazonaws_cloudformation.GetTemplate({}, context)

Input

Output

GetTemplateSummary

amazonaws_cloudformation.GetTemplateSummary({}, context)

Input

Output

ListChangeSets

amazonaws_cloudformation.ListChangeSets({
  "StackName": ""
}, context)

Input

Output

ListExports

amazonaws_cloudformation.ListExports({}, context)

Input

  • input object

Output

ListImports

amazonaws_cloudformation.ListImports({
  "ExportName": ""
}, context)

Input

Output

ListStackInstances

amazonaws_cloudformation.ListStackInstances({
  "StackSetName": ""
}, context)

Input

Output

ListStackResources

amazonaws_cloudformation.ListStackResources({
  "StackName": ""
}, context)

Input

Output

ListStackSetOperationResults

amazonaws_cloudformation.ListStackSetOperationResults({
  "StackSetName": "",
  "OperationId": ""
}, context)

Input

Output

ListStackSetOperations

amazonaws_cloudformation.ListStackSetOperations({
  "StackSetName": ""
}, context)

Input

Output

ListStackSets

amazonaws_cloudformation.ListStackSets({}, context)

Input

Output

ListStacks

amazonaws_cloudformation.ListStacks({}, context)

Input

Output

SetStackPolicy

amazonaws_cloudformation.SetStackPolicy({
  "StackName": ""
}, context)

Input

Output

Output schema unknown

SignalResource

amazonaws_cloudformation.SignalResource({
  "StackName": "",
  "LogicalResourceId": "",
  "UniqueId": "",
  "Status": ""
}, context)

Input

Output

Output schema unknown

StopStackSetOperation

amazonaws_cloudformation.StopStackSetOperation({
  "StackSetName": "",
  "OperationId": ""
}, context)

Input

Output

UpdateStack

amazonaws_cloudformation.UpdateStack({
  "StackName": ""
}, context)

Input

Output

UpdateStackInstances

amazonaws_cloudformation.UpdateStackInstances({
  "StackSetName": "",
  "Accounts": [],
  "Regions": []
}, context)

Input

Output

UpdateStackSet

amazonaws_cloudformation.UpdateStackSet({
  "StackSetName": ""
}, context)

Input

Output

UpdateTerminationProtection

amazonaws_cloudformation.UpdateTerminationProtection({
  "EnableTerminationProtection": true,
  "StackName": ""
}, context)

Input

Output

ValidateTemplate

amazonaws_cloudformation.ValidateTemplate({}, context)

Input

Output

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 to FAILED.

    For more information, see Configuring a target account gate.

AccountGateStatus

  • AccountGateStatus string (values: SUCCEEDED, FAILED, SKIPPED)

AccountGateStatusReason

  • AccountGateStatusReason string

AccountLimit

AccountLimitList

AccountList

AllowedValue

  • AllowedValue string

AllowedValues

AlreadyExistsException

  • AlreadyExistsException object: The resource with the name requested already exists.

Arn

  • Arn string

CancelUpdateStackInput

Capabilities

CapabilitiesReason

  • CapabilitiesReason string

Capability

  • Capability string (values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM)

CausingEntity

  • CausingEntity string

Change

  • Change object: The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.

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 the ListChangeSets action.

ChangeSetStatus

  • ChangeSetStatus string (values: CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_COMPLETE, DELETE_COMPLETE, FAILED)

ChangeSetStatusReason

  • ChangeSetStatusReason string

ChangeSetSummaries

ChangeSetSummary

ChangeSetType

  • ChangeSetType string (values: CREATE, UPDATE)

ChangeSource

  • ChangeSource string (values: ResourceReference, ParameterReference, ResourceAttribute, DirectModification, Automatic)

ChangeType

  • ChangeType string (values: Resource)

Changes

ClientRequestToken

  • ClientRequestToken string

ClientToken

  • ClientToken string

ContinueUpdateRollbackInput

ContinueUpdateRollbackOutput

CreateChangeSetInput

CreateChangeSetOutput

CreateStackInput

CreateStackInstancesInput

CreateStackInstancesOutput

CreateStackOutput

CreateStackSetInput

CreateStackSetOutput

  • CreateStackSetOutput object

CreatedButModifiedException

  • CreatedButModifiedException object: The specified resource exists, but has been changed.

CreationTime

  • CreationTime string

DeleteChangeSetInput

DeleteChangeSetOutput

DeleteStackInput

DeleteStackInstancesInput

DeleteStackInstancesOutput

DeleteStackSetInput

  • DeleteStackSetInput object

DeleteStackSetOutput

  • DeleteStackSetOutput object

DeletionTime

  • DeletionTime string

DescribeAccountLimitsInput

DescribeAccountLimitsOutput

DescribeChangeSetInput

DescribeChangeSetOutput

DescribeStackEventsInput

DescribeStackEventsOutput

DescribeStackInstanceInput

  • DescribeStackInstanceInput object

DescribeStackInstanceOutput

DescribeStackResourceInput

DescribeStackResourceOutput

DescribeStackResourcesInput

DescribeStackResourcesOutput

DescribeStackSetInput

  • DescribeStackSetInput object

DescribeStackSetOperationInput

DescribeStackSetOperationOutput

DescribeStackSetOutput

  • DescribeStackSetOutput object

DescribeStacksInput

DescribeStacksOutput

Description

  • Description string

DisableRollback

  • DisableRollback boolean

EnableTerminationProtection

  • EnableTerminationProtection boolean

EstimateTemplateCostInput

EstimateTemplateCostOutput

EvaluationType

  • EvaluationType string (values: Static, Dynamic)

EventId

  • EventId string

ExecuteChangeSetInput

ExecuteChangeSetOutput

ExecutionStatus

  • ExecutionStatus string (values: UNAVAILABLE, AVAILABLE, EXECUTE_IN_PROGRESS, EXECUTE_COMPLETE, EXECUTE_FAILED, OBSOLETE)

Export

  • Export object: The Export structure describes the exported output values for a stack.

ExportName

  • ExportName string

ExportValue

  • ExportValue string

Exports

FailureToleranceCount

  • FailureToleranceCount integer

FailureTolerancePercentage

  • FailureTolerancePercentage integer

GetStackPolicyInput

GetStackPolicyOutput

GetTemplateInput

GetTemplateOutput

GetTemplateSummaryInput

GetTemplateSummaryOutput

Imports

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 be CREATE_IN_PROGRESS, or the stack status might be UPDATE_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

ListChangeSetsOutput

ListExportsInput

  • ListExportsInput object

ListExportsOutput

ListImportsInput

ListImportsOutput

ListStackInstancesInput

ListStackInstancesOutput

ListStackResourcesInput

ListStackResourcesOutput

ListStackSetOperationResultsInput

ListStackSetOperationResultsOutput

ListStackSetOperationsInput

ListStackSetOperationsOutput

ListStackSetsInput

ListStackSetsOutput

ListStacksInput

ListStacksOutput

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

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

OutputKey

  • OutputKey string

OutputValue

  • OutputValue string

Outputs

Parameter

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 the AllowedValues property.

ParameterDeclaration

ParameterDeclarations

ParameterKey

  • ParameterKey string

ParameterType

  • ParameterType string

ParameterValue

  • ParameterValue string

Parameters

PhysicalResourceId

  • PhysicalResourceId string

PropertyName

  • PropertyName string

Reason

  • Reason string

Region

  • Region string

RegionList

  • RegionList array

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

ResourceChangeDetail

ResourceChangeDetails

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.

ResourceToSkip

  • ResourceToSkip string

ResourceType

  • ResourceType string

ResourceTypes

ResourcesToSkip

RetainResources

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.

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.
    • Arn required Arn
    • Type required Type

RollbackTriggers

Scope

SetStackPolicyInput

SignalResourceInput

Stack

StackEvent

StackEvents

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.

StackInstanceNotFoundException

  • StackInstanceNotFoundException object: The specified stack instance doesn't exist.

StackInstanceStatus

  • StackInstanceStatus string (values: CURRENT, OUTDATED, INOPERABLE)

StackInstanceSummaries

StackInstanceSummary

StackName

  • StackName string

StackNameOrId

  • StackNameOrId string

StackPolicyBody

  • StackPolicyBody string

StackPolicyDuringUpdateBody

  • StackPolicyDuringUpdateBody string

StackPolicyDuringUpdateURL

  • StackPolicyDuringUpdateURL string

StackPolicyURL

  • StackPolicyURL string

StackResource

StackResourceDetail

StackResourceSummaries

StackResourceSummary

StackResources

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.

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

StackSetOperationAction

  • StackSetOperationAction string (values: CREATE, UPDATE, DELETE)

StackSetOperationPreferences

StackSetOperationResultStatus

  • StackSetOperationResultStatus string (values: PENDING, RUNNING, SUCCEEDED, FAILED, CANCELLED)

StackSetOperationResultSummaries

StackSetOperationResultSummary

StackSetOperationStatus

  • StackSetOperationStatus string (values: RUNNING, SUCCEEDED, FAILED, STOPPING, STOPPED)

StackSetOperationSummaries

StackSetOperationSummary

StackSetStatus

  • StackSetStatus string (values: ACTIVE, DELETED)

StackSetSummaries

StackSetSummary

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

StackStatusReason

  • StackStatusReason string

StackSummaries

StackSummary

Stacks

  • Stacks array

StageList

StaleRequestException

  • StaleRequestException object: Another operation has been performed on this stack set since the specified operation was performed.

StopStackSetOperationInput

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

TemplateBody

  • TemplateBody string

TemplateDescription

  • TemplateDescription string

TemplateParameter

TemplateParameters

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

Type

  • Type string

UpdateStackInput

UpdateStackInstancesInput

UpdateStackInstancesOutput

UpdateStackOutput

UpdateStackSetInput

UpdateStackSetOutput

UpdateTerminationProtectionInput

  • UpdateTerminationProtectionInput object