@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/out/exports/resources.generated/aws-omics-workflow.d.ts

@@ -0,0 +1,181 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:
+ *
+ * - *Input data* : Input data for the workflow, stored in an S3 bucket or a AWS HealthOmics sequence store.
+ * - *Workflow definition files* : Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements.
+ * - *Parameter template files* : Define run parameters using a parameter template file (written in JSON).
+ * - *ECR container images* : Create one or more container images for the workflow. Store the images in a private ECR repository.
+ * - (Optional) *Sentieon licenses* : Request a Sentieon license if you plan to use Sentieon software in a private workflow.
+ *
+ * For more information, see [Creating or updating a private workflow in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the AWS HealthOmics User Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html}
+ */
+export type OmicsWorkflow = ResourceDefinitionWithAttributes<"AWS::Omics::Workflow", OmicsWorkflowProps, OmicsWorkflowAttribs>;
+/**
+ * Creates a private workflow.Private workflows depend on a variety of resources that you create and configure before creating the workflow:
+ *
+ * - *Input data* : Input data for the workflow, stored in an S3 bucket or a AWS HealthOmics sequence store.
+ * - *Workflow definition files* : Define your workflow in one or more workflow definition files, written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements.
+ * - *Parameter template files* : Define run parameters using a parameter template file (written in JSON).
+ * - *ECR container images* : Create one or more container images for the workflow. Store the images in a private ECR repository.
+ * - (Optional) *Sentieon licenses* : Request a Sentieon license if you plan to use Sentieon software in a private workflow.
+ *
+ * For more information, see [Creating or updating a private workflow in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the AWS HealthOmics User Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html}
+ */
+export type OmicsWorkflowProps = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-accelerators}
+     */
+    Accelerators?: Accelerators | undefined;
+    /**
+     * The URI of a definition for the workflow.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionuri}
+     */
+    DefinitionUri?: string | undefined;
+    /**
+     * The parameter's description.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-description}
+     */
+    Description?: string | undefined;
+    /**
+     * An engine for the workflow.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-engine}
+     */
+    Engine?: WorkflowEngine | undefined;
+    /**
+     * The path of the main definition file for the workflow.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-main}
+     */
+    Main?: string | undefined;
+    /**
+     * The workflow's name.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-name}
+     */
+    Name?: string | undefined;
+    /**
+     * The workflow's parameter template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplate}
+     */
+    ParameterTemplate?: Record<string, WorkflowParameter> | undefined;
+    /**
+     * The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
+     * @min 0
+     * @max 100000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagecapacity}
+     */
+    StorageCapacity?: number | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagetype}
+     */
+    StorageType?: StorageType | undefined;
+    /**
+     * Tags for the workflow.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-tags}
+     */
+    Tags?: Record<string, string> | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#aws-resource-omics-workflow-return-values}
+ */
+export type OmicsWorkflowAttribs = {
+    /**
+     * The ARN for the workflow.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^arn:.+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-arn}
+     */
+    Arn: string;
+    /**
+     * When the workflow was created.
+     * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-creationtime}
+     */
+    CreationTime: string;
+    /**
+     * The workflow's ID.
+     * @minLength 1
+     * @maxLength 18
+     * @pattern ^[0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-id}
+     */
+    Id: string;
+    /**
+     * The workflow's status.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-status}
+     */
+    Status: WorkflowStatus;
+    /**
+     * The workflow's type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-type}
+     */
+    Type: WorkflowType;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-uuid}
+     */
+    Uuid: string;
+};
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-accelerators.html}
+ */
+export type Accelerators = "GPU";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-storagetype.html}
+ */
+export type StorageType = "STATIC" | "DYNAMIC";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowengine.html}
+ */
+export type WorkflowEngine = "WDL" | "NEXTFLOW" | "CWL";
+/**
+ * A workflow parameter.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html}
+ */
+export type WorkflowParameter = {
+    /**
+     * The parameter's description.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-description}
+     */
+    Description?: string | undefined;
+    /**
+     * Whether the parameter is optional.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-optional}
+     */
+    Optional?: boolean | undefined;
+};
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowstatus.html}
+ */
+export type WorkflowStatus = "CREATING" | "ACTIVE" | "UPDATING" | "DELETED" | "FAILED";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowtype.html}
+ */
+export type WorkflowType = "PRIVATE";
+//# sourceMappingURL=aws-omics-workflow.d.ts.map

package/out/exports/resources.generated/aws-omics-workflowversion.d.ts

@@ -0,0 +1,186 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates a new workflow version for the workflow that you specify with the `workflowId` parameter.
+ *
+ * When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
+ *
+ * Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
+ *
+ * > Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
+ *
+ * For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the AWS HealthOmics User Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html}
+ */
+export type OmicsWorkflowVersion = ResourceDefinitionWithAttributes<"AWS::Omics::WorkflowVersion", OmicsWorkflowVersionProps, OmicsWorkflowVersionAttribs>;
+/**
+ * Creates a new workflow version for the workflow that you specify with the `workflowId` parameter.
+ *
+ * When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
+ *
+ * Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
+ *
+ * > Don’t include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
+ *
+ * For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the AWS HealthOmics User Guide.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html}
+ */
+export type OmicsWorkflowVersionProps = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-accelerators}
+     */
+    Accelerators?: Accelerators | undefined;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-definitionuri}
+     */
+    DefinitionUri?: string | undefined;
+    /**
+     * The description of the workflow version.
+     * @minLength 1
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-description}
+     */
+    Description?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-engine}
+     */
+    Engine?: WorkflowEngine | undefined;
+    /**
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-main}
+     */
+    Main?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-parametertemplate}
+     */
+    ParameterTemplate?: Record<string, WorkflowParameter> | undefined;
+    /**
+     * @min 0
+     * @max 100000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-storagecapacity}
+     */
+    StorageCapacity?: number | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-storagetype}
+     */
+    StorageType?: StorageType | undefined;
+    /**
+     * A map of resource tags
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-tags}
+     */
+    Tags?: Record<string, string> | undefined;
+    /**
+     * The name of the workflow version.
+     * @minLength 1
+     * @maxLength 64
+     * @pattern ^[A-Za-z0-9][A-Za-z0-9\-\._]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-versionname}
+     */
+    VersionName: string;
+    /**
+     * @minLength 1
+     * @maxLength 12
+     * @pattern ^[0-9]{12}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-workflowbucketownerid}
+     */
+    WorkflowBucketOwnerId?: string | undefined;
+    /**
+     * The workflow's ID.
+     * @minLength 1
+     * @maxLength 18
+     * @pattern ^[0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-workflowid}
+     */
+    WorkflowId: string;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#aws-resource-omics-workflowversion-return-values}
+ */
+export type OmicsWorkflowVersionAttribs = {
+    /**
+     * ARN of the workflow version.
+     * @minLength 1
+     * @maxLength 128
+     * @pattern ^arn:.+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-arn}
+     */
+    Arn: string;
+    /**
+     * The creation time of the workflow version.
+     * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-creationtime}
+     */
+    CreationTime: string;
+    /**
+     * The status of the workflow version.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-status}
+     */
+    Status: WorkflowStatus;
+    /**
+     * The type of the workflow version.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-type}
+     */
+    Type: WorkflowType;
+    /**
+     * @minLength 1
+     * @maxLength 36
+     * @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html#cfn-omics-workflowversion-uuid}
+     */
+    Uuid: string;
+};
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-accelerators.html}
+ */
+export type Accelerators = "GPU";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-storagetype.html}
+ */
+export type StorageType = "STATIC" | "DYNAMIC";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowengine.html}
+ */
+export type WorkflowEngine = "WDL" | "NEXTFLOW" | "CWL";
+/**
+ * A workflow parameter.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html}
+ */
+export type WorkflowParameter = {
+    /**
+     * The parameter's description.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern ^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html#cfn-omics-workflowversion-workflowparameter-description}
+     */
+    Description?: string | undefined;
+    /**
+     * Whether the parameter is optional.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html#cfn-omics-workflowversion-workflowparameter-optional}
+     */
+    Optional?: boolean | undefined;
+};
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowstatus.html}
+ */
+export type WorkflowStatus = "CREATING" | "ACTIVE" | "UPDATING" | "DELETED" | "FAILED" | "INACTIVE";
+/**
+ * @minLength 1
+ * @maxLength 64
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowtype.html}
+ */
+export type WorkflowType = "PRIVATE" | "READY2RUN";
+//# sourceMappingURL=aws-omics-workflowversion.d.ts.map

package/out/exports/resources.generated/aws-opensearchserverless-accesspolicy.d.ts

@@ -0,0 +1,46 @@
+import type { ResourceDefinition } from "../main.ts";
+/**
+ * Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see [Data access control for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html}
+ */
+export type OpenSearchServerlessAccessPolicy = ResourceDefinition<"AWS::OpenSearchServerless::AccessPolicy", OpenSearchServerlessAccessPolicyProps>;
+/**
+ * Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see [Data access control for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html}
+ */
+export type OpenSearchServerlessAccessPolicyProps = {
+    /**
+     * The description of the policy.
+     * @minLength 1
+     * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-description}
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the policy.
+     * @minLength 3
+     * @maxLength 32
+     * @pattern ^[a-z][a-z0-9-]{2,31}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-name}
+     */
+    Name: string;
+    /**
+     * The JSON policy document without any whitespaces.
+     * @minLength 1
+     * @maxLength 20480
+     * @pattern [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-policy}
+     */
+    Policy: string;
+    /**
+     * The type of access policy. Currently the only option is `data` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-type}
+     */
+    Type: AccessPolicyType;
+};
+/**
+ * The possible types for the access policy
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-accesspolicy-accesspolicytype.html}
+ */
+export type AccessPolicyType = "data";
+//# sourceMappingURL=aws-opensearchserverless-accesspolicy.d.ts.map

package/out/exports/resources.generated/aws-opensearchserverless-collection.d.ts

@@ -0,0 +1,92 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Specifies an OpenSearch Serverless collection. For more information, see [Creating and managing Amazon OpenSearch Serverless collections](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) in the *Amazon OpenSearch Service Developer Guide* .
+ *
+ * > You must create a matching [encryption policy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. See [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#aws-resource-opensearchserverless-collection--examples) for a sample template. Otherwise the encryption policy must already exist before you create the collection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html}
+ */
+export type OpenSearchServerlessCollection = ResourceDefinitionWithAttributes<"AWS::OpenSearchServerless::Collection", OpenSearchServerlessCollectionProps, OpenSearchServerlessCollectionAttribs>;
+/**
+ * Specifies an OpenSearch Serverless collection. For more information, see [Creating and managing Amazon OpenSearch Serverless collections](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) in the *Amazon OpenSearch Service Developer Guide* .
+ *
+ * > You must create a matching [encryption policy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. See [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#aws-resource-opensearchserverless-collection--examples) for a sample template. Otherwise the encryption policy must already exist before you create the collection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html}
+ */
+export type OpenSearchServerlessCollectionProps = {
+    /**
+     * A description of the collection.
+     * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-description}
+     */
+    Description?: string | undefined;
+    /**
+     * The name of the collection.
+     *
+     * Collection names must meet the following criteria:
+     *
+     * - Starts with a lowercase letter
+     * - Unique to your account and AWS Region
+     * - Contains between 3 and 28 characters
+     * - Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)
+     * @minLength 3
+     * @maxLength 32
+     * @pattern ^[a-z][a-z0-9-]{2,31}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-name}
+     */
+    Name: string;
+    /**
+     * Indicates whether to use standby replicas for the collection. You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-standbyreplicas}
+     */
+    StandbyReplicas?: StandbyReplicas | undefined;
+    /**
+     * An arbitrary set of tags (key–value pairs) to associate with the collection.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-tags}
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The type of collection. Possible values are `SEARCH` , `TIMESERIES` , and `VECTORSEARCH` . For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-type}
+     */
+    Type?: CollectionType | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#aws-resource-opensearchserverless-collection-return-values}
+ */
+export type OpenSearchServerlessCollectionAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the collection. For example, `arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-arn}
+     */
+    Arn: string;
+    /**
+     * Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. For example, `https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-collectionendpoint}
+     */
+    CollectionEndpoint: string;
+    /**
+     * The collection-specific endpoint used to access OpenSearch Dashboards. For example, `https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-dashboardendpoint}
+     */
+    DashboardEndpoint: string;
+    /**
+     * A unique identifier for the collection. For example, `07tjusf2h91cunochc` .
+     * @minLength 3
+     * @maxLength 40
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-id}
+     */
+    Id: string;
+};
+/**
+ * The possible types for the collection
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-collectiontype.html}
+ */
+export type CollectionType = "SEARCH" | "TIMESERIES" | "VECTORSEARCH";
+/**
+ * The possible standby replicas for the collection
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-standbyreplicas.html}
+ */
+export type StandbyReplicas = "ENABLED" | "DISABLED";
+//# sourceMappingURL=aws-opensearchserverless-collection.d.ts.map

package/out/exports/resources.generated/aws-opensearchserverless-index.d.ts

@@ -0,0 +1,138 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * An OpenSearch Serverless index resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html}
+ */
+export type OpenSearchServerlessIndex = ResourceDefinitionWithAttributes<"AWS::OpenSearchServerless::Index", OpenSearchServerlessIndexProps, OpenSearchServerlessIndexAttribs>;
+/**
+ * An OpenSearch Serverless index resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html}
+ */
+export type OpenSearchServerlessIndexProps = {
+    /**
+     * The endpoint for the collection.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-collectionendpoint}
+     */
+    CollectionEndpoint: string;
+    /**
+     * The name of the OpenSearch Serverless index.
+     * @pattern ^(?![_-])[a-z][a-z0-9_-]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-indexname}
+     */
+    IndexName: string;
+    /**
+     * Index mappings for the OpenSearch Serverless index.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-mappings}
+     */
+    Mappings?: {
+        /**
+         * Defines the fields within the mapping, including their types and configurations
+         */
+        Properties?: Record<string, PropertyMapping> | undefined;
+    } | undefined;
+    /**
+     * Index settings for the OpenSearch Serverless index.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-settings}
+     */
+    Settings?: IndexSettings | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#aws-resource-opensearchserverless-index-return-values}
+ */
+export type OpenSearchServerlessIndexAttribs = {
+    /**
+     * The unique identifier for the index.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-uuid}
+     */
+    Uuid: string;
+};
+/**
+ * Index settings for the OpenSearch Serverless index.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html}
+ */
+export type IndexSettings = {
+    /**
+     * Index settings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html#cfn-opensearchserverless-index-indexsettings-index}
+     */
+    Index?: {
+        /**
+         * Enable/disable k-nearest neighbor search capability
+         */
+        Knn?: boolean | undefined;
+        /**
+         * Size of the dynamic list for the nearest neighbors
+         */
+        KnnAlgoParamEfSearch?: number | undefined;
+        /**
+         * How often to perform refresh operation (e.g. '1s', '5s')
+         */
+        RefreshInterval?: string | undefined;
+    } | undefined;
+};
+/**
+ * Property mappings for the OpenSearch Serverless index.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html}
+ */
+export type PropertyMapping = {
+    /**
+     * Dimension size for vector fields, defines the number of dimensions in the vector.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-dimension}
+     */
+    Dimension?: number | undefined;
+    /**
+     * Whether a field should be indexed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-index}
+     */
+    Index?: boolean | undefined;
+    /**
+     * Configuration for k-NN search method.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-method}
+     */
+    Method?: {
+        /**
+         * The k-NN search engine to use
+         */
+        Engine: "nmslib" | "faiss" | "lucene";
+        /**
+         * The algorithm name for k-NN search
+         */
+        Name: "hnsw" | "ivf";
+        /**
+         * Additional parameters for the k-NN algorithm
+         */
+        Parameters?: {
+            /**
+             * The size of the dynamic list used during k-NN graph creation
+             * @min 1
+             */
+            EfConstruction?: number | undefined;
+            /**
+             * Number of neighbors to consider during k-NN search
+             * @min 2
+             * @max 100
+             */
+            M?: number | undefined;
+        } | undefined;
+        /**
+         * The distance function used for k-NN search
+         */
+        SpaceType?: "l2" | "l1" | "linf" | "cosinesimil" | "innerproduct" | "hamming" | undefined;
+    } | undefined;
+    /**
+     * Defines the fields within the mapping, including their types and configurations.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-properties}
+     */
+    Properties?: Record<string, PropertyMapping> | undefined;
+    /**
+     * The field data type. Must be a valid OpenSearch field type.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-type}
+     */
+    Type: "text" | "knn_vector";
+    /**
+     * Default value for the field when not specified in a document.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-value}
+     */
+    Value?: string | undefined;
+};
+//# sourceMappingURL=aws-opensearchserverless-index.d.ts.map