@aws-lite/cloudformation
Advanced tools
Comparing version 0.0.2 to 0.0.3
{ | ||
"name": "@aws-lite/cloudformation", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "Official `aws-lite` plugin for CloudFormation", | ||
@@ -5,0 +5,0 @@ "homepage": "https://github.com/architect/aws-lite", |
@@ -35,2 +35,51 @@ # `@aws-lite/cloudformation` | ||
<!-- METHOD_DOCS_START --> | ||
### `CreateStack` | ||
[Canonical AWS API doc](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html) | ||
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)** | ||
- Enable protection against stack deletion | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html) | ||
- **`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)** | ||
- Array of objects specifying stack input parameters | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) | ||
- **`ResourceTypes` (array)** | ||
- Array of CloudFormation template resource types with permissions for this create stack action | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) | ||
- **`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)** | ||
- Rollback triggers to be monitored during creation and updating | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RollbackConfiguration.html) | ||
- **`StackPolicyBody` (string, object)** | ||
- Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) | ||
- **`StackPolicyURL` (string)** | ||
- Stack policy url | ||
- **`Tags` (array)** | ||
- Array of tag objects to associate with the stack | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Tag.html) | ||
- **`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` | ||
@@ -90,2 +139,44 @@ | ||
### `UpdateStack` | ||
[Canonical AWS API doc](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html) | ||
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)** | ||
- Array of objects specifying stack input parameters | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) | ||
- **`ResourceTypes` (array)** | ||
- Array of CloudFormation template resource types with permissions for this create stack action | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) | ||
- **`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)** | ||
- Rollback triggers to be monitored during creation and updating | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RollbackConfiguration.html) | ||
- **`StackPolicyBody` (string, object)** | ||
- Stack policy document; an object will be automatically serialized to JSON, or supply pre-serialized JSON | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) | ||
- **`StackPolicyURL` (string)** | ||
- Stack policy url | ||
- **`Tags` (array)** | ||
- Array of tag objects to associate with the stack | ||
- [More details (AWS)](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Tag.html) | ||
- **`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 | ||
### Methods yet to be implemented | ||
@@ -101,3 +192,2 @@ | ||
- [`CreateChangeSet`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html) | ||
- [`CreateStack`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html) | ||
- [`CreateStackInstances`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html) | ||
@@ -157,3 +247,2 @@ - [`CreateStackSet`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackSet.html) | ||
- [`TestType`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_TestType.html) | ||
- [`UpdateStack`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html) | ||
- [`UpdateStackInstances`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackInstances.html) | ||
@@ -160,0 +249,0 @@ - [`UpdateStackSet`](https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html) |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
32910
5
339
255