@awboost/cfntypes 1.0.0-beta.4 → 1.0.0-beta.40

package/lib/AutoScalingReplacingUpdatePolicy.d.ts

@@ -0,0 +1,30 @@
+/**
+ * To specify how AWS CloudFormation handles replacement updates for an Auto
+ * Scaling group, use the AutoScalingReplacingUpdate policy. This policy enables
+ * you to specify whether AWS CloudFormation replaces an Auto Scaling group with
+ * a new one or replaces only the instances in the Auto Scaling group.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-replacingupdate | AutoScalingUpdateReplace policy}
+ */
+export interface AutoScalingReplacingUpdatePolicy {
+    /**
+     * Specifies whether an Auto Scaling group and the instances it contains are
+     * replaced during an update. During replacement, CloudFormation retains the
+     * old group until it finishes creating the new one. If the update fails,
+     * CloudFormation can roll back to the old Auto Scaling group and delete the
+     * new Auto Scaling group.
+     *
+     * While CloudFormation creates the new group, it doesn't detach or attach any
+     * instances. After successfully creating the new Auto Scaling group,
+     * CloudFormation deletes the old Auto Scaling group during the cleanup
+     * process.
+     *
+     * When you set the `WillReplace` parameter, remember to specify a matching
+     * `CreationPolicy`. If the minimum number of instances (specified by the
+     * `MinSuccessfulInstancesPercent` property) don't signal success within the
+     * `Timeout` period (specified in the `CreationPolicy` policy), the
+     * replacement update fails and AWS CloudFormation rolls back to the old Auto
+     * Scaling group.
+     */
+    WillReplace?: boolean;
+}

package/lib/AutoScalingReplacingUpdatePolicy.js

@@ -0,0 +1 @@
+export {};

package/lib/AutoScalingRollingUpdatePolicy.d.ts

@@ -0,0 +1,107 @@
+/**
+ * To specify how CloudFormation handles rolling updates for an Auto Scaling
+ * group, use the `AutoScalingRollingUpdate` policy. Rolling updates enable you
+ * to specify whether AWS CloudFormation updates instances that are in an Auto
+ * Scaling group in batches or all at once.
+ *
+ * Be aware that, during stack update rollback operations, CloudFormation uses
+ * the `UpdatePolicy` configuration specified in the template before the current
+ * stack update operation. For example, suppose you have updated the
+ * `MaxBatchSize` in your stack template's `UpdatePolicy` from 1 to 10. You then
+ * perform a stack update, and that update fails and CloudFormation initiates an
+ * update rollback operation. In such a case, CloudFormation will use 1 as the
+ * maximum batch size, rather than 10. For this reason, we recommend you make
+ * changes to the UpdatePolicy configuration in a stack update separate from and
+ * before any updates to the `AWS::AutoScaling::AutoScalingGroup` resource that
+ * are likely to initiate rolling updates.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate | AutoScalingRollingUpdate policy}
+ */
+export interface AutoScalingRollingUpdatePolicy {
+    /**
+     * Specifies the maximum number of instances that CloudFormation updates.
+     *
+     * @default 1
+     */
+    MaxBatchSize?: number;
+    /**
+     * Specifies the minimum number of instances that must be in service within
+     * the Auto Scaling group while CloudFormation updates old instances. This
+     * value must be less than the `MaxSize` of the Auto Scaling group.\
+     *
+     * @default 0
+     */
+    MinInstancesInService?: number;
+    /**
+     * Specifies the percentage of instances in an Auto Scaling rolling update
+     * that must signal success for an update to succeed. You can specify a value
+     * from `0` to `100`. CloudFormation rounds to the nearest tenth of a percent.
+     * For example, if you update five instances with a minimum successful
+     * percentage of `50`, three instances must signal success.
+     *
+     * If an instance doesn't send a signal within the time specified in the
+     * `PauseTime` property, CloudFormation assumes that the instance wasn't
+     * updated.
+     *
+     * If you specify this property, you must also enable the
+     * `WaitOnResourceSignals` and `PauseTime` properties.
+     *
+     * The `MinSuccessfulInstancesPercent` parameter applies only to instances
+     * only for signaling purpose. To specify the number of instances in your
+     * autoscaling group, see the `MinSize`, `MaxSize`, and `DesiredCapacity`
+     * properties fo the `AWS::AutoScaling::AutoScalingGroup` resource.
+     *
+     * @default 100
+     */
+    MinSuccessfulInstancesPercent?: number;
+    /**
+     * The amount of time that CloudFormation pauses after making a change to a
+     * batch of instances to give those instances time to start software
+     * applications. For example, you might need to specify `PauseTime` when
+     * scaling up the number of instances in an Auto Scaling group.
+     *
+     * If you enable the WaitOnResourceSignals property, `PauseTime` is the amount
+     * of time that CloudFormation should wait for the Auto Scaling group to
+     * receive the required number of valid signals from added or replaced
+     * instances. If the `PauseTime` is exceeded before the Auto Scaling group
+     * receives the required number of signals, the update fails. For best
+     * results, specify a time period that gives your applications sufficient time
+     * to get started. If the update needs to be rolled back, a short `PauseTime`
+     * can cause the rollback to fail.
+     *
+     * Specify `PauseTime` in the ISO8601 duration format (in the format
+     * `PT#H#M#S`, where each `#` is the number of hours, minutes, and seconds,
+     * respectively). The maximum `PauseTime` is one hour (`PT1H`).
+     *
+     * **Default:** `PT0S` (0 seconds). If the `WaitOnResourceSignals` property is
+     * set to true, the default is `PT5M`.
+     */
+    PauseTime?: string;
+    /**
+     * Specifies the Auto Scaling processes to suspend during a stack update.
+     * Suspending processes prevents Auto Scaling from interfering with a stack
+     * update. For example, you can suspend alarming so that Amazon EC2 Auto
+     * Scaling doesn't execute scaling policies associated with an alarm. For
+     * valid values, see the `ScalingProcesses.member.N` parameter for the
+     * SuspendProcesses action in the Amazon EC2 Auto Scaling API Reference.
+     */
+    SuspendProcesses?: string[];
+    /**
+     * Specifies whether the Auto Scaling group waits on signals from new
+     * instances during an update. Use this property to ensure that instances have
+     * completed installing and configuring applications before the Auto Scaling
+     * group update proceeds. AWS CloudFormation suspends the update of an Auto
+     * Scaling group after new EC2 instances are launched into the group. AWS
+     * CloudFormation must receive a signal from each new instance within the
+     * specified PauseTime before continuing the update. To signal the Auto
+     * Scaling group, use the `cfn-signal` helper script or SignalResource API.
+     *
+     * To have instances wait for an Elastic Load Balancing health check before
+     * they signal success, add a health-check verification by using the `cfn-init`
+     * helper script. For an example, see the `verify_instance_health` command in
+     * the Auto Scaling rolling updates sample template.
+     *
+     * @default false
+     */
+    WaitOnResourceSignals?: boolean;
+}

package/lib/AutoScalingRollingUpdatePolicy.js

@@ -0,0 +1,20 @@
+/**
+ * To specify how CloudFormation handles rolling updates for an Auto Scaling
+ * group, use the `AutoScalingRollingUpdate` policy. Rolling updates enable you
+ * to specify whether AWS CloudFormation updates instances that are in an Auto
+ * Scaling group in batches or all at once.
+ *
+ * Be aware that, during stack update rollback operations, CloudFormation uses
+ * the `UpdatePolicy` configuration specified in the template before the current
+ * stack update operation. For example, suppose you have updated the
+ * `MaxBatchSize` in your stack template's `UpdatePolicy` from 1 to 10. You then
+ * perform a stack update, and that update fails and CloudFormation initiates an
+ * update rollback operation. In such a case, CloudFormation will use 1 as the
+ * maximum batch size, rather than 10. For this reason, we recommend you make
+ * changes to the UpdatePolicy configuration in a stack update separate from and
+ * before any updates to the `AWS::AutoScaling::AutoScalingGroup` resource that
+ * are likely to initiate rolling updates.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-rollingupdate | AutoScalingRollingUpdate policy}
+ */
+export {};

package/lib/AutoScalingScheduledActionPolicy.d.ts

@@ -0,0 +1,35 @@
+/**
+ * To specify how AWS CloudFormation handles updates for the `MinSize`,
+ * `MaxSize`, and `DesiredCapacity` properties when the
+ * `AWS::AutoScaling::AutoScalingGroup` resource has an associated scheduled
+ * action, use the `AutoScalingScheduledAction` policy.
+ *
+ * With scheduled actions, the group size properties of an Auto Scaling group
+ * can change at any time. When you update a stack with an Auto Scaling group
+ * and scheduled action, CloudFormation always sets the group size property
+ * values of your Auto Scaling group to the values that are defined in the
+ * `AWS::AutoScaling::AutoScalingGroup` resource of your template, even if a
+ * scheduled action is in effect.
+ *
+ * If you don't want CloudFormation to change any of the group size property
+ * values when you have a scheduled action in effect, use the
+ * `AutoScalingScheduledAction` update policy and set
+ * `IgnoreUnmodifiedGroupSizeProperties` to true to prevent CloudFormation from
+ * changing the `MinSize`, `MaxSize`, or `DesiredCapacity` properties unless you
+ * have modified these values in your template.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-scheduledactions | AutoScalingScheduledAction policy}
+ */
+export interface AutoScalingScheduledActionPolicy {
+    /**
+     * If true, AWS CloudFormation ignores differences in group size properties
+     * between your current Auto Scaling group and the Auto Scaling group
+     * described in the `AWS::AutoScaling::AutoScalingGroup` resource of your
+     * template during a stack update. If you modify any of the group size
+     * property values in your template, AWS CloudFormation uses the modified
+     * values and updates your Auto Scaling group.
+     *
+     * @default false
+     */
+    IgnoreUnmodifiedGroupSizeProperties?: boolean;
+}

package/lib/AutoScalingScheduledActionPolicy.js

@@ -0,0 +1,23 @@
+/**
+ * To specify how AWS CloudFormation handles updates for the `MinSize`,
+ * `MaxSize`, and `DesiredCapacity` properties when the
+ * `AWS::AutoScaling::AutoScalingGroup` resource has an associated scheduled
+ * action, use the `AutoScalingScheduledAction` policy.
+ *
+ * With scheduled actions, the group size properties of an Auto Scaling group
+ * can change at any time. When you update a stack with an Auto Scaling group
+ * and scheduled action, CloudFormation always sets the group size property
+ * values of your Auto Scaling group to the values that are defined in the
+ * `AWS::AutoScaling::AutoScalingGroup` resource of your template, even if a
+ * scheduled action is in effect.
+ *
+ * If you don't want CloudFormation to change any of the group size property
+ * values when you have a scheduled action in effect, use the
+ * `AutoScalingScheduledAction` update policy and set
+ * `IgnoreUnmodifiedGroupSizeProperties` to true to prevent CloudFormation from
+ * changing the `MinSize`, `MaxSize`, or `DesiredCapacity` properties unless you
+ * have modified these values in your template.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-scheduledactions | AutoScalingScheduledAction policy}
+ */
+export {};

package/lib/AwsParam.d.ts

@@ -0,0 +1,73 @@
+import { IntrinsicValue } from './Fn.js';
+/**
+ * Pseudo parameters are parameters that are predefined by AWS CloudFormation.
+ * You don't declare them in your template. Use them the same way as you would a
+ * parameter, as the argument for the Ref function.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html | Psuedo Parameter Reference}
+ */
+export declare class AwsParam {
+    /**
+     * Returns the AWS account ID of the account in which the stack is being
+     * created, such as `123456789012`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-accountid | AWS::AccountId}
+     */
+    static get AccountId(): IntrinsicValue;
+    /**
+     * Returns the list of notification Amazon Resource Names (ARNs) for the
+     * current stack.
+     *
+     * To get a single ARN from the list, use {@link Fn.Split}.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-notificationarns | AWS::NotificationARNs}
+     */
+    static get NotificationARNs(): IntrinsicValue;
+    /**
+     * Removes the corresponding resource property when specified as a return
+     * value in the `Fn::If` intrinsic function.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-novalue | AWS::NoValue}
+     */
+    static get NoValue(): IntrinsicValue;
+    /**
+     * Returns the partition that the resource is in. For standard AWS Regions,
+     * the partition is `aws`. For resources in other partitions, the partition is
+     * `aws-partitionname`. For example, the partition for resources in the China
+     * (Beijing and Ningxia) Region is `aws-cn` and the partition for resources in
+     * the AWS GovCloud (US-West) region is `aws-us-gov`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-partition | AWS::Partition}
+     */
+    static get Partition(): IntrinsicValue;
+    /**
+     * Returns a string representing the Region in which the encompassing resource
+     * is being created, such as `us-west-2`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-region | AWS::Region}
+     */
+    static get Region(): IntrinsicValue;
+    /**
+     * Returns the ID of the stack as specified with the aws cloudformation
+     * create-stack command, such as
+     * `arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackid | AWS::StackId}
+     */
+    static get StackId(): IntrinsicValue;
+    /**
+     * Returns the name of the stack as specified with the aws cloudformation
+     * `create-stack` command, such as `teststack`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackname | AWS::StackName}
+     */
+    static get StackName(): IntrinsicValue;
+    /**
+     * Returns the suffix for a domain. The suffix is typically `amazonaws.com`,
+     * but might differ by Region. For example, the suffix for the China (Beijing)
+     * Region is `amazonaws.com.cn`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-urlsuffix | AWS::URLSuffix}
+     */
+    static get URLSuffix(): IntrinsicValue;
+}

package/lib/AwsParam.js

@@ -0,0 +1,89 @@
+import { Fn } from './Fn.js';
+/**
+ * Pseudo parameters are parameters that are predefined by AWS CloudFormation.
+ * You don't declare them in your template. Use them the same way as you would a
+ * parameter, as the argument for the Ref function.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html | Psuedo Parameter Reference}
+ */
+export class AwsParam {
+    /**
+     * Returns the AWS account ID of the account in which the stack is being
+     * created, such as `123456789012`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-accountid | AWS::AccountId}
+     */
+    static get AccountId() {
+        return Fn.Ref('AWS::AccountId');
+    }
+    /**
+     * Returns the list of notification Amazon Resource Names (ARNs) for the
+     * current stack.
+     *
+     * To get a single ARN from the list, use {@link Fn.Split}.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-notificationarns | AWS::NotificationARNs}
+     */
+    static get NotificationARNs() {
+        return Fn.Ref('AWS::NotificationARNs');
+    }
+    /**
+     * Removes the corresponding resource property when specified as a return
+     * value in the `Fn::If` intrinsic function.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-novalue | AWS::NoValue}
+     */
+    static get NoValue() {
+        return Fn.Ref('AWS::NoValue');
+    }
+    /**
+     * Returns the partition that the resource is in. For standard AWS Regions,
+     * the partition is `aws`. For resources in other partitions, the partition is
+     * `aws-partitionname`. For example, the partition for resources in the China
+     * (Beijing and Ningxia) Region is `aws-cn` and the partition for resources in
+     * the AWS GovCloud (US-West) region is `aws-us-gov`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-partition | AWS::Partition}
+     */
+    static get Partition() {
+        return Fn.Ref('AWS::Partition');
+    }
+    /**
+     * Returns a string representing the Region in which the encompassing resource
+     * is being created, such as `us-west-2`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-region | AWS::Region}
+     */
+    static get Region() {
+        return Fn.Ref('AWS::Region');
+    }
+    /**
+     * Returns the ID of the stack as specified with the aws cloudformation
+     * create-stack command, such as
+     * `arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackid | AWS::StackId}
+     */
+    static get StackId() {
+        return Fn.Ref('AWS::StackId');
+    }
+    /**
+     * Returns the name of the stack as specified with the aws cloudformation
+     * `create-stack` command, such as `teststack`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-stackname | AWS::StackName}
+     */
+    static get StackName() {
+        return Fn.Ref('AWS::StackName');
+    }
+    /**
+     * Returns the suffix for a domain. The suffix is typically `amazonaws.com`,
+     * but might differ by Region. For example, the suffix for the China (Beijing)
+     * Region is `amazonaws.com.cn`.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.html#cfn-pseudo-param-urlsuffix | AWS::URLSuffix}
+     */
+    static get URLSuffix() {
+        return Fn.Ref('AWS::URLSuffix');
+    }
+}

package/lib/CodeDeployLambdaAliasUpdatePolicy.d.ts

@@ -0,0 +1,26 @@
+/**
+ * To perform an CodeDeploy deployment when the version changes on an
+ * `AWS::Lambda::Alias` resource, use the `CodeDeployLambdaAliasUpdate` update
+ * policy.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-codedeploylambdaaliasupdate | CodeDeployLambdaAlias Update policy}
+ */
+export interface CodeDeployLambdaAliasUpdatePolicy {
+    /**
+     * The name of the Lambda function to run after traffic routing completes.
+     */
+    AfterAllowTrafficHook?: string;
+    /**
+     * The name of the CodeDeploy application.
+     */
+    ApplicationName: string;
+    /**
+     * The name of the Lambda function to run before traffic routing starts.
+     */
+    BeforeAllowTrafficHook?: string;
+    /**
+     * The name of the CodeDeploy deployment group. This is where the
+     * traffic-shifting policy is set.
+     */
+    DeploymentGroupName: string;
+}

package/lib/CodeDeployLambdaAliasUpdatePolicy.js

@@ -0,0 +1 @@
+export {};

package/lib/CreationPolicy.d.ts

@@ -0,0 +1,71 @@
+/**
+ * For an Auto Scaling group replacement update, specifies how many instances
+ * must signal success for the update to succeed.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html | CreationPolicy attribute}
+ */
+export interface AutoScalingCreationPolicy {
+    /**
+     * Specifies the percentage of instances in an Auto Scaling replacement update
+     * that must signal success for the update to succeed. You can specify a value
+     * from `0` to `100`. CloudFormation rounds to the nearest tenth of a percent.
+     * For example, if you update five instances with a minimum successful
+     * percentage of `50`, three instances must signal success. If an instance
+     * doesn't send a signal within the time specified by the Timeout property,
+     * CloudFormation assumes that the instance wasn't created.
+     */
+    MinSuccessfulInstancesPercent?: number;
+}
+/**
+ * When CloudFormation creates the associated resource, configures the number of
+ * required success signals and the length of time that CloudFormation waits for
+ * those signals.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html | CreationPolicy attribute}
+ */
+export interface ResourceSignalPolicy {
+    /**
+     * The number of success signals CloudFormation must receive before it sets
+     * the resource status as `CREATE_COMPLETE`. If the resource receives a
+     * failure signal or doesn't receive the specified number of signals before
+     * the timeout period expires, the resource creation fails and CloudFormation
+     * rolls the stack back.
+     */
+    Count?: number;
+    /**
+     * The length of time that CloudFormation waits for the number of signals that
+     * was specified in the Count property. The timeout period starts after
+     * CloudFormation starts creating the resource, and the timeout expires no
+     * sooner than the time you specify but can occur shortly thereafter. The
+     * maximum time that you can specify is 12 hours.
+     *
+     * The value must be in ISO8601 duration format, in the form: `"PT#H#M#S"`,
+     * where each # is the number of hours, minutes, and seconds, respectively.
+     * For best results, specify a period of time that gives your instances plenty
+     * of time to get up and running. A shorter timeout can cause a rollback.
+     */
+    Timeout?: string;
+}
+/**
+ * Associate the `CreationPolicy` attribute with a resource to prevent its
+ * status from reaching create complete until AWS CloudFormation receives a
+ * specified number of success signals or the timeout period is exceeded. To
+ * signal a resource, you can use the `cfn-signal` helper script or
+ * SignalResource API. CloudFormation publishes valid signals to the stack
+ * events so that you track the number of signals sent.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html | CreationPolicy attribute}
+ */
+export interface CreationPolicy {
+    /**
+     * For an Auto Scaling group replacement update, specifies how many instances
+     * must signal success for the update to succeed.
+     */
+    AutoScalingCreationPolicy?: AutoScalingCreationPolicy;
+    /**
+     * When CloudFormation creates the associated resource, configures the number
+     * of required success signals and the length of time that CloudFormation
+     * waits for those signals.
+     */
+    ResourceSignal?: ResourceSignalPolicy;
+}

package/lib/CreationPolicy.js

@@ -0,0 +1 @@
+export {};

package/lib/DeletionPolicy.d.ts

@@ -0,0 +1,84 @@
+/**
+ * With the `DeletionPolicy` attribute you can preserve, and in some cases,
+ * backup a resource when its stack is deleted. You specify a `DeletionPolicy`
+ * attribute for each resource that you want to control. If a resource has no
+ * `DeletionPolicy` attribute, AWS CloudFormation deletes the resource by
+ * default, except for:
+ *
+ *  - For `AWS::RDS::DBCluster resources`, the default policy is `Snapshot`.
+ *  - For `AWS::RDS::DBInstance` resources that don't specify the
+ *    `DBClusterIdentifier` property, the default policy is `Snapshot`.
+ *  - For Amazon S3 buckets, you must delete all objects in the bucket for
+ *    deletion to succeed.
+ *
+ * This capability also applies to stack update operations that lead to
+ * resources being deleted from stacks. For example, if you remove the resource
+ * from the stack template, and then update the stack with the template. This
+ * capability doesn't apply to resources whose physical instance is replaced
+ * during stack update operations. For example, if you edit a resource's
+ * properties such that CloudFormation replaces that resource during a stack
+ * update.
+ *
+ * To keep a resource when its stack is deleted, specify Retain for that
+ * resource. You can use retain for any resource. For example, you can retain a
+ * nested stack, Amazon S3 bucket, or EC2 instance so that you can continue to
+ * use or modify those resources after you delete their stacks.
+ *
+ * For resources that support snapshots, such as `AWS::EC2::Volume`, specify
+ * Snapshot to have CloudFormation create a snapshot before deleting the
+ * resource.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html | DeletionPolicy attribute}
+ */
+export declare const DeletionPolicy: {
+    /**
+     * CloudFormation deletes the resource and all its content if applicable
+     * during stack deletion. You can add this deletion policy to any resource
+     * type. By default, if you don't specify a `DeletionPolicy`, CloudFormation
+     * deletes your resources. However, be aware of the following considerations:
+     *
+     *  - For `AWS::RDS::DBCluster resources`, the default policy is `Snapshot`.
+     *  - For `AWS::RDS::DBInstance` resources that don't specify the
+     *    `DBClusterIdentifier` property, the default policy is `Snapshot`.
+     *
+     * For Amazon S3 buckets, you must delete all objects in the bucket for
+     * deletion to succeed.
+     */
+    readonly Delete: "Delete";
+    /**
+     * CloudFormation keeps the resource without deleting the resource or its
+     * contents when its stack is deleted. You can add this deletion policy to any
+     * resource type. When CloudFormation completes the stack deletion, the stack
+     * will be in `Delete_Complete` state; however, resources that are retained
+     * continue to exist and continue to incur applicable charges until you delete
+     * those resources.
+     *
+     * For update operations, the following considerations apply:
+     *
+     *  - If a resource is deleted, the `DeletionPolicy` retains the physical
+     *    resource but ensures that it's deleted from CloudFormation's scope.
+     *  - If a resource is updated such that a new physical resource is created to
+     *    replace the old resource, then the old resource is completely deleted,
+     *    including from CloudFormation's scope.
+     */
+    readonly Retain: "Retain";
+    /**
+     * For resources that support snapshots, CloudFormation creates a snapshot for
+     * the resource before deleting it. When CloudFormation completes the stack
+     * deletion, the stack will be in the `Delete_Complete` state; however, the
+     * snapshots that are created with this policy continue to exist and continue
+     * to incur applicable charges until you delete those snapshots.
+     *
+     * Resources that support snapshots include:
+     *
+     * - `AWS::EC2::Volume`
+     * - `AWS::ElastiCache::CacheCluster`
+     * - `AWS::ElastiCache::ReplicationGroup`
+     * - `AWS::Neptune::DBCluster`
+     * - `AWS::RDS::DBCluster`
+     * - `AWS::RDS::DBInstance`
+     * - `AWS::Redshift::Cluster`
+     */
+    readonly Snapshot: "Snapshot";
+};
+export type DeletionPolicy = typeof DeletionPolicy[keyof typeof DeletionPolicy];

package/lib/DeletionPolicy.js

@@ -0,0 +1,83 @@
+/**
+ * With the `DeletionPolicy` attribute you can preserve, and in some cases,
+ * backup a resource when its stack is deleted. You specify a `DeletionPolicy`
+ * attribute for each resource that you want to control. If a resource has no
+ * `DeletionPolicy` attribute, AWS CloudFormation deletes the resource by
+ * default, except for:
+ *
+ *  - For `AWS::RDS::DBCluster resources`, the default policy is `Snapshot`.
+ *  - For `AWS::RDS::DBInstance` resources that don't specify the
+ *    `DBClusterIdentifier` property, the default policy is `Snapshot`.
+ *  - For Amazon S3 buckets, you must delete all objects in the bucket for
+ *    deletion to succeed.
+ *
+ * This capability also applies to stack update operations that lead to
+ * resources being deleted from stacks. For example, if you remove the resource
+ * from the stack template, and then update the stack with the template. This
+ * capability doesn't apply to resources whose physical instance is replaced
+ * during stack update operations. For example, if you edit a resource's
+ * properties such that CloudFormation replaces that resource during a stack
+ * update.
+ *
+ * To keep a resource when its stack is deleted, specify Retain for that
+ * resource. You can use retain for any resource. For example, you can retain a
+ * nested stack, Amazon S3 bucket, or EC2 instance so that you can continue to
+ * use or modify those resources after you delete their stacks.
+ *
+ * For resources that support snapshots, such as `AWS::EC2::Volume`, specify
+ * Snapshot to have CloudFormation create a snapshot before deleting the
+ * resource.
+ *
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html | DeletionPolicy attribute}
+ */
+export const DeletionPolicy = {
+    /**
+     * CloudFormation deletes the resource and all its content if applicable
+     * during stack deletion. You can add this deletion policy to any resource
+     * type. By default, if you don't specify a `DeletionPolicy`, CloudFormation
+     * deletes your resources. However, be aware of the following considerations:
+     *
+     *  - For `AWS::RDS::DBCluster resources`, the default policy is `Snapshot`.
+     *  - For `AWS::RDS::DBInstance` resources that don't specify the
+     *    `DBClusterIdentifier` property, the default policy is `Snapshot`.
+     *
+     * For Amazon S3 buckets, you must delete all objects in the bucket for
+     * deletion to succeed.
+     */
+    Delete: 'Delete',
+    /**
+     * CloudFormation keeps the resource without deleting the resource or its
+     * contents when its stack is deleted. You can add this deletion policy to any
+     * resource type. When CloudFormation completes the stack deletion, the stack
+     * will be in `Delete_Complete` state; however, resources that are retained
+     * continue to exist and continue to incur applicable charges until you delete
+     * those resources.
+     *
+     * For update operations, the following considerations apply:
+     *
+     *  - If a resource is deleted, the `DeletionPolicy` retains the physical
+     *    resource but ensures that it's deleted from CloudFormation's scope.
+     *  - If a resource is updated such that a new physical resource is created to
+     *    replace the old resource, then the old resource is completely deleted,
+     *    including from CloudFormation's scope.
+     */
+    Retain: 'Retain',
+    /**
+     * For resources that support snapshots, CloudFormation creates a snapshot for
+     * the resource before deleting it. When CloudFormation completes the stack
+     * deletion, the stack will be in the `Delete_Complete` state; however, the
+     * snapshots that are created with this policy continue to exist and continue
+     * to incur applicable charges until you delete those snapshots.
+     *
+     * Resources that support snapshots include:
+     *
+     * - `AWS::EC2::Volume`
+     * - `AWS::ElastiCache::CacheCluster`
+     * - `AWS::ElastiCache::ReplicationGroup`
+     * - `AWS::Neptune::DBCluster`
+     * - `AWS::RDS::DBCluster`
+     * - `AWS::RDS::DBInstance`
+     * - `AWS::Redshift::Cluster`
+     */
+    Snapshot: 'Snapshot',
+};