@aws-lite/cloudformation
Official
aws-liteplugin 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
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
- Array of CloudFormation capabilities necessary for stack creation; can be any of:
ClientRequestToken(string)- Unique identifier for this request; from 1 - 128b matching
[a-zA-Z0-9][-a-zA-Z0-9]*
- Unique identifier for this request; from 1 - 128b matching
DisableRollback(boolean)- Set to true to disable rollback of the stack if stack creation failed
EnableTerminationProtection(boolean)- Enable protection against stack deletion
- More details (AWS)
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
- Action to be taken if stack creation failes; can be one of:
Parameters(array)- Array of objects specifying stack input parameters
- More details (AWS)
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
- Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of
RoleARN(string)- IAM role ARN CloudFormation assumes to create the stack
RollbackConfiguration(object)- Rollback triggers to be monitored during creation and updating
- More details (AWS)
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)- Array of tag objects to associate with the stack
- More details (AWS)
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
- Amount of time before the stack status becomes
DeleteStack
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]*
- Unique identifier for this request; from 1 - 128b matching
RetainResources(array)- List of logical resource IDs to retain after stack deletion
RoleARN(string)- IAM role ARN to assume during deletion
DescribeStackResources
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 specifyStackName
- Physical name or ID of a resource; if you do not specify
DescribeStacks
Properties:
StackName(string)- Stack name or ID
NextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
ListStackResources
Properties:
StackName(string) [required]- Stack name or ID
NextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
UpdateStack
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
- Array of CloudFormation capabilities necessary for stack creation; can be any of:
ClientRequestToken(string)- Unique identifier for this request; from 1 - 128b matching
[a-zA-Z0-9][-a-zA-Z0-9]*
- Unique identifier for this request; from 1 - 128b matching
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)- Array of objects specifying stack input parameters
- More details (AWS)
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
- Set to true to ensure newly created resources are deleted if the operation rolls back, even if marked with a deletion policy of
RoleARN(string)- IAM role ARN CloudFormation assumes to create the stack
RollbackConfiguration(object)- Rollback triggers to be monitored during creation and updating
- More details (AWS)
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)- Array of tag objects to associate with the stack
- More details (AWS)
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
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!
ActivateOrganizationsAccessActivateTypeBatchDescribeTypeConfigurationsCancelUpdateStackContinueUpdateRollbackCreateChangeSetCreateStackInstancesCreateStackSetDeactivateOrganizationsAccessDeactivateTypeDeleteChangeSetDeleteStackInstancesDeleteStackSetDeregisterTypeDescribeAccountLimitsDescribeChangeSetDescribeChangeSetHooksDescribeOrganizationsAccessDescribePublisherDescribeStackDriftDetectionStatusDescribeStackEventsDescribeStackInstanceDescribeStackResourceDescribeStackResourceDriftsDescribeStackSetDescribeStackSetOperationDescribeTypeDescribeTypeRegistrationDetectStackDriftDetectStackResourceDriftDetectStackSetDriftEstimateTemplateCostExecuteChangeSetGetStackPolicyGetTemplateGetTemplateSummaryImportStacksToStackSetListChangeSetsListExportsListImportsListStackInstanceResourceDriftsListStackInstancesListStacksListStackSetOperationResultsListStackSetOperationsListStackSetsListTypeRegistrationsListTypesListTypeVersionsPublishTypeRecordHandlerProgressRegisterPublisherRegisterTypeRollbackStackSetStackPolicySetTypeConfigurationSetTypeDefaultVersionSignalResourceStopStackSetOperationTestTypeUpdateStackInstancesUpdateStackSetValidateTemplate