@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/{exports/main → lib}/template.ts

@@ -5,6 +5,7 @@ import type {
   Ref,
   RuleFunction,
   ValueFn,
+  WithIntrinsics,
 } from "./intrinsics.ts";
 import type { ParameterType } from "./parameters.ts";
 
@@ -13,7 +14,9 @@ import type { ParameterType } from "./parameters.ts";
  *
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html}
  */
-export type Template<ResourceType = ResourceDefinition> = {
+export type Template<
+  ResourceType extends ResourceDefinition = ResourceDefinition,
+> = {
   /**
    * The AWSTemplateFormatVersion section (optional) identifies the capabilities
    * of the template. The latest template format version is 2010-09-09 and is
@@ -144,17 +147,18 @@ export type TemplateSectionType<Section extends TemplateSection> = Exclude<
 >[string];
 
 /**
- * An object containing all valid TemplateSection values.
+ * An array containing all valid TemplateSection values.
  */
-export const TemplateSection: { [K in TemplateSection]: K } = {
-  Conditions: "Conditions",
-  Mappings: "Mappings",
-  Metadata: "Metadata",
-  Outputs: "Outputs",
-  Parameters: "Parameters",
-  Resources: "Resources",
-  Rules: "Rules",
-};
+export const TemplateSection = Object.keys({
+  // trick to make sure we have all the values
+  Conditions: true,
+  Mappings: true,
+  Metadata: true,
+  Outputs: true,
+  Parameters: true,
+  Resources: true,
+  Rules: true,
+} satisfies Record<TemplateSection, any>) as TemplateSection[];
 
 /**
  * A key-value map.
@@ -447,7 +451,7 @@ export type ResourceOptions = {
  */
 export type ResourceDefinition<
   Type extends string = string,
-  Props extends object = Record<string, unknown>,
+  Props extends object = any,
 > = ResourceOptions & {
   /**
    * Resource properties are additional options that you can specify for a
@@ -455,7 +459,7 @@ export type ResourceDefinition<
    *
    * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html}
    */
-  Properties: Props;
+  Properties: WithIntrinsics<Props>;
 
   /**
    * The resource type identifies the type of resource that you are declaring.
@@ -1025,3 +1029,27 @@ export type UpdatePolicy = {
    */
   UseOnlineResharding?: boolean | ValueFn<boolean> | undefined;
 };
+
+/**
+ * A key-value pair to associate with a resource.
+ */
+export type Tag = {
+  /**
+   * The key name of the tag. You can specify a value that is 1 to 128 Unicode
+   * characters in length and cannot be prefixed with `aws:`. You can use any of
+   * the following characters: the set of Unicode letters, digits, whitespace,
+   * _, ., /, =, +, and -.
+   * @minLength 1
+   * @maxLength 128
+   */
+  Key: string;
+  /**
+   * The value for the tag. You can specify a value that is 0 to 256 Unicode
+   * characters in length and cannot be prefixed with `aws:`. You can use any of
+   * the following characters: the set of Unicode letters, digits, whitespace,
+   * _, ., /, =, +, and -.
+   * @minLength 1
+   * @maxLength 256
+   */
+  Value: string;
+};

package/out/exports/main.d.ts

@@ -1,6 +1,7 @@
-export * from "./main/intrinsics.ts";
-export * from "./main/json.ts";
-export * from "./main/parameters.ts";
-export * from "./main/policy.ts";
-export * from "./main/template.ts";
+export * from "../lib/builder.ts";
+export * from "../lib/intrinsics.ts";
+export * from "../lib/json.ts";
+export * from "../lib/parameters.ts";
+export * from "../lib/policy.ts";
+export * from "../lib/template.ts";
 //# sourceMappingURL=main.d.ts.map

package/out/exports/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../exports/main.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../exports/main.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}

package/out/exports/main.js

@@ -1,6 +1,7 @@
-export * from "./main/intrinsics.js";
-export * from "./main/json.js";
-export * from "./main/parameters.js";
-export * from "./main/policy.js";
-export * from "./main/template.js";
+export * from "../lib/builder.js";
+export * from "../lib/intrinsics.js";
+export * from "../lib/json.js";
+export * from "../lib/parameters.js";
+export * from "../lib/policy.js";
+export * from "../lib/template.js";
 //# sourceMappingURL=main.js.map

package/out/exports/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../../exports/main.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../exports/main.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}

package/out/exports/resources.generated/alexa-ask-skill.d.ts

@@ -0,0 +1,106 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `Alexa::ASK::Skill` resource creates an Alexa skill that enables customers to access new abilities. For more information about developing a skill, see the  .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html}
+ */
+export type AlexaASKSkill = ResourceDefinitionWithAttributes<"Alexa::ASK::Skill", AlexaASKSkillProps, AlexaASKSkillAttribs>;
+/**
+ * The `Alexa::ASK::Skill` resource creates an Alexa skill that enables customers to access new abilities. For more information about developing a skill, see the  .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html}
+ */
+export type AlexaASKSkillProps = {
+    /**
+     * Login with Amazon (LWA) configuration used to authenticate with the Alexa service. Only Login with Amazon clients created through the  are supported. The client ID, client secret, and refresh token are required.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-authenticationconfiguration}
+     */
+    AuthenticationConfiguration: AuthenticationConfiguration;
+    /**
+     * Configuration for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. For more information about the skill package format, see the  .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-skillpackage}
+     */
+    SkillPackage: SkillPackage;
+    /**
+     * The vendor ID associated with the Amazon developer account that will host the skill. Details for retrieving the vendor ID are in  . The provided LWA credentials must be linked to the developer account associated with this vendor ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-vendorid}
+     */
+    VendorId: string;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#aws-resource-ask-skill-return-values}
+ */
+export type AlexaASKSkillAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ask-skill.html#cfn-ask-skill-id}
+     */
+    Id: string;
+};
+/**
+ * The `AuthenticationConfiguration` property type specifies the Login with Amazon (LWA) configuration used to authenticate with the Alexa service. Only Login with Amazon security profiles created through the  are supported for authentication. A client ID, client secret, and refresh token are required. You can generate a client ID and client secret by creating a new  on the Amazon Developer Portal or you can retrieve them from an existing profile. You can then retrieve the refresh token using the Alexa Skills Kit CLI. For instructions, see  in the  .
+ *
+ * `AuthenticationConfiguration` is a property of the `Alexa::ASK::Skill` resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html}
+ */
+export type AuthenticationConfiguration = {
+    /**
+     * Client ID from Login with Amazon (LWA).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientid}
+     */
+    ClientId: string;
+    /**
+     * Client secret from Login with Amazon (LWA).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-clientsecret}
+     */
+    ClientSecret: string;
+    /**
+     * Refresh token from Login with Amazon (LWA). This token is secret.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-authenticationconfiguration.html#cfn-ask-skill-authenticationconfiguration-refreshtoken}
+     */
+    RefreshToken: string;
+};
+/**
+ * The `Overrides` property type provides overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.
+ *
+ * `Overrides` is a property of the `Alexa::ASK::Skill SkillPackage` property type.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html}
+ */
+export type Overrides = {
+    /**
+     * Overrides to apply to the skill manifest inside of the skill package. The skill manifest contains metadata about the skill. For more information, see  .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-overrides.html#cfn-ask-skill-overrides-manifest}
+     */
+    Manifest?: Record<string, unknown> | undefined;
+};
+/**
+ * The `SkillPackage` property type contains configuration details for the skill package that contains the components of the Alexa skill. Skill packages are retrieved from an Amazon S3 bucket and key and used to create and update the skill. More details about the skill package format are located in the  .
+ *
+ * `SkillPackage` is a property of the `Alexa::ASK::Skill` resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html}
+ */
+export type SkillPackage = {
+    /**
+     * Overrides to the skill package to apply when creating or updating the skill. Values provided here do not modify the contents of the original skill package. Currently, only overriding values inside of the skill manifest component of the package is supported.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-overrides}
+     */
+    Overrides?: Overrides | undefined;
+    /**
+     * The name of the Amazon S3 bucket where the .zip file that contains the skill package is stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucket}
+     */
+    S3Bucket: string;
+    /**
+     * ARN of the IAM role that grants the Alexa service ( `alexa-appkit.amazon.com` ) permission to access the bucket and retrieve the skill package. This property is optional. If you do not provide it, the bucket must be publicly accessible or configured with a policy that allows this access. Otherwise, AWS CloudFormation cannot create the skill.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3bucketrole}
+     */
+    S3BucketRole?: string | undefined;
+    /**
+     * The location and name of the skill package .zip file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3key}
+     */
+    S3Key: string;
+    /**
+     * If you have S3 versioning enabled, the version ID of the skill package.zip file.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ask-skill-skillpackage.html#cfn-ask-skill-skillpackage-s3objectversion}
+     */
+    S3ObjectVersion?: string | undefined;
+};
+//# sourceMappingURL=alexa-ask-skill.d.ts.map

package/out/exports/resources.generated/aws-accessanalyzer-analyzer.d.ts

@@ -0,0 +1,154 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::AccessAnalyzer::Analyzer` resource specifies a new analyzer. The analyzer is an object that represents the IAM Access Analyzer feature. An analyzer is required for Access Analyzer to become operational.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html}
+ */
+export type AccessAnalyzerAnalyzer = ResourceDefinitionWithAttributes<"AWS::AccessAnalyzer::Analyzer", AccessAnalyzerAnalyzerProps, AccessAnalyzerAnalyzerAttribs>;
+/**
+ * The `AWS::AccessAnalyzer::Analyzer` resource specifies a new analyzer. The analyzer is an object that represents the IAM Access Analyzer feature. An analyzer is required for Access Analyzer to become operational.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html}
+ */
+export type AccessAnalyzerAnalyzerProps = {
+    /**
+     * Contains information about the configuration of an analyzer for an AWS organization or account.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzerconfiguration}
+     */
+    AnalyzerConfiguration?: {
+        UnusedAccessConfiguration?: UnusedAccessConfiguration | undefined;
+    } | undefined;
+    /**
+     * The name of the analyzer.
+     * @minLength 1
+     * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-analyzername}
+     */
+    AnalyzerName?: string | undefined;
+    /**
+     * Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-archiverules}
+     */
+    ArchiveRules?: ArchiveRule[] | undefined;
+    /**
+     * An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, `_` , `.` , `/` , `=` , `+` , and `-` .
+     *
+     * For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with `aws:` .
+     *
+     * For the tag value, you can specify a value that is 0 to 256 characters in length.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-tags}
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The type represents the zone of trust for the analyzer.
+     *
+     * *Allowed Values* : ACCOUNT | ORGANIZATION | ACCOUNT_UNUSED_ACCESS | ORGANIZATION_UNUSED_ACCESS
+     * @minLength 0
+     * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-type}
+     */
+    Type: string;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#aws-resource-accessanalyzer-analyzer-return-values}
+ */
+export type AccessAnalyzerAnalyzerAttribs = {
+    /**
+     * The ARN of the analyzer that was created.
+     * @minLength 1
+     * @maxLength 1600
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-accessanalyzer-analyzer.html#cfn-accessanalyzer-analyzer-arn}
+     */
+    Arn: string;
+};
+/**
+ * The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate findings.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html}
+ */
+export type AnalysisRuleCriteria = {
+    /**
+     * A list of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html#cfn-accessanalyzer-analyzer-analysisrulecriteria-accountids}
+     */
+    AccountIds?: string[] | undefined;
+    /**
+     * An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, `_` , `.` , `/` , `=` , `+` , and `-` .
+     *
+     * For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be prefixed with `aws:` .
+     *
+     * For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-analysisrulecriteria.html#cfn-accessanalyzer-analyzer-analysisrulecriteria-resourcetags}
+     */
+    ResourceTags?: Tag[][] | undefined;
+};
+/**
+ * Contains information about an archive rule. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html}
+ */
+export type ArchiveRule = {
+    /**
+     * The criteria for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-filter}
+     */
+    Filter: Filter[];
+    /**
+     * The name of the rule to create.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-archiverule.html#cfn-accessanalyzer-analyzer-archiverule-rulename}
+     */
+    RuleName: string;
+};
+/**
+ * The criteria that defines the archive rule.
+ *
+ * To learn about filter keys that you can use to create an archive rule, see [filter keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html) in the *User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html}
+ */
+export type Filter = {
+    /**
+     * A "contains" condition to match for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-contains}
+     */
+    Contains?: string[] | undefined;
+    /**
+     * An "equals" condition to match for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-eq}
+     */
+    Eq?: string[] | undefined;
+    /**
+     * An "exists" condition to match for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-exists}
+     */
+    Exists?: boolean | undefined;
+    /**
+     * A "not equal" condition to match for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-neq}
+     */
+    Neq?: string[] | undefined;
+    /**
+     * The property used to define the criteria in the filter for the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-filter.html#cfn-accessanalyzer-analyzer-filter-property}
+     */
+    Property: string;
+};
+/**
+ * Contains information about an unused access analyzer.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html}
+ */
+export type UnusedAccessConfiguration = {
+    /**
+     * Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html#cfn-accessanalyzer-analyzer-unusedaccessconfiguration-analysisrule}
+     */
+    AnalysisRule?: {
+        /**
+         * A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.
+         */
+        Exclusions?: AnalysisRuleCriteria[] | undefined;
+    } | undefined;
+    /**
+     * The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 365 days.
+     * @min 1
+     * @max 365
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-accessanalyzer-analyzer-unusedaccessconfiguration.html#cfn-accessanalyzer-analyzer-unusedaccessconfiguration-unusedaccessage}
+     */
+    UnusedAccessAge?: number | undefined;
+};
+//# sourceMappingURL=aws-accessanalyzer-analyzer.d.ts.map