Official `aws-lite` plugin for CloudFormation
npm install @aws-lite/cloudformation@aws-lite/cloudformation> Official aws-lite plugin for CloudFormation
> Maintained by: @architect
``sh`
npm i @aws-lite/cloudformation
Optionally install types:
`sh`
npm i -D @aws-lite/cloudformation-types
Reference documentation with examples at aws-lite.org
Reference documentation with examples at aws-lite.org
Properties:
- StackName (string) [required]
- Stack name or ID
- Capabilities (array)
- Array of CloudFormation capabilities necessary for stack creation; can be any of: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- (string)[a-zA-Z0-9][-a-zA-Z0-9]*
- Unique identifier for this request; from 1 - 128b matching
- (boolean)EnableTerminationProtection
- Set to true to disable rollback of the stack if stack creation failed
- (boolean)NotificationARNs
- Enable protection against stack deletion
- More details (AWS)
- (array)OnFailure
- Array of SNS topic ARNs to publish stack related events
- (string)DO_NOTHING
- Action to be taken if stack creation failes; can be one of: , ROLLBACK, DELETE
- (array)ResourceTypes
- Array of objects specifying stack input parameters
- More details (AWS)
- (array)RetainExceptOnCreate
- Array of CloudFormation template resource types with permissions for this create stack action
- More details (AWS)
- (boolean)Retain
- Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of
- (string)RollbackConfiguration
- IAM role ARN CloudFormation assumes to create the stack
- (object)StackPolicyBody
- Rollback triggers to be monitored during creation and updating
- More details (AWS)
- (string, object)StackPolicyURL
- Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON
- More details (AWS)
- (string)Tags
- Stack policy url
- (array)TemplateBody
- Array of tag objects to associate with the stack
- More details (AWS)
- (string, object)TemplateURL
- CloudFormation template object (which will be automatically serialized to JSON for you), or pre-serialized JSON or YAML; can be up to 51,200 b
- (string)TimeoutInMinutes
- S3 location of CloudFormation template; can be up to 460,800 b
- (number)CREATE_FAILED
- Amount of time before the stack status becomes
Properties:
- StackName (string) [required]
- Stack name or ID
- ClientRequestToken (string)
- Unique identifier for this request; from 1 - 128b matching [a-zA-Z0-9][-a-zA-Z0-9]*
- (array)RoleARN
- List of logical resource IDs to retain after stack deletion
- (string)
- IAM role ARN to assume during deletion
Properties:
- StackName (string)
- Stack name or ID
- LogicalResourceId (string)
- Logical name of a resource
- PhysicalResourceId (string)
- Physical name or ID of a resource; if you do not specify PhysicalResourceId, you must specify StackName
Properties:
- StackName (string)
- Stack name or ID
- NextToken (string)
- Pagination cursor token to be used if NextToken was returned in a previous responsepaginate
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- StackName (string) [required]
- Stack name or ID
- NextToken (string)
- Pagination cursor token to be used if NextToken was returned in a previous responsepaginate
- (boolean, string)
- Enable automatic result pagination; use this instead of making your own individual pagination requests
Properties:
- StackName (string) [required]
- Stack name or ID
- Capabilities (array)
- Array of CloudFormation capabilities necessary for stack creation; can be any of: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
- (string)[a-zA-Z0-9][-a-zA-Z0-9]*
- Unique identifier for this request; from 1 - 128b matching
- (boolean)NotificationARNs
- Set to true to disable rollback of the stack if stack creation failed
- (array)Parameters
- Array of SNS topic ARNs to publish stack related events
- (array)ResourceTypes
- Array of objects specifying stack input parameters
- More details (AWS)
- (array)RetainExceptOnCreate
- Array of CloudFormation template resource types with permissions for this create stack action
- More details (AWS)
- (boolean)Retain
- Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of
- (string)RollbackConfiguration
- IAM role ARN CloudFormation assumes to create the stack
- (object)StackPolicyBody
- Rollback triggers to be monitored during creation and updating
- More details (AWS)
- (string, object)StackPolicyURL
- Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON
- More details (AWS)
- (string)Tags
- Stack policy url
- (array)TemplateBody
- Array of tag objects to associate with the stack
- More details (AWS)
- (string, object)TemplateURL
- CloudFormation template object (which will be automatically serialized to JSON for you), or pre-serialized JSON or YAML; can be up to 51,200 b
- (string)
- S3 location of CloudFormation template; can be up to 460,800 b
Properties:
- StackName (string) [required]
- Stack name or ID
- EnableTerminationProtection (boolean) [required]
- Enable termination protection on the specified stack
> Please help out by opening a PR!
- ActivateOrganizationsAccess
- ActivateType
- BatchDescribeTypeConfigurations
- CancelUpdateStack
- ContinueUpdateRollback
- CreateChangeSet
- CreateStackInstances
- CreateStackSet
- DeactivateOrganizationsAccess
- DeactivateType
- DeleteChangeSet
- DeleteStackInstances
- DeleteStackSet
- DeregisterType
- DescribeAccountLimits
- DescribeChangeSet
- DescribeChangeSetHooks
- DescribeOrganizationsAccess
- DescribePublisher
- DescribeStackDriftDetectionStatus
- DescribeStackEvents
- DescribeStackInstance
- DescribeStackResource
- DescribeStackResourceDrifts
- DescribeStackSet
- DescribeStackSetOperation
- DescribeType
- DescribeTypeRegistration
- DetectStackDrift
- DetectStackResourceDrift
- DetectStackSetDrift
- EstimateTemplateCost
- ExecuteChangeSet
- GetStackPolicy
- GetTemplate
- GetTemplateSummary
- ImportStacksToStackSet
- ListChangeSets
- ListExports
- ListImports
- ListStackInstanceResourceDrifts
- ListStackInstances
- ListStacks
- ListStackSetOperationResults
- ListStackSetOperations
- ListStackSets
- ListTypeRegistrations
- ListTypes
- ListTypeVersions
- PublishType
- RecordHandlerProgress
- RegisterPublisher
- RegisterType
- RollbackStack
- SetStackPolicy
- SetTypeConfiguration
- SetTypeDefaultVersion
- SignalResource
- StopStackSetOperation
- TestType
- UpdateStackInstances
- UpdateStackSet
- ValidateTemplate
- More information about the aws-lite plugin API
- Learn about contributing to this and other aws-lite` plugins