diff --git a/API.md b/API.md index ce6f889..4d70b6f 100644 --- a/API.md +++ b/API.md @@ -263,12 +263,14 @@ new VpcEndpointServiceNestedStack(scope: Construct, id: string, props: VpcEndpoi | toString | Returns a string representation of this construct. | | addDependency | Add a dependency between this stack and another stack. | | addMetadata | Adds an arbitrary key-value pair, with information you want to record about the stack. | +| addStackTag | Configure a stack tag. | | addTransform | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. | | exportStringListValue | Create a CloudFormation Export for a string list value. | | exportValue | Create a CloudFormation Export for a string value. | | formatArn | Creates an ARN from components. | | getLogicalId | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. | | regionalFact | Look up a fact value for the given fact for the region of this stack. | +| removeStackTag | Remove a stack tag. | | renameLogicalId | Rename a generated logical identities. | | reportMissingContextKey | Indicate that a context key was expected. | | resolve | Resolve a tokenized value in the context of the current stack. | @@ -334,6 +336,28 @@ These get translated to the Metadata section of the generated template. --- +##### `addStackTag` + +```typescript +public addStackTag(tagName: string, tagValue: string): void +``` + +Configure a stack tag. + +At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack. + +###### `tagName`Required + +- *Type:* string + +--- + +###### `tagValue`Required + +- *Type:* string + +--- + ##### `addTransform` ```typescript @@ -550,6 +574,22 @@ the given region. --- +##### `removeStackTag` + +```typescript +public removeStackTag(tagName: string): void +``` + +Remove a stack tag. + +At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack. + +###### `tagName`Required + +- *Type:* string + +--- + ##### `renameLogicalId` ```typescript @@ -839,9 +879,9 @@ attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (`Token.isUnresolved(stack.account)` returns `true`), this implies that the user wishes that this stack will synthesize -into a **account-agnostic template**. In this case, your code should either +into an **account-agnostic template**. In this case, your code should either fail (throw an error, emit a synth error using `Annotations.of(construct).addError()`) or -implement some other region-agnostic behavior. +implement some other account-agnostic behavior. ---