JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 558
  • Score
    100M100P100Q115197F
  • License Apache-2.0

Official `aws-lite` plugin for CloudFormation

Package Exports

  • @aws-lite/cloudformation
  • @aws-lite/cloudformation/src/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-lite/cloudformation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aws-lite/cloudformation

Official aws-lite plugin for CloudFormation

Maintained by: @architect

Install

npm i @aws-lite/cloudformation

Optionally install types:

npm i -D @aws-lite/cloudformation-types

Reference

Reference documentation with examples at aws-lite.org

Reference

Reference documentation with examples at aws-lite.org

Methods

CreateStack

Canonical AWS API doc

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
  • ClientRequestToken (string)
    • Unique identifier for this request; from 1 - 128b matching [a-zA-Z0-9][-a-zA-Z0-9]*
  • DisableRollback (boolean)
    • Set to true to disable rollback of the stack if stack creation failed
  • EnableTerminationProtection (boolean)
  • NotificationARNs (array)
    • Array of SNS topic ARNs to publish stack related events
  • OnFailure (string)
    • Action to be taken if stack creation failes; can be one of: DO_NOTHING, ROLLBACK, DELETE
  • Parameters (array)
  • ResourceTypes (array)
    • Array of CloudFormation template resource types with permissions for this create stack action
    • More details (AWS)
  • RetainExceptOnCreate (boolean)
    • Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of Retain
  • RoleARN (string)
    • IAM role ARN CloudFormation assumes to create the stack
  • RollbackConfiguration (object)
  • StackPolicyBody (string, object)
    • Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON
    • More details (AWS)
  • StackPolicyURL (string)
    • Stack policy url
  • Tags (array)
  • TemplateBody (string, object)
    • 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
  • TemplateURL (string)
    • S3 location of CloudFormation template; can be up to 460,800 b
  • TimeoutInMinutes (number)
    • Amount of time before the stack status becomes CREATE_FAILED

DeleteStack

Canonical AWS API doc

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]*
  • RetainResources (array)
    • List of logical resource IDs to retain after stack deletion
  • RoleARN (string)
    • IAM role ARN to assume during deletion

DescribeStackResources

Canonical AWS API doc

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

DescribeStacks

Canonical AWS API doc

Properties:

  • StackName (string)
    • Stack name or ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

ListStackResources

Canonical AWS API doc

Properties:

  • StackName (string) [required]
    • Stack name or ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

UpdateStack

Canonical AWS API doc

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
  • ClientRequestToken (string)
    • Unique identifier for this request; from 1 - 128b matching [a-zA-Z0-9][-a-zA-Z0-9]*
  • DisableRollback (boolean)
    • Set to true to disable rollback of the stack if stack creation failed
  • NotificationARNs (array)
    • Array of SNS topic ARNs to publish stack related events
  • Parameters (array)
  • ResourceTypes (array)
    • Array of CloudFormation template resource types with permissions for this create stack action
    • More details (AWS)
  • RetainExceptOnCreate (boolean)
    • Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of Retain
  • RoleARN (string)
    • IAM role ARN CloudFormation assumes to create the stack
  • RollbackConfiguration (object)
  • StackPolicyBody (string, object)
    • Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON
    • More details (AWS)
  • StackPolicyURL (string)
    • Stack policy url
  • Tags (array)
  • TemplateBody (string, object)
    • 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
  • TemplateURL (string)
    • S3 location of CloudFormation template; can be up to 460,800 b

UpdateTerminationProtection

Canonical AWS API doc

Properties:

  • StackName (string) [required]
    • Stack name or ID
  • EnableTerminationProtection (boolean) [required]
    • Enable termination protection on the specified stack

Methods yet to be implemented

Please help out by opening a PR!

Learn more