@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-timestream-influxdbinstance.d.ts

@@ -1,13 +1,19 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * A DB instance is an isolated database environment running in the cloud. It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html}
+ */
 export type TimestreamInfluxDBInstance = ResourceDefinitionWithAttributes<"AWS::Timestream::InfluxDBInstance", TimestreamInfluxDBInstanceProps, TimestreamInfluxDBInstanceAttribs>;
 /**
  * A DB instance is an isolated database environment running in the cloud. It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html}
  */
 export type TimestreamInfluxDBInstanceProps = {
     /**
      * The amount of storage to allocate for your DB storage type in GiB (gibibytes).
      * @min 20
      * @max 16384
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-allocatedstorage}
      */
     AllocatedStorage?: number | undefined;
     /**
@@ -15,10 +21,12 @@ export type TimestreamInfluxDBInstanceProps = {
      * @minLength 2
      * @maxLength 64
      * @pattern ^[^_][^"]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-bucket}
      */
     Bucket?: string | undefined;
     /**
      * The Timestream for InfluxDB DB instance type to run on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbinstancetype}
      */
     DbInstanceType?: "db.influx.medium" | "db.influx.large" | "db.influx.xlarge" | "db.influx.2xlarge" | "db.influx.4xlarge" | "db.influx.8xlarge" | "db.influx.12xlarge" | "db.influx.16xlarge" | undefined;
     /**
@@ -26,6 +34,7 @@ export type TimestreamInfluxDBInstanceProps = {
      * @minLength 3
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbparametergroupidentifier}
      */
     DbParameterGroupIdentifier?: string | undefined;
     /**
@@ -36,14 +45,17 @@ export type TimestreamInfluxDBInstanceProps = {
      * - Influx IO Included 3000 IOPS
      * - Influx IO Included 12000 IOPS
      * - Influx IO Included 16000 IOPS
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-dbstoragetype}
      */
     DbStorageType?: "InfluxIOIncludedT1" | "InfluxIOIncludedT2" | "InfluxIOIncludedT3" | undefined;
     /**
      * Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-deploymenttype}
      */
     DeploymentType?: "SINGLE_AZ" | "WITH_MULTIAZ_STANDBY" | undefined;
     /**
      * Configuration for sending InfluxDB engine logs to a specified S3 bucket.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-logdeliveryconfiguration}
      */
     LogDeliveryConfiguration?: {
         /**
@@ -68,16 +80,19 @@ export type TimestreamInfluxDBInstanceProps = {
      * @minLength 3
      * @maxLength 40
      * @pattern ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-name}
      */
     Name?: string | undefined;
     /**
      * Network type of the InfluxDB Instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-networktype}
      */
     NetworkType?: "IPV4" | "DUAL" | undefined;
     /**
      * The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
      * @minLength 1
      * @maxLength 64
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-organization}
      */
     Organization?: string | undefined;
     /**
@@ -85,52 +100,65 @@ export type TimestreamInfluxDBInstanceProps = {
      * @minLength 8
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-password}
      */
     Password?: string | undefined;
     /**
      * The port number on which InfluxDB accepts connections.
      * @min 1024
      * @max 65535
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-port}
      */
     Port?: number | undefined;
     /**
      * Configures the DB instance with a public IP to facilitate access.
      * @default false
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-publiclyaccessible}
      */
     PubliclyAccessible?: boolean | undefined;
     /**
      * A list of key-value pairs to associate with the DB instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.
      * @minLength 1
      * @maxLength 64
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-username}
      */
     Username?: string | undefined;
     /**
      * A list of VPC security group IDs to associate with the DB instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsecuritygroupids}
      */
     VpcSecurityGroupIds?: string[] | undefined;
     /**
      * A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-vpcsubnetids}
      */
     VpcSubnetIds?: string[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#aws-resource-timestream-influxdbinstance-return-values}
+ */
 export type TimestreamInfluxDBInstanceAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the DB instance
      * @minLength 1
      * @maxLength 1011
      * @pattern ^arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance)/[a-zA-Z0-9]{3,64}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-arn}
      */
     Arn: string;
     /**
      * The Availability Zone in which the DB instance resides.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-availabilityzone}
      */
     AvailabilityZone: string;
     /**
      * The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-endpoint}
      */
     Endpoint: string;
     /**
@@ -138,21 +166,25 @@ export type TimestreamInfluxDBInstanceAttribs = {
      * @minLength 3
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-id}
      */
     Id: string;
     /**
      * The Amazon Resource Name (ARN) of the Amazon Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
      * @pattern ^arn:[a-z]*:secretsmanager:[a-z\-0-9]*:[0-9]*:secret:[a-zA-Z0-9\-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-influxauthparameterssecretarn}
      */
     InfluxAuthParametersSecretArn: string;
     /**
      * Describes an Availability Zone in which the InfluxDB instance is located
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-secondaryavailabilityzone}
      */
     SecondaryAvailabilityZone: string;
     /**
      * The status of the DB instance.
      *
      * Valid Values: `CREATING` | `AVAILABLE` | `DELETING` | `MODIFYING` | `UPDATING` | `DELETED` | `FAILED`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-influxdbinstance.html#cfn-timestream-influxdbinstance-status}
      */
     Status: "CREATING" | "AVAILABLE" | "DELETING" | "MODIFYING" | "UPDATING" | "UPDATING_DEPLOYMENT_TYPE" | "UPDATING_INSTANCE_TYPE" | "DELETED" | "FAILED";
 };

package/out/exports/resources.generated/aws-timestream-scheduledquery.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the `ScheduledQueryExecutionRoleArn` parameter to run the query. You can use the `NotificationConfiguration` parameter to configure notification for your scheduled query operations.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html}
+ */
 export type TimestreamScheduledQuery = ResourceDefinitionWithAttributes<"AWS::Timestream::ScheduledQuery", TimestreamScheduledQueryProps, TimestreamScheduledQueryAttribs>;
 /**
  * Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the `ScheduledQueryExecutionRoleArn` parameter to run the query. You can use the `NotificationConfiguration` parameter to configure notification for your scheduled query operations.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html}
  */
 export type TimestreamScheduledQueryProps = {
     /**
@@ -9,270 +14,341 @@ export type TimestreamScheduledQueryProps = {
      *
      * - If CreateScheduledQuery is called without a `ClientToken` , the Query SDK generates a `ClientToken` on your behalf.
      * - After 8 hours, any request with the same `ClientToken` is treated as a new request.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-clienttoken}
      */
     ClientToken?: string | undefined;
     /**
      * Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-errorreportconfiguration}
      */
     ErrorReportConfiguration: ErrorReportConfiguration;
     /**
      * The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with *alias/*
      *
      * If ErrorReportConfiguration uses `SSE_KMS` as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-notificationconfiguration}
      */
     NotificationConfiguration: NotificationConfiguration;
     /**
      * The query string to run. Parameter names can be specified in the query string `@` character followed by an identifier. The named Parameter `@scheduled_runtime` is reserved and can be used in the query to get the time at which the query is scheduled to run.
      *
      * The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of `@scheduled_runtime` paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the `@scheduled_runtime` parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-querystring}
      */
     QueryString: string;
     /**
      * Schedule configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduleconfiguration}
      */
     ScheduleConfiguration: ScheduleConfiguration;
     /**
      * The ARN for the IAM role that Timestream will assume when running the scheduled query.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn}
      */
     ScheduledQueryExecutionRoleArn: string;
     /**
      * A name for the query. Scheduled query names must be unique within each Region.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryname}
      */
     ScheduledQueryName?: string | undefined;
     /**
      * A list of key-value pairs to label the scheduled query.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * Scheduled query target store configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-targetconfiguration}
      */
     TargetConfiguration?: TargetConfiguration | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#aws-resource-timestream-scheduledquery-return-values}
+ */
 export type TimestreamScheduledQueryAttribs = {
     /**
      * The `ARN` of the scheduled query.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-arn}
      */
     Arn: string;
     /**
      * The scheduled query error reporting configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqerrorreportconfiguration}
      */
     SQErrorReportConfiguration: string;
     /**
      * The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqkmskeyid}
      */
     SQKmsKeyId: string;
     /**
      * The scheduled query name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqname}
      */
     SQName: string;
     /**
      * The scheduled query notification configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqnotificationconfiguration}
      */
     SQNotificationConfiguration: string;
     /**
      * The scheduled query string..
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqquerystring}
      */
     SQQueryString: string;
     /**
      * The scheduled query schedule configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqscheduleconfiguration}
      */
     SQScheduleConfiguration: string;
     /**
      * The ARN of the IAM role that will be used by Timestream to run the query.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqscheduledqueryexecutionrolearn}
      */
     SQScheduledQueryExecutionRoleArn: string;
     /**
      * The configuration for query output.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-sqtargetconfiguration}
      */
     SQTargetConfiguration: string;
 };
 /**
  * This type is used to map column(s) from the query result to a dimension in the destination table.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html}
  */
 export type DimensionMapping = {
     /**
      * Type for the dimension: VARCHAR
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html#cfn-timestream-scheduledquery-dimensionmapping-dimensionvaluetype}
      */
     DimensionValueType: DimensionValueType;
     /**
      * Column name from query result.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionmapping.html#cfn-timestream-scheduledquery-dimensionmapping-name}
      */
     Name: string;
 };
 /**
  * Type for the dimension.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-dimensionvaluetype.html}
  */
 export type DimensionValueType = "VARCHAR";
 /**
  * Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-encryptionoption.html}
  */
 export type EncryptionOption = "SSE_S3" | "SSE_KMS";
 /**
  * Configuration required for error reporting.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-errorreportconfiguration.html}
  */
 export type ErrorReportConfiguration = {
     /**
      * The S3 configuration for the error reports.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-errorreportconfiguration.html#cfn-timestream-scheduledquery-errorreportconfiguration-s3configuration}
      */
     S3Configuration: S3Configuration;
 };
 /**
  * MixedMeasureMappings are mappings that can be used to ingest data into a mixture of narrow and multi measures in the derived table.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html}
  */
 export type MixedMeasureMapping = {
     /**
      * Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-measurename}
      */
     MeasureName?: string | undefined;
     /**
      * Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-measurevaluetype}
      */
     MeasureValueType: MixedMeasureMappingMeasureValueType;
     /**
      * Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-multimeasureattributemappings}
      */
     MultiMeasureAttributeMappings?: MultiMeasureAttributeMapping[] | undefined;
     /**
      * This field refers to the source column from which measure-value is to be read for result materialization.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-sourcecolumn}
      */
     SourceColumn?: string | undefined;
     /**
      * Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremapping.html#cfn-timestream-scheduledquery-mixedmeasuremapping-targetmeasurename}
      */
     TargetMeasureName?: string | undefined;
 };
 /**
  * Type of the value that is to be read from SourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-mixedmeasuremappingmeasurevaluetype.html}
  */
 export type MixedMeasureMappingMeasureValueType = "BIGINT" | "BOOLEAN" | "DOUBLE" | "VARCHAR" | "MULTI";
 /**
  * Attribute mapping for MULTI value measures.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html}
  */
 export type MultiMeasureAttributeMapping = {
     /**
      * Type of the attribute to be read from the source column.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-measurevaluetype}
      */
     MeasureValueType: MultiMeasureAttributeMappingMeasureValueType;
     /**
      * Source column from where the attribute value is to be read.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-sourcecolumn}
      */
     SourceColumn: string;
     /**
      * Custom name to be used for attribute name in derived table. If not provided, source column name would be used.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemapping.html#cfn-timestream-scheduledquery-multimeasureattributemapping-targetmultimeasureattributename}
      */
     TargetMultiMeasureAttributeName?: string | undefined;
 };
 /**
  * Value type of the measure value column to be read from the query result.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasureattributemappingmeasurevaluetype.html}
  */
 export type MultiMeasureAttributeMappingMeasureValueType = "BIGINT" | "BOOLEAN" | "DOUBLE" | "VARCHAR" | "TIMESTAMP";
 /**
  * Only one of MixedMeasureMappings or MultiMeasureMappings is to be provided. MultiMeasureMappings can be used to ingest data as multi measures in the derived table.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html}
  */
 export type MultiMeasureMappings = {
     /**
      * Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html#cfn-timestream-scheduledquery-multimeasuremappings-multimeasureattributemappings}
      */
     MultiMeasureAttributeMappings: MultiMeasureAttributeMapping[];
     /**
      * The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-multimeasuremappings.html#cfn-timestream-scheduledquery-multimeasuremappings-targetmultimeasurename}
      */
     TargetMultiMeasureName?: string | undefined;
 };
 /**
  * Notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated or when it is deleted.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-notificationconfiguration.html}
  */
 export type NotificationConfiguration = {
     /**
      * Details on SNS configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-notificationconfiguration.html#cfn-timestream-scheduledquery-notificationconfiguration-snsconfiguration}
      */
     SnsConfiguration: SnsConfiguration;
 };
 /**
  * Details on S3 location for error reports that result from running a query.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html}
  */
 export type S3Configuration = {
     /**
      * Name of the S3 bucket under which error reports will be created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-bucketname}
      */
     BucketName: string;
     /**
      * Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-encryptionoption}
      */
     EncryptionOption?: EncryptionOption | undefined;
     /**
      * Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-s3configuration.html#cfn-timestream-scheduledquery-s3configuration-objectkeyprefix}
      */
     ObjectKeyPrefix?: string | undefined;
 };
 /**
  * Configuration of the schedule of the query.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-scheduleconfiguration.html}
  */
 export type ScheduleConfiguration = {
     /**
      * An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-scheduleconfiguration.html#cfn-timestream-scheduledquery-scheduleconfiguration-scheduleexpression}
      */
     ScheduleExpression: string;
 };
 /**
  * Details on SNS that are required to send the notification.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-snsconfiguration.html}
  */
 export type SnsConfiguration = {
     /**
      * SNS topic ARN that the scheduled query status notifications will be sent to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-snsconfiguration.html#cfn-timestream-scheduledquery-snsconfiguration-topicarn}
      */
     TopicArn: string;
 };
 /**
  * A key-value pair to label the scheduled query.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-tag.html}
  */
 export type Tag = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-tag.html#cfn-timestream-scheduledquery-tag-key}
+     */
     Key: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-tag.html#cfn-timestream-scheduledquery-tag-value}
+     */
     Value: string;
 };
 /**
  * Configuration used for writing the output of a query.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-targetconfiguration.html}
  */
 export type TargetConfiguration = {
     /**
      * Configuration needed to write data into the Timestream database and table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-targetconfiguration.html#cfn-timestream-scheduledquery-targetconfiguration-timestreamconfiguration}
      */
     TimestreamConfiguration: TimestreamConfiguration;
 };
 /**
  * Configuration to write data into Timestream database and table. This configuration allows the user to map the query result select columns into the destination table columns.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html}
  */
 export type TimestreamConfiguration = {
     /**
      * Name of Timestream database to which the query result will be written.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-databasename}
      */
     DatabaseName: string;
     /**
      * This is to allow mapping column(s) from the query result to the dimension in the destination table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-dimensionmappings}
      */
     DimensionMappings: DimensionMapping[];
     /**
      * Name of the measure column. Also see `MultiMeasureMappings` and `MixedMeasureMappings` for how measure name properties on those relate to `MeasureNameColumn` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-measurenamecolumn}
      */
     MeasureNameColumn?: string | undefined;
     /**
      * Specifies how to map measures to multi-measure records.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-mixedmeasuremappings}
      */
     MixedMeasureMappings?: MixedMeasureMapping[] | undefined;
     /**
      * Multi-measure mappings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-multimeasuremappings}
      */
     MultiMeasureMappings?: MultiMeasureMappings | undefined;
     /**
      * Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-tablename}
      */
     TableName: string;
     /**
      * Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-scheduledquery-timestreamconfiguration.html#cfn-timestream-scheduledquery-timestreamconfiguration-timecolumn}
      */
     TimeColumn: string;
 };

package/out/exports/resources.generated/aws-timestream-table.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The CreateTable operation adds a new table to an existing database in your account. In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) . See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html}
+ */
 export type TimestreamTable = ResourceDefinitionWithAttributes<"AWS::Timestream::Table", TimestreamTableProps, TimestreamTableAttribs>;
 /**
  * The CreateTable operation adds a new table to an existing database in your account. In an AWS account, table names must be at least unique within each Region if they are in the same database. You may have identical table names in the same Region if the tables are in separate databases. While creating the table, you must specify the table name, database name, and the retention properties. [Service quotas apply](https://docs.aws.amazon.com/timestream/latest/developerguide/ts-limits.html) . See [code sample](https://docs.aws.amazon.com/timestream/latest/developerguide/code-samples.create-table.html) for details.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html}
  */
 export type TimestreamTableProps = {
     /**
@@ -9,6 +14,7 @@ export type TimestreamTableProps = {
      *
      * *Length Constraints* : Minimum length of 3 bytes. Maximum length of 256 bytes.
      * @pattern ^[a-zA-Z0-9_.-]{3,256}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-databasename}
      */
     DatabaseName: string;
     /**
@@ -44,6 +50,7 @@ export type TimestreamTableProps = {
      * DependsOn: TestDatabase
      * Properties: TableName: "TestTable" DatabaseName: "TestDatabase" MagneticStoreWriteProperties: EnableMagneticStoreWrites: true MagneticStoreRejectedDataLocation: S3Configuration: BucketName: " amzn-s3-demo-bucket " EncryptionOption: "SSE_KMS" KmsKeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" ObjectKeyPrefix: "prefix"
      * ```
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-magneticstorewriteproperties}
      */
     MagneticStoreWriteProperties?: {
         /**
@@ -98,6 +105,7 @@ export type TimestreamTableProps = {
      * DependsOn: TestDatabase
      * Properties: TableName: "TestTable" DatabaseName: "TestDatabase" RetentionProperties: MemoryStoreRetentionPeriodInHours: "24" MagneticStoreRetentionPeriodInDays: "7"
      * ```
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-retentionproperties}
      */
     RetentionProperties?: {
         /**
@@ -111,6 +119,7 @@ export type TimestreamTableProps = {
     } | undefined;
     /**
      * The schema of the table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-schema}
      */
     Schema?: {
         CompositePartitionKey?: PartitionKey[] | undefined;
@@ -120,46 +129,59 @@ export type TimestreamTableProps = {
      *
      * *Length Constraints* : Minimum length of 3 bytes. Maximum length of 256 bytes.
      * @pattern ^[a-zA-Z0-9_.-]{3,256}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tablename}
      */
     TableName?: string | undefined;
     /**
      * The tags to add to the table
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#aws-resource-timestream-table-return-values}
+ */
 export type TimestreamTableAttribs = {
     /**
      * The `arn` of the table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-arn}
      */
     Arn: string;
     /**
      * The name of the table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-table.html#cfn-timestream-table-name}
      */
     Name: string;
 };
 /**
  * An attribute used in partitioning data in a table. A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the 'measure_name' column).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html}
  */
 export type PartitionKey = {
     /**
      * The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-enforcementinrecord}
      */
     EnforcementInRecord?: PartitionKeyEnforcementLevel | undefined;
     /**
      * The name of the attribute used for a dimension key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-name}
      */
     Name?: string | undefined;
     /**
      * The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkey.html#cfn-timestream-table-partitionkey-type}
      */
     Type: PartitionKeyType;
 };
 /**
  * The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkeyenforcementlevel.html}
  */
 export type PartitionKeyEnforcementLevel = "REQUIRED" | "OPTIONAL";
 /**
  * The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-timestream-table-partitionkeytype.html}
  */
 export type PartitionKeyType = "DIMENSION" | "MEASURE";
 //# sourceMappingURL=aws-timestream-table.d.ts.map