@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-xray-samplingrule.d.ts

@@ -0,0 +1,181 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type XRaySamplingRule = ResourceDefinitionWithAttributes<"AWS::XRay::SamplingRule", XRaySamplingRuleProps, XRaySamplingRuleAttribs>;
+/**
+ * Use the `AWS::XRay::SamplingRule` resource to specify a sampling rule, which controls sampling behavior for instrumented applications. Include a `SamplingRule` entity to create or update a sampling rule.
+ *
+ * > `SamplingRule.Version` can only be set when creating a sampling rule. Updating the version will cause the update to fail.
+ *
+ * Services retrieve rules with [GetSamplingRules](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingRules.html) , and evaluate each rule in ascending order of *priority* for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with [GetSamplingTargets](https://docs.aws.amazon.com//xray/latest/api/API_GetSamplingTargets.html) to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
+ */
+export type XRaySamplingRuleProps = {
+    /**
+     * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
+     */
+    RuleName?: string | undefined;
+    /**
+     * The sampling rule to be created or updated.
+     */
+    SamplingRule?: SamplingRule | undefined;
+    SamplingRuleRecord?: SamplingRuleRecord | undefined;
+    SamplingRuleUpdate?: SamplingRuleUpdate | undefined;
+    /**
+     * An array of key-value pairs to apply to this resource.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type XRaySamplingRuleAttribs = {
+    /**
+     * The sampling rule ARN that was created or updated.
+     */
+    RuleARN: string;
+};
+/**
+ * A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.
+ */
+export type SamplingRule = {
+    /**
+     * Matches attributes derived from the request.
+     *
+     * *Map Entries:* Maximum number of 5 items.
+     *
+     * *Key Length Constraints:* Minimum length of 1. Maximum length of 32.
+     *
+     * *Value Length Constraints:* Minimum length of 1. Maximum length of 32.
+     */
+    Attributes?: Record<string, string> | undefined;
+    /**
+     * The percentage of matching requests to instrument, after the reservoir is exhausted.
+     * @min 0
+     * @max 1
+     */
+    FixedRate: number;
+    /**
+     * Matches the HTTP method of a request.
+     * @maxLength 10
+     */
+    HTTPMethod: string;
+    /**
+     * Matches the hostname from a request URL.
+     * @maxLength 64
+     */
+    Host: string;
+    /**
+     * The priority of the sampling rule.
+     * @min 1
+     * @max 9999
+     */
+    Priority: number;
+    /**
+     * A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
+     * @min 0
+     */
+    ReservoirSize: number;
+    /**
+     * Matches the ARN of the AWS resource on which the service runs.
+     * @maxLength 500
+     */
+    ResourceARN: string;
+    /**
+     * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
+     *
+     * > Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.
+     */
+    RuleARN?: string | undefined;
+    /**
+     * The name of the sampling rule. Specify a rule by either name or ARN, but not both.
+     */
+    RuleName?: string | undefined;
+    /**
+     * Matches the `name` that the service uses to identify itself in segments.
+     * @maxLength 64
+     */
+    ServiceName: string;
+    /**
+     * Matches the `origin` that the service uses to identify its type in segments.
+     * @maxLength 64
+     */
+    ServiceType: string;
+    /**
+     * Matches the path from a request URL.
+     * @maxLength 128
+     */
+    URLPath: string;
+    /**
+     * The version of the sampling rule. `Version` can only be set when creating a new sampling rule.
+     * @min 1
+     */
+    Version?: number | undefined;
+};
+export type SamplingRuleRecord = {
+    /**
+     * When the rule was created, in Unix time seconds.
+     */
+    CreatedAt?: string | undefined;
+    /**
+     * When the rule was modified, in Unix time seconds.
+     */
+    ModifiedAt?: string | undefined;
+    SamplingRule?: SamplingRule | undefined;
+};
+export type SamplingRuleUpdate = {
+    /**
+     * Matches attributes derived from the request.
+     */
+    Attributes?: Record<string, string> | undefined;
+    /**
+     * The percentage of matching requests to instrument, after the reservoir is exhausted.
+     * @min 0
+     * @max 1
+     */
+    FixedRate?: number | undefined;
+    /**
+     * Matches the HTTP method from a request URL.
+     * @maxLength 10
+     */
+    HTTPMethod?: string | undefined;
+    /**
+     * Matches the hostname from a request URL.
+     * @maxLength 64
+     */
+    Host?: string | undefined;
+    /**
+     * The priority of the sampling rule.
+     * @min 1
+     * @max 9999
+     */
+    Priority?: number | undefined;
+    /**
+     * A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
+     * @min 0
+     */
+    ReservoirSize?: number | undefined;
+    /**
+     * Matches the ARN of the AWS resource on which the service runs.
+     * @maxLength 500
+     */
+    ResourceARN?: string | undefined;
+    /**
+     * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
+     */
+    RuleARN?: string | undefined;
+    /**
+     * The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
+     */
+    RuleName?: string | undefined;
+    /**
+     * Matches the name that the service uses to identify itself in segments.
+     * @maxLength 64
+     */
+    ServiceName?: string | undefined;
+    /**
+     * Matches the origin that the service uses to identify its type in segments.
+     * @maxLength 64
+     */
+    ServiceType?: string | undefined;
+    /**
+     * Matches the path from a request URL.
+     * @maxLength 128
+     */
+    URLPath?: string | undefined;
+};
+//# sourceMappingURL=aws-xray-samplingrule.d.ts.map

package/out/exports/resources.generated/aws-xray-transactionsearchconfig.d.ts

@@ -0,0 +1,18 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type XRayTransactionSearchConfig = ResourceDefinitionWithAttributes<"AWS::XRay::TransactionSearchConfig", XRayTransactionSearchConfigProps, XRayTransactionSearchConfigAttribs>;
+/**
+ * This schema provides construct and validation rules for AWS-XRay TransactionSearchConfig resource parameters.
+ */
+export type XRayTransactionSearchConfigProps = {
+    /**
+     * Determines the percentage of traces indexed from CloudWatch Logs to X-Ray
+     */
+    IndexingPercentage?: number | undefined;
+};
+export type XRayTransactionSearchConfigAttribs = {
+    /**
+     * User account id, used as the primary identifier for the resource
+     */
+    AccountId: string;
+};
+//# sourceMappingURL=aws-xray-transactionsearchconfig.d.ts.map

package/out/lib/assert.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file implements functionality from `node:assert` so that Node is not a
+ * dependency.
+ */
+export declare class AssertionError extends Error {
+    readonly actual: unknown;
+    readonly expected: unknown;
+    readonly operator: string | undefined;
+    readonly generatedMessage: boolean;
+    readonly code = "ERR_ASSERTION";
+    constructor(options?: {
+        message?: string | undefined;
+        actual?: unknown;
+        expected?: unknown;
+        operator?: string | undefined;
+        stackStartFn?: Function | undefined;
+    }, errorOptions?: ErrorOptions);
+}
+export declare function assert(condition: unknown, message?: string): asserts condition;
+export declare function assertType<T>(value: unknown): asserts value is T;
+//# sourceMappingURL=assert.d.ts.map

package/out/lib/assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../lib/assert.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,SAAgB,IAAI,mBAAmB;gBAGrC,OAAO,GAAE;QACP,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAE9B,YAAY,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;KAChC,EACN,YAAY,CAAC,EAAE,YAAY;CAsB9B;AAED,wBAAgB,MAAM,CACpB,SAAS,EAAE,OAAO,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,SAAS,CAUnB;AAGD,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAG"}

package/out/lib/assert.js

@@ -0,0 +1,39 @@
+/**
+ * This file implements functionality from `node:assert` so that Node is not a
+ * dependency.
+ */
+export class AssertionError extends Error {
+    actual;
+    expected;
+    operator;
+    generatedMessage;
+    code = "ERR_ASSERTION";
+    constructor(options = {}, errorOptions) {
+        const { actual, expected, operator, 
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+        message = `${actual} ${operator} ${expected}`, stackStartFn, } = options;
+        super(message, errorOptions);
+        this.name = "AssertionError";
+        this.actual = actual;
+        this.expected = expected;
+        this.generatedMessage = !options.message;
+        this.operator = operator;
+        if (stackStartFn) {
+            Error.captureStackTrace(this, stackStartFn);
+        }
+    }
+}
+export function assert(condition, message) {
+    if (!condition) {
+        throw new AssertionError({
+            actual: false,
+            expected: true,
+            operator: "==",
+            message,
+            stackStartFn: assert,
+        });
+    }
+}
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+export function assertType(value) { }
+//# sourceMappingURL=assert.js.map

package/out/lib/assert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.js","sourceRoot":"","sources":["../../lib/assert.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvB,MAAM,CAAU;IAChB,QAAQ,CAAU;IAClB,QAAQ,CAAqB;IAC7B,gBAAgB,CAAU;IAC1B,IAAI,GAAG,eAAe,CAAC;IAEvC,YACE,UAOI,EAAE,EACN,YAA2B;QAE3B,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,QAAQ;QACR,4EAA4E;QAC5E,OAAO,GAAG,GAAG,MAAM,IAAI,QAAQ,IAAI,QAAQ,EAAE,EAC7C,YAAY,GACb,GAAG,OAAO,CAAC;QAEZ,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,MAAM,CACpB,SAAkB,EAClB,OAAgB;IAEhB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,cAAc,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,OAAO;YACP,YAAY,EAAE,MAAM;SACrB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,UAAU,CAAI,KAAc,IAAuB,CAAC"}

package/out/lib/builder.d.ts

@@ -0,0 +1,153 @@
+import { Ref, type ConditionFunction, type FnCondition, type FnFindInMap, type FnGetAtt, type FnValueOf, type FnValueOfType, type FnValueOfTypeMap } from "./intrinsics.js";
+import type { ParameterType, ParameterTypeMap } from "./parameters.ts";
+import { TemplateSection, type MappingDefinition, type OutputDefinition, type ParameterDefinition, type ResourceDefinition, type ResourceOptions, type RuleDefinition, type Template } from "./template.js";
+/**
+ * Metadata symbol used for embedding the attributes type in a
+ * {@link ResourceDefinitionWithAttributes}.
+ */
+export declare const AttributeType: unique symbol;
+/**
+ * Metadata symbol used for embedding the attributes type in a
+ * {@link ResourceDefinitionWithAttributes}.
+ */
+export type AttributeType = typeof AttributeType;
+/**
+ * Thrown if a duplicate entity is added to a {@link TemplateBuilder}.
+ */
+export declare class DuplicateTemplateEntityError extends Error {
+    constructor(sectionName: TemplateSection, name: string);
+}
+/**
+ * Extends {@link ResourceDefinition} with the resource attributes type.
+ */
+export type ResourceDefinitionWithAttributes<Type extends string = string, Props extends object = Record<string, unknown>, Attributes extends object = never> = ResourceDefinition<Type, Props> & {
+    [AttributeType]?: Attributes;
+};
+/**
+ * Represents a condition that has been added to a template.
+ */
+export type ConditionInstance = {
+    name: string;
+    ref: FnCondition;
+};
+/**
+ * Represents a mapping that has been added to a template.
+ */
+export type MappingInstance<TopLevelKey extends string = string, SecondLevelKey extends string = string, Value = unknown> = {
+    name: string;
+    findInMap: (TopLevelKey: TopLevelKey, secondLevelKey: SecondLevelKey) => Required<FnFindInMap<Value>>;
+};
+/**
+ * Represents a parameter that has been added to a template.
+ */
+export type ParameterInstance<T extends ParameterType> = T extends FnValueOfType ? {
+    name: string;
+    ref: Ref<ParameterTypeMap[T]>;
+    valueOf: <Attr extends keyof FnValueOfTypeMap[T]>(attribute: Attr) => Required<FnValueOf<FnValueOfTypeMap[T][Attr]>>;
+} : {
+    name: string;
+    ref: Ref<ParameterTypeMap[T]>;
+};
+/**
+ * Represents a resource that has been added to a template.
+ */
+export type ResourceInstance<Def> = Def extends ResourceDefinitionWithAttributes<any, any, infer Attributes> ? {
+    name: string;
+    ref: Ref;
+    getAtt: <Attr extends keyof Attributes>(name: Attr) => Required<FnGetAtt<Attributes[Attr]>>;
+} : {
+    name: string;
+    ref: Ref;
+};
+/**
+ * Utility class to assist with creating {@link Template} instances.
+ */
+export declare class TemplateBuilder<ResourceType extends ResourceDefinition = ResourceDefinition> {
+    #private;
+    get template(): Template;
+    constructor(template: Template);
+    /**
+     * The optional Conditions section contains statements that define the
+     * circumstances under which entities are created or configured. For example,
+     * you can create a condition and then associate it with a resource or output
+     * so that AWS CloudFormation only creates the resource or output if the
+     * condition is true. Similarly, you can associate the condition with a
+     * property so that AWS CloudFormation only sets the property to a specific
+     * value if the condition is true. If the condition is false, AWS
+     * CloudFormation sets the property to a different value that you specify.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html}
+     */
+    addCondition(name: string, definition: ConditionFunction): ConditionInstance;
+    /**
+     * The optional `Mappings` section matches a key to a corresponding set of
+     * named values. For example, if you want to set values based on a region, you
+     * can create a mapping that uses the region name as a key and contains the
+     * values you want to specify for each specific region. You use the
+     * `Fn::FindInMap` intrinsic function to retrieve values in a map.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html}
+     */
+    addMapping<TopLevelKey extends string, SecondLevelKey extends string, Value>(name: string, definition: MappingDefinition<TopLevelKey, SecondLevelKey, Value>): MappingInstance<TopLevelKey, SecondLevelKey, Value>;
+    /**
+     * The optional `Mappings` section matches a key to a corresponding set of
+     * named values. For example, if you want to set values based on a region, you
+     * can create a mapping that uses the region name as a key and contains the
+     * values you want to specify for each specific region. You use the
+     * `Fn::FindInMap` intrinsic function to retrieve values in a map.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html}
+     */
+    addMapping<TopLevelKey extends string, SecondLevelKey extends string, Value>(name: string, topLevelKey: TopLevelKey, mapping: Record<SecondLevelKey, Value>): MappingInstance<TopLevelKey, SecondLevelKey, Value>;
+    /**
+     * The optional `Mappings` section matches a key to a corresponding set of
+     * named values. For example, if you want to set values based on a region, you
+     * can create a mapping that uses the region name as a key and contains the
+     * values you want to specify for each specific region. You use the
+     * `Fn::FindInMap` intrinsic function to retrieve values in a map.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html}
+     */
+    addMapping<TopLevelKey extends string, SecondLevelKey extends string, Value>(name: string, topLevelKey: TopLevelKey, secondLevelKey: SecondLevelKey, value: Value): MappingInstance<TopLevelKey, SecondLevelKey, Value>;
+    /**
+     * The optional `Outputs` section declares output values that you can import
+     * into other stacks (to create cross-stack references), return in response (to
+     * describe stack calls), or view on the AWS CloudFormation console. For
+     * example, you can output the S3 bucket name for a stack to make the bucket
+     * easier to find.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html}
+     */
+    addOutput(name: string, definition: OutputDefinition): void;
+    /**
+     * Use the optional `Parameters` section to customize your templates.
+     * Parameters enable you to input custom values to your template each time you
+     * create or update a stack.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html}
+     */
+    addParameter<T extends ParameterType>(name: string, definition: ParameterDefinition<T>): ParameterInstance<T>;
+    /**
+     * The required `Resources` section declares the AWS resources that you want
+     * to include in the stack, such as an Amazon EC2 instance or an Amazon S3
+     * bucket.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html}
+     */
+    addResource<T extends ResourceType["Type"]>(name: string, type: T, properties: Extract<ResourceType, {
+        Type: T;
+    }>["Properties"], options?: ResourceOptions): ResourceInstance<Extract<ResourceType, {
+        Type: T;
+    }>>;
+    /**
+     * The optional `Rules` section validates a parameter or a combination of
+     * parameters passed to a template during a stack creation or stack update. To
+     * use template rules, explicitly declare `Rules` in your template followed by
+     * an assertion. Use the rules section to validate parameter values before
+     * creating or updating resources.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/rules-section-structure.html}
+     */
+    addRule(name: string, definition: RuleDefinition): void;
+}
+//# sourceMappingURL=builder.d.ts.map

package/out/lib/builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../lib/builder.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,GAAG,EACH,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EACL,eAAe,EACf,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,QAAQ,EAEd,MAAM,eAAe,CAAC;AAEvB;;;GAGG;AACH,eAAO,MAAM,aAAa,eAEzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC;AAEjD;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;gBAClC,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM;CAK9D;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,CAC1C,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,KAAK,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9C,UAAU,SAAS,MAAM,GAAG,KAAK,IAC/B,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG;IACpC,CAAC,aAAa,CAAC,CAAC,EAAE,UAAU,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,CACzB,WAAW,SAAS,MAAM,GAAG,MAAM,EACnC,cAAc,SAAS,MAAM,GAAG,MAAM,EACtC,KAAK,GAAG,OAAO,IACb;IACF,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,CACT,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,cAAc,KAC3B,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,IAAI,CAAC,SAAS,aAAa,GAC5E;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B,OAAO,EAAE,CAAC,IAAI,SAAS,MAAM,gBAAgB,CAAC,CAAC,CAAC,EAC9C,SAAS,EAAE,IAAI,KACZ,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACrD,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAEN;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,GAAG,IAC9B,GAAG,SAAS,gCAAgC,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC,GACpE;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,CAAC,IAAI,SAAS,MAAM,UAAU,EACpC,IAAI,EAAE,IAAI,KACP,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC3C,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,GAAG,CAAC;CACV,CAAC;AAER;;GAEG;AACH,qBAAa,eAAe,CAC1B,YAAY,SAAS,kBAAkB,GAAG,kBAAkB;;IAI5D,IAAW,QAAQ,IAAI,QAAQ,CAE9B;gBAEkB,QAAQ,EAAE,QAAQ;IAIrC;;;;;;;;;;;OAWG;IACI,YAAY,CACjB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,iBAAiB,GAC5B,iBAAiB;IAQpB;;;;;;;;OAQG;IACI,UAAU,CACf,WAAW,SAAS,MAAM,EAC1B,cAAc,SAAS,MAAM,EAC7B,KAAK,EAEL,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,iBAAiB,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,CAAC,GAChE,eAAe,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,CAAC;IAEtD;;;;;;;;OAQG;IACI,UAAU,CACf,WAAW,SAAS,MAAM,EAC1B,cAAc,SAAS,MAAM,EAC7B,KAAK,EAEL,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,GACrC,eAAe,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,CAAC;IAEtD;;;;;;;;OAQG;IACI,UAAU,CACf,WAAW,SAAS,MAAM,EAC1B,cAAc,SAAS,MAAM,EAC7B,KAAK,EAEL,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,cAAc,EAC9B,KAAK,EAAE,KAAK,GACX,eAAe,CAAC,WAAW,EAAE,cAAc,EAAE,KAAK,CAAC;IA+BtD;;;;;;;;OAQG;IACI,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAIlE;;;;;;OAMG;IACI,YAAY,CAAC,CAAC,SAAS,aAAa,EACzC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACjC,iBAAiB,CAAC,CAAC,CAAC;IASvB;;;;;;OAMG;IACI,WAAW,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,EAC/C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,OAAO,CAAC,YAAY,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC,YAAY,CAAC,EAC5D,OAAO,CAAC,EAAE,eAAe,GACxB,gBAAgB,CAAC,OAAO,CAAC,YAAY,EAAE;QAAE,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC,CAAC;IAavD;;;;;;;;OAQG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,GAAG,IAAI;CA8C/D"}

package/out/lib/builder.js

@@ -0,0 +1,169 @@
+import { assert } from "./assert.js";
+import { Condition, Fn, Ref, } from "./intrinsics.js";
+import { TemplateSection, } from "./template.js";
+/**
+ * Metadata symbol used for embedding the attributes type in a
+ * {@link ResourceDefinitionWithAttributes}.
+ */
+export const AttributeType = Symbol("@propulsionworks/cloudformation/AttributeType");
+/**
+ * Thrown if a duplicate entity is added to a {@link TemplateBuilder}.
+ */
+export class DuplicateTemplateEntityError extends Error {
+    constructor(sectionName, name) {
+        const entity = getTemplateEntityName(sectionName);
+        super(`the ${entity} "${name}" has already been added to the template`);
+        this.name = "DuplicateTemplateEntityError";
+    }
+}
+/**
+ * Utility class to assist with creating {@link Template} instances.
+ */
+export class TemplateBuilder {
+    #template;
+    get template() {
+        return this.#template;
+    }
+    constructor(template) {
+        this.#template = template;
+    }
+    /**
+     * The optional Conditions section contains statements that define the
+     * circumstances under which entities are created or configured. For example,
+     * you can create a condition and then associate it with a resource or output
+     * so that AWS CloudFormation only creates the resource or output if the
+     * condition is true. Similarly, you can associate the condition with a
+     * property so that AWS CloudFormation only sets the property to a specific
+     * value if the condition is true. If the condition is false, AWS
+     * CloudFormation sets the property to a different value that you specify.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/conditions-section-structure.html}
+     */
+    addCondition(name, definition) {
+        this.#addSection("Conditions", name, definition);
+        return {
+            name,
+            ref: Condition(name),
+        };
+    }
+    /**
+     * The optional `Mappings` section matches a key to a corresponding set of
+     * named values. For example, if you want to set values based on a region, you
+     * can create a mapping that uses the region name as a key and contains the
+     * values you want to specify for each specific region. You use the
+     * `Fn::FindInMap` intrinsic function to retrieve values in a map.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/mappings-section-structure.html}
+     */
+    addMapping(name, topLevel, secondLevel, value) {
+        if (typeof topLevel === "object") {
+            this.#addSection("Mappings", name, topLevel);
+        }
+        else if (typeof secondLevel === "object") {
+            this.#set(["Mappings", name, topLevel], secondLevel);
+        }
+        else {
+            assert(secondLevel);
+            this.#set(["Mappings", name, topLevel, secondLevel], value);
+        }
+        return {
+            name,
+            findInMap: Fn.FindInMap.bind(Fn, name),
+        };
+    }
+    /**
+     * The optional `Outputs` section declares output values that you can import
+     * into other stacks (to create cross-stack references), return in response (to
+     * describe stack calls), or view on the AWS CloudFormation console. For
+     * example, you can output the S3 bucket name for a stack to make the bucket
+     * easier to find.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html}
+     */
+    addOutput(name, definition) {
+        this.#addSection("Outputs", name, definition);
+    }
+    /**
+     * Use the optional `Parameters` section to customize your templates.
+     * Parameters enable you to input custom values to your template each time you
+     * create or update a stack.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html}
+     */
+    addParameter(name, definition) {
+        this.#addSection("Parameters", name, definition);
+        return {
+            name,
+            ref: Ref(name),
+            valueOf: Fn.ValueOf.bind(Fn, name),
+        };
+    }
+    /**
+     * The required `Resources` section declares the AWS resources that you want
+     * to include in the stack, such as an Amazon EC2 instance or an Amazon S3
+     * bucket.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html}
+     */
+    addResource(name, type, properties, options) {
+        this.#addSection("Resources", name, {
+            Type: type,
+            Properties: properties,
+            ...options,
+        });
+        return {
+            name,
+            ref: Ref(name),
+            getAtt: Fn.GetAtt.bind(Fn, name),
+        };
+    }
+    /**
+     * The optional `Rules` section validates a parameter or a combination of
+     * parameters passed to a template during a stack creation or stack update. To
+     * use template rules, explicitly declare `Rules` in your template followed by
+     * an assertion. Use the rules section to validate parameter values before
+     * creating or updating resources.
+     *
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/rules-section-structure.html}
+     */
+    addRule(name, definition) {
+        this.#addSection("Rules", name, definition);
+    }
+    /**
+     * Add a definition to the template.
+     */
+    #addSection(sectionName, name, definition) {
+        this.#set([sectionName, name], definition);
+    }
+    #set(keys, value) {
+        const parents = keys.slice(0, -1);
+        const leaf = keys.at(-1);
+        assert(leaf && parents.length > 0, `keys should have at least two elements`);
+        let obj = this.#template;
+        for (const key of parents) {
+            if (key in obj) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+                obj = obj[key];
+            }
+            else {
+                const parent = {};
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                obj[key] = parent;
+                obj = parent;
+            }
+        }
+        if (leaf in obj) {
+            throw new DuplicateTemplateEntityError(keys[0], keys.slice(1).join("."));
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        obj[leaf] = value;
+    }
+}
+/**
+ * Returns the entity name for a template section, e.g. "condition" for
+ * "Conditions" and "metadata" for "Metadata".
+ */
+function getTemplateEntityName(sectionName) {
+    return (sectionName.endsWith("s") ? sectionName.slice(0, -1) : sectionName).toLowerCase();
+}
+//# sourceMappingURL=builder.js.map

package/out/lib/builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../lib/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EACL,SAAS,EACT,EAAE,EACF,GAAG,GAQJ,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,eAAe,GAShB,MAAM,eAAe,CAAC;AAEvB;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CACjC,+CAA+C,CAChD,CAAC;AAQF;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD,YAAmB,WAA4B,EAAE,IAAY;QAC3D,MAAM,MAAM,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAClD,KAAK,CAAC,OAAO,MAAM,KAAK,IAAI,0CAA0C,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AAqED;;GAEG;AACH,MAAM,OAAO,eAAe;IAGjB,SAAS,CAAW;IAE7B,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,YAAmB,QAAkB;QACnC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACI,YAAY,CACjB,IAAY,EACZ,UAA6B;QAE7B,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QACjD,OAAO;YACL,IAAI;YACJ,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC;SACrB,CAAC;IACJ,CAAC;IA2DD;;;;;;;;OAQG;IACI,UAAU,CACf,IAAY,EACZ,QAAoC,EACpC,WAA8C,EAC9C,KAAe;QAEf,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC;aAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,WAAW,CAAC,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO;YACL,IAAI;YACJ,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;SACvC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,SAAS,CAAC,IAAY,EAAE,UAA4B;QACzD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACI,YAAY,CACjB,IAAY,EACZ,UAAkC;QAElC,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QACjD,OAAO;YACL,IAAI;YACJ,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC;YACd,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;SACX,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAChB,IAAY,EACZ,IAAO,EACP,UAA4D,EAC5D,OAAyB;QAEzB,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,IAAI,EAAE;YAClC,IAAI,EAAE,IAAI;YACV,UAAU,EAAE,UAAU;YACtB,GAAG,OAAO;SACX,CAAC,CAAC;QACH,OAAO;YACL,IAAI;YACJ,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC;YACd,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;SACuB,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACI,OAAO,CAAC,IAAY,EAAE,UAA0B;QACrD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,WAAW,CACT,WAAoB,EACpB,IAAY,EACZ,UAAwC;QAExC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,CAAC,IAAc,EAAE,KAAc;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzB,MAAM,CACJ,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAC1B,wCAAwC,CACzC,CAAC;QAEF,IAAI,GAAG,GAAQ,IAAI,CAAC,SAAS,CAAC;QAC9B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;gBACf,+GAA+G;gBAC/G,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,GAAG,EAAE,CAAC;gBAClB,sEAAsE;gBACtE,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAClB,GAAG,GAAG,MAAM,CAAC;YACf,CAAC;QACH,CAAC;QAED,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;YAChB,MAAM,IAAI,4BAA4B,CACpC,IAAI,CAAC,CAAC,CAAoB,EAC1B,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CACxB,CAAC;QACJ,CAAC;QACD,sEAAsE;QACtE,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACpB,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,qBAAqB,CAAC,WAA4B;IACzD,OAAO,CACL,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CACnE,CAAC,WAAW,EAAE,CAAC;AAClB,CAAC"}