@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-iotanalytics-datastore.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * AWS::IoTAnalytics::Datastore resource is a repository for messages. For more information, see [How to Use AWS IoT Analytics](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *AWS IoT Analytics User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html}
+ */
 export type IoTAnalyticsDatastore = ResourceDefinitionWithAttributes<"AWS::IoTAnalytics::Datastore", IoTAnalyticsDatastoreProps, IoTAnalyticsDatastoreAttribs>;
 /**
  * AWS::IoTAnalytics::Datastore resource is a repository for messages. For more information, see [How to Use AWS IoT Analytics](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *AWS IoT Analytics User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html}
  */
 export type IoTAnalyticsDatastoreProps = {
     /**
@@ -9,14 +14,17 @@ export type IoTAnalyticsDatastoreProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9_]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorename}
      */
     DatastoreName?: string | undefined;
     /**
      * Information about the partition dimensions in a data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorepartitions}
      */
     DatastorePartitions?: DatastorePartitions | undefined;
     /**
      * Where data store data is stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-datastorestorage}
      */
     DatastoreStorage?: DatastoreStorage | undefined;
     /**
@@ -25,37 +33,50 @@ export type IoTAnalyticsDatastoreProps = {
      * The default file format is JSON. You can specify only one format.
      *
      * You can't change the file format after you create the data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-fileformatconfiguration}
      */
     FileFormatConfiguration?: FileFormatConfiguration | undefined;
     /**
      * How long, in days, message data is kept for the data store. When `customerManagedS3` storage is selected, this parameter is ignored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-retentionperiod}
      */
     RetentionPeriod?: RetentionPeriod | undefined;
     /**
      * Metadata which can be used to manage the data store.
      *
      * 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-iotanalytics-datastore.html#cfn-iotanalytics-datastore-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#aws-resource-iotanalytics-datastore-return-values}
+ */
 export type IoTAnalyticsDatastoreAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html#cfn-iotanalytics-datastore-id}
+     */
     Id: string;
 };
 /**
  * Contains information about a column that stores your data.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html}
  */
 export type Column = {
     /**
      * The name of the column.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-name}
      */
     Name: string;
     /**
      * The type of data. For more information about the supported data types, see [Common data types](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html) in the *AWS Glue Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-column.html#cfn-iotanalytics-datastore-column-type}
      */
     Type: string;
 };
 /**
  * S3-customer-managed; When you choose customer-managed storage, the `retentionPeriod` parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html}
  */
 export type CustomerManagedS3 = {
     /**
@@ -63,6 +84,7 @@ export type CustomerManagedS3 = {
      * @minLength 3
      * @maxLength 255
      * @pattern [a-zA-Z0-9.\-_]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-bucket}
      */
     Bucket: string;
     /**
@@ -70,17 +92,20 @@ export type CustomerManagedS3 = {
      * @minLength 1
      * @maxLength 255
      * @pattern [a-zA-Z0-9!_.*'()/{}:-]*‍/
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-keyprefix}
      */
     KeyPrefix?: string | undefined;
     /**
      * The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
      * @minLength 20
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-rolearn}
      */
     RoleArn: string;
 };
 /**
  * Amazon S3 -customer-managed; When you choose customer-managed storage, the `retentionPeriod` parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html}
  */
 export type CustomerManagedS3Storage = {
     /**
@@ -88,6 +113,7 @@ export type CustomerManagedS3Storage = {
      * @minLength 3
      * @maxLength 255
      * @pattern [a-zA-Z0-9.\-_]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-bucket}
      */
     Bucket: string;
     /**
@@ -95,45 +121,55 @@ export type CustomerManagedS3Storage = {
      * @minLength 1
      * @maxLength 255
      * @pattern [a-zA-Z0-9!_.*'()/{}:-]*‍/
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3storage.html#cfn-iotanalytics-datastore-customermanageds3storage-keyprefix}
      */
     KeyPrefix?: string | undefined;
 };
 /**
  * A single dimension to partition a data store. The dimension must be an `AttributePartition` or a `TimestampPartition` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html}
  */
 export type DatastorePartition = {
     /**
      * A partition dimension defined by an attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-partition}
      */
     Partition?: Partition | undefined;
     /**
      * A partition dimension defined by a timestamp attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartition.html#cfn-iotanalytics-datastore-datastorepartition-timestamppartition}
      */
     TimestampPartition?: TimestampPartition | undefined;
 };
 /**
  * Information about the partition dimensions in a data store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.html}
  */
 export type DatastorePartitions = {
     /**
      * A list of partition dimensions in a data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorepartitions.html#cfn-iotanalytics-datastore-datastorepartitions-partitions}
      */
     Partitions?: DatastorePartition[] | undefined;
 };
 /**
  * Where data store data is stored.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html}
  */
 export type DatastoreStorage = {
     /**
      * Use this to store data store data in an S3 bucket that you manage. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-customermanageds3}
      */
     CustomerManagedS3?: CustomerManagedS3 | undefined;
     /**
      * Use this to store data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-iotsitewisemultilayerstorage}
      */
     IotSiteWiseMultiLayerStorage?: IotSiteWiseMultiLayerStorage | undefined;
     /**
      * Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-servicemanageds3}
      */
     ServiceManagedS3?: Record<string, unknown> | undefined;
 };
@@ -143,83 +179,100 @@ export type DatastoreStorage = {
  * The default file format is JSON. You can specify only one format.
  *
  * You can't change the file format after you create the data store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html}
  */
 export type FileFormatConfiguration = {
     /**
      * Contains the configuration information of the JSON format.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-jsonconfiguration}
      */
     JsonConfiguration?: Record<string, unknown> | undefined;
     /**
      * Contains the configuration information of the Parquet format.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-fileformatconfiguration.html#cfn-iotanalytics-datastore-fileformatconfiguration-parquetconfiguration}
      */
     ParquetConfiguration?: ParquetConfiguration | undefined;
 };
 /**
  * Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html}
  */
 export type IotSiteWiseMultiLayerStorage = {
     /**
      * Stores data used by AWS IoT SiteWise in an Amazon S3 bucket that you manage.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-iotsitewisemultilayerstorage.html#cfn-iotanalytics-datastore-iotsitewisemultilayerstorage-customermanageds3storage}
      */
     CustomerManagedS3Storage?: CustomerManagedS3Storage | undefined;
 };
 /**
  * Contains the configuration information of the Parquet format.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html}
  */
 export type ParquetConfiguration = {
     /**
      * Information needed to define a schema.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-parquetconfiguration.html#cfn-iotanalytics-datastore-parquetconfiguration-schemadefinition}
      */
     SchemaDefinition?: SchemaDefinition | undefined;
 };
 /**
  * A single dimension to partition a data store. The dimension must be an `AttributePartition` or a `TimestampPartition` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.html}
  */
 export type Partition = {
     /**
      * The name of the attribute that defines a partition dimension.
      * @pattern [a-zA-Z0-9_]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-partition.html#cfn-iotanalytics-datastore-partition-attributename}
      */
     AttributeName: string;
 };
 /**
  * How long, in days, message data is kept.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html}
  */
 export type RetentionPeriod = {
     /**
      * The number of days that message data is kept. The `unlimited` parameter must be false.
      * @min 1
      * @max 2147483647
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-numberofdays}
      */
     NumberOfDays?: number | undefined;
     /**
      * If true, message data is kept indefinitely.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-retentionperiod.html#cfn-iotanalytics-datastore-retentionperiod-unlimited}
      */
     Unlimited?: boolean | undefined;
 };
 /**
  * Information needed to define a schema.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.html}
  */
 export type SchemaDefinition = {
     /**
      * Specifies one or more columns that store your data.
      *
      * Each schema can have up to 100 columns. Each column can have up to 100 nested types.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-schemadefinition.html#cfn-iotanalytics-datastore-schemadefinition-columns}
      */
     Columns?: Column[] | undefined;
 };
 /**
  * A partition dimension defined by a timestamp attribute.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html}
  */
 export type TimestampPartition = {
     /**
      * The attribute name of the partition defined by a timestamp.
      * @pattern [a-zA-Z0-9_]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-attributename}
      */
     AttributeName: string;
     /**
      * The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).
      * @pattern [a-zA-Z0-9\s\[\]_,.'/:-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-timestamppartition.html#cfn-iotanalytics-datastore-timestamppartition-timestampformat}
      */
     TimestampFormat?: string | undefined;
 };