@awboost/cfntypes 1.0.0-beta.41 → 1.0.0-beta.48

package/lib/RuleDefinition.d.ts

@@ -1,43 +0,0 @@
-import { IntrinsicValue } from './Fn.js';
-/**
- * Definition for a rule assertion.
- *
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/rules-section-structure.html#template-constraint-rules-syntax | Rules syntax}
- */
-export interface RuleAssertion {
-    /**
-     * Rule-specific intrinsic function.
-     *
-     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/rules-section-structure.html#rules-specific-intrinsic-section-structure | Rule-specific intrinsic functions
-  }
-     */
-    Assert: IntrinsicValue;
-    /**
-     * Information about this assert.
-     */
-    AssertDescription?: string;
-}
-/**
- * Each template rule consists of two properties:
- *
- *  - Rule condition (optional) — determines when a rule takes effect.
- *  - Assertions (required) — describes what values users can specify for a
- *    particular parameter.
- *
- * A rule can include a `RuleCondition` property and must include an Assertions
- * property. For each rule, you can define only one rule condition. You can
- * define one or more asserts within the `Assertions` property. If you don't
- * define a rule condition, the rule's assertions always take effect.
- *
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/rules-section-structure.html#w2ab1c23c15c19b5 | Working with rules}
- */
-export interface RuleDefinition {
-    /**
-     * Describes what values users can specify for a particular parameter.
-     */
-    Assertions: RuleAssertion[];
-    /**
-     * Determines when a rule takes effect.
-     */
-    RuleCondition?: IntrinsicValue;
-}

package/lib/RuleDefinition.js

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

package/lib/Template.js

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

package/lib/TemplateMap.d.ts

@@ -1,6 +0,0 @@
-/**
- * A key-value map.
- */
-export interface TemplateMap<T> {
-    [key: string]: T;
-}

package/lib/TemplateMap.js

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

package/lib/UpdatePolicy.d.ts

@@ -1,111 +0,0 @@
-import { AutoScalingReplacingUpdatePolicy } from './AutoScalingReplacingUpdatePolicy.js';
-import { AutoScalingRollingUpdatePolicy } from './AutoScalingRollingUpdatePolicy.js';
-import { AutoScalingScheduledActionPolicy } from './AutoScalingScheduledActionPolicy.js';
-import { CodeDeployLambdaAliasUpdatePolicy } from './CodeDeployLambdaAliasUpdatePolicy.js';
-/**
- * Use the `UpdatePolicy` attribute to specify how AWS CloudFormation handles
- * updates to the `AWS::AppStream::Fleet`,
- * `AWS::AutoScaling::AutoScalingGroup`, ``AWS::ElastiCache::ReplicationGroup``,
- * `AWS::OpenSearchService::Domain`, `AWS::Elasticsearch::Domain`, or
- * `AWS::Lambda::Alias resources`.
- *
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html | UpdatePolicy attribute}
- */
-export interface UpdatePolicy {
-    /**
-     * 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 | AutoScalingReplacing update policy}
-     */
-    AutoScalingReplacing?: AutoScalingReplacingUpdatePolicy;
-    /**
-     * 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}
-     */
-    AutoScalingRollingUpdate?: AutoScalingRollingUpdatePolicy;
-    /**
-     * 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}
-     */
-    AutoScalingScheduledAction?: AutoScalingScheduledActionPolicy;
-    /**
-     * 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}
-     */
-    CodeDeployLambdaAliasUpdate?: CodeDeployLambdaAliasUpdatePolicy;
-    /**
-     * To upgrade an OpenSearch Service domain to a new version of OpenSearch or
-     * Elasticsearch rather than replacing the entire
-     * `AWS::OpenSearchService::Domain` or `AWS::Elasticsearch::Domain` resource, use
-     * the `EnableVersionUpgrade` update policy.
-     *
-     * If `EnableVersionUpgrade` is set to true, you can update the `EngineVersion`
-     * property of the `AWS::OpenSearchService::Domain` resource (or the
-     * `ElasticsearchVersion` property of the legacy `AWS::Elasticsearch::Domain`
-     * resource), and CloudFormation will update that property without
-     * interruption. When `EnableVersionUpgrade` is set to false, or not specified,
-     * updating the `EngineVersion` or `ElasticsearchVersion` property results in
-     * CloudFormation replacing the entire
-     * `AWS::OpenSearchService::Domain`/`AWS::Elasticsearch::Domain` resource.
-     *
-     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-upgradeopensearchdomain | EnableVersionUpgrade policy}
-     */
-    EnableVersionUpgrade?: boolean;
-    /**
-     * To modify a replication group's shards by adding or removing shards, rather
-     * than replacing the entire `AWS::ElastiCache::ReplicationGroup` resource,
-     * use the `UseOnlineResharding` update policy.
-     *
-     * If `UseOnlineResharding` is set to true, you can update the `NumNodeGroups`
-     * and `NodeGroupConfiguration` properties of the
-     * `AWS::ElastiCache::ReplicationGroup` resource, and CloudFormation will
-     * update those properties without interruption. When `UseOnlineResharding` is
-     * set to false, or not specified, updating the `NumNodeGroups` and
-     * `NodeGroupConfiguration` properties results in CloudFormation replacing the
-     * entire `AWS::ElastiCache::ReplicationGroup` resource.
-     *
-     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html#cfn-attributes-updatepolicy-useonlineresharding | UseOnlineResharding policy}
-     */
-    UseOnlineResharding?: boolean;
-}

package/lib/UpdatePolicy.js

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

package/lib/cjs/AutoScalingReplacingUpdatePolicy.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/AutoScalingRollingUpdatePolicy.js

@@ -1,21 +0,0 @@
-"use strict";
-/**
- * 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}
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/AutoScalingScheduledActionPolicy.js

@@ -1,24 +0,0 @@
-"use strict";
-/**
- * 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}
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/AwsParam.js

@@ -1,93 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AwsParam = void 0;
-const Fn_js_1 = require("./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}
- */
-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_js_1.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_js_1.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_js_1.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_js_1.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_js_1.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_js_1.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_js_1.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_js_1.Fn.Ref('AWS::URLSuffix');
-    }
-}
-exports.AwsParam = AwsParam;

package/lib/cjs/CodeDeployLambdaAliasUpdatePolicy.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/CreationPolicy.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/DeletionPolicy.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeletionPolicy = void 0;
-/**
- * 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}
- */
-exports.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',
-};