aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
969 lines • 86.8 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
*
* 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* .
*
* @cloudformationResource AWS::IoTAnalytics::Channel
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html
*/
export declare class CfnChannel extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnChannel from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnChannel;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The name of the channel.
*/
channelName?: string;
/**
* Where channel data is stored.
*/
channelStorage?: CfnChannel.ChannelStorageProperty | cdk.IResolvable;
/**
* How long, in days, message data is kept for the channel.
*/
retentionPeriod?: cdk.IResolvable | CfnChannel.RetentionPeriodProperty;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Metadata which can be used to manage the channel.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnChannelProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnChannel {
/**
* Where channel data is stored.
*
* You may choose one of `serviceManagedS3` , `customerManagedS3` storage. If not specified, the default is `serviceManagedS3` . This can't be changed after creation of the channel.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html
*/
interface ChannelStorageProperty {
/**
* Used to store channel data in an S3 bucket that you manage.
*
* If customer managed storage is selected, the `retentionPeriod` parameter is ignored. You can't change the choice of S3 storage after the data store is created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-customermanageds3
*/
readonly customerManagedS3?: CfnChannel.CustomerManagedS3Property | cdk.IResolvable;
/**
* Used to store channel data in an S3 bucket managed by AWS IoT Analytics .
*
* You can't change the choice of S3 storage after the data store is created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.html#cfn-iotanalytics-channel-channelstorage-servicemanageds3
*/
readonly serviceManagedS3?: any | cdk.IResolvable;
}
/**
* Used to store channel data in an S3 bucket that you manage.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html
*/
interface CustomerManagedS3Property {
/**
* The name of the S3 bucket in which channel data is stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-bucket
*/
readonly bucket: string;
/**
* (Optional) The prefix used to create the keys of the channel data objects.
*
* Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-keyprefix
*/
readonly keyPrefix?: string;
/**
* The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-rolearn
*/
readonly roleArn: string;
}
/**
* How long, in days, message data is kept.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html
*/
interface RetentionPeriodProperty {
/**
* The number of days that message data is kept.
*
* The `unlimited` parameter must be false.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays
*/
readonly numberOfDays?: number;
/**
* If true, message data is kept indefinitely.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-unlimited
*/
readonly unlimited?: boolean | cdk.IResolvable;
}
}
/**
* Properties for defining a `CfnChannel`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html
*/
export interface CfnChannelProps {
/**
* The name of the channel.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelname
*/
readonly channelName?: string;
/**
* Where channel data is stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelstorage
*/
readonly channelStorage?: CfnChannel.ChannelStorageProperty | cdk.IResolvable;
/**
* How long, in days, message data is kept for the channel.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-retentionperiod
*/
readonly retentionPeriod?: cdk.IResolvable | CfnChannel.RetentionPeriodProperty;
/**
* Metadata which can be used to manage the channel.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* The AWS::IoTAnalytics::Dataset resource stores data retrieved from a data store by applying a `queryAction` (an SQL query) or a `containerAction` (executing a containerized application).
*
* The data set can be populated manually by calling `CreateDatasetContent` or automatically according to a `trigger` you specify. 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* .
*
* @cloudformationResource AWS::IoTAnalytics::Dataset
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html
*/
export declare class CfnDataset extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDataset from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataset;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The `DatasetAction` objects that automatically create the dataset contents.
*/
actions: Array<CfnDataset.ActionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* When dataset contents are created they are delivered to destinations specified here.
*/
contentDeliveryRules?: Array<CfnDataset.DatasetContentDeliveryRuleProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The name of the dataset.
*/
datasetName?: string;
/**
* A list of data rules that send notifications to CloudWatch, when data arrives late.
*/
lateDataRules?: Array<cdk.IResolvable | CfnDataset.LateDataRuleProperty> | cdk.IResolvable;
/**
* Optional.
*/
retentionPeriod?: cdk.IResolvable | CfnDataset.RetentionPeriodProperty;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Metadata which can be used to manage the data set.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* The `DatasetTrigger` objects that specify when the dataset is automatically updated.
*/
triggers?: Array<cdk.IResolvable | CfnDataset.TriggerProperty> | cdk.IResolvable;
/**
* Optional.
*/
versioningConfiguration?: cdk.IResolvable | CfnDataset.VersioningConfigurationProperty;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnDatasetProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnDataset {
/**
* Information needed to run the "containerAction" to produce data set contents.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html
*/
interface ActionProperty {
/**
* The name of the data set action by which data set contents are automatically created.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-actionname
*/
readonly actionName: string;
/**
* Information which allows the system to run a containerized application in order to create the data set contents.
*
* The application must be in a Docker container along with any needed support libraries.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-containeraction
*/
readonly containerAction?: CfnDataset.ContainerActionProperty | cdk.IResolvable;
/**
* An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-action.html#cfn-iotanalytics-dataset-action-queryaction
*/
readonly queryAction?: cdk.IResolvable | CfnDataset.QueryActionProperty;
}
/**
* Information needed to run the "containerAction" to produce data set contents.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html
*/
interface ContainerActionProperty {
/**
* The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction".
*
* This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-executionrolearn
*/
readonly executionRoleArn: string;
/**
* The ARN of the Docker container stored in your account.
*
* The Docker container contains an application and needed support libraries and is used to generate data set contents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-image
*/
readonly image: string;
/**
* Configuration of the resource which executes the "containerAction".
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-resourceconfiguration
*/
readonly resourceConfiguration: cdk.IResolvable | CfnDataset.ResourceConfigurationProperty;
/**
* The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application).
*
* Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue".
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-containeraction.html#cfn-iotanalytics-dataset-containeraction-variables
*/
readonly variables?: Array<cdk.IResolvable | CfnDataset.VariableProperty> | cdk.IResolvable;
}
/**
* An instance of a variable to be passed to the `containerAction` execution.
*
* Each variable must have a name and a value given by one of `stringValue` , `datasetContentVersionValue` , or `outputFileUriValue` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html
*/
interface VariableProperty {
/**
* The value of the variable as a structure that specifies a dataset content version.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-datasetcontentversionvalue
*/
readonly datasetContentVersionValue?: CfnDataset.DatasetContentVersionValueProperty | cdk.IResolvable;
/**
* The value of the variable as a double (numeric).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-doublevalue
*/
readonly doubleValue?: number;
/**
* The value of the variable as a structure that specifies an output file URI.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-outputfileurivalue
*/
readonly outputFileUriValue?: cdk.IResolvable | CfnDataset.OutputFileUriValueProperty;
/**
* The value of the variable as a string.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-stringvalue
*/
readonly stringValue?: string;
/**
* The name of the variable.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-variable.html#cfn-iotanalytics-dataset-variable-variablename
*/
readonly variableName: string;
}
/**
* The dataset whose latest contents are used as input to the notebook or application.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentversionvalue.html
*/
interface DatasetContentVersionValueProperty {
/**
* The name of the dataset whose latest contents are used as input to the notebook or application.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentversionvalue.html#cfn-iotanalytics-dataset-datasetcontentversionvalue-datasetname
*/
readonly datasetName: string;
}
/**
* The value of the variable as a structure that specifies an output file URI.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.html
*/
interface OutputFileUriValueProperty {
/**
* The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-outputfileurivalue.html#cfn-iotanalytics-dataset-outputfileurivalue-filename
*/
readonly fileName: string;
}
/**
* The configuration of the resource used to execute the `containerAction` .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html
*/
interface ResourceConfigurationProperty {
/**
* The type of the compute resource used to execute the `containerAction` .
*
* Possible values are: `ACU_1` (vCPU=4, memory=16 GiB) or `ACU_2` (vCPU=8, memory=32 GiB).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-computetype
*/
readonly computeType: string;
/**
* The size, in GB, of the persistent storage available to the resource instance used to execute the `containerAction` (min: 1, max: 50).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-resourceconfiguration.html#cfn-iotanalytics-dataset-resourceconfiguration-volumesizeingb
*/
readonly volumeSizeInGb: number;
}
/**
* An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html
*/
interface QueryActionProperty {
/**
* Pre-filters applied to message data.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-filters
*/
readonly filters?: Array<CfnDataset.FilterProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-queryaction.html#cfn-iotanalytics-dataset-queryaction-sqlquery
*/
readonly sqlQuery: string;
}
/**
* Information which is used to filter message data, to segregate it according to the time frame in which it arrives.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html
*/
interface FilterProperty {
/**
* Used to limit data to that which has arrived since the last execution of the action.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-filter.html#cfn-iotanalytics-dataset-filter-deltatime
*/
readonly deltaTime?: CfnDataset.DeltaTimeProperty | cdk.IResolvable;
}
/**
* Used to limit data to that which has arrived since the last execution of the action.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html
*/
interface DeltaTimeProperty {
/**
* The number of seconds of estimated in-flight lag time of message data.
*
* When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-offsetseconds
*/
readonly offsetSeconds: number;
/**
* An expression by which the time of the message data might be determined.
*
* This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatime.html#cfn-iotanalytics-dataset-deltatime-timeexpression
*/
readonly timeExpression: string;
}
/**
* A structure that contains the name and configuration information of a late data rule.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html
*/
interface LateDataRuleProperty {
/**
* The information needed to configure the late data rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-ruleconfiguration
*/
readonly ruleConfiguration: cdk.IResolvable | CfnDataset.LateDataRuleConfigurationProperty;
/**
* The name of the late data rule.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedatarule.html#cfn-iotanalytics-dataset-latedatarule-rulename
*/
readonly ruleName?: string;
}
/**
* The information needed to configure a delta time session window.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html
*/
interface LateDataRuleConfigurationProperty {
/**
* The information needed to configure a delta time session window.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-latedataruleconfiguration.html#cfn-iotanalytics-dataset-latedataruleconfiguration-deltatimesessionwindowconfiguration
*/
readonly deltaTimeSessionWindowConfiguration?: CfnDataset.DeltaTimeSessionWindowConfigurationProperty | cdk.IResolvable;
}
/**
* A structure that contains the configuration information of a delta time session window.
*
* [`DeltaTime`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) specifies a time interval. You can use `DeltaTime` to create dataset contents with data that has arrived in the data store since the last execution. For an example of `DeltaTime` , see [Creating a SQL dataset with a delta window (CLI)](https://docs.aws.amazon.com/iotanalytics/latest/userguide/automate-create-dataset.html#automate-example6) in the *AWS IoT Analytics User Guide* .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html
*/
interface DeltaTimeSessionWindowConfigurationProperty {
/**
* A time interval.
*
* You can use `timeoutInMinutes` so that AWS IoT Analytics can batch up late data notifications that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.
*
* For more information about how to write a timestamp expression, see [Date and Time Functions and Operators](https://docs.aws.amazon.com/https://prestodb.io/docs/current/functions/datetime.html) , in the *Presto 0.172 Documentation* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-deltatimesessionwindowconfiguration.html#cfn-iotanalytics-dataset-deltatimesessionwindowconfiguration-timeoutinminutes
*/
readonly timeoutInMinutes: number;
}
/**
* When dataset contents are created, they are delivered to destination specified here.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html
*/
interface DatasetContentDeliveryRuleProperty {
/**
* The destination to which dataset contents are delivered.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-destination
*/
readonly destination: CfnDataset.DatasetContentDeliveryRuleDestinationProperty | cdk.IResolvable;
/**
* The name of the dataset content delivery rules entry.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryrule.html#cfn-iotanalytics-dataset-datasetcontentdeliveryrule-entryname
*/
readonly entryName?: string;
}
/**
* The destination to which dataset contents are delivered.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html
*/
interface DatasetContentDeliveryRuleDestinationProperty {
/**
* Configuration information for delivery of dataset contents to AWS IoT Events .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-ioteventsdestinationconfiguration
*/
readonly iotEventsDestinationConfiguration?: CfnDataset.IotEventsDestinationConfigurationProperty | cdk.IResolvable;
/**
* Configuration information for delivery of dataset contents to Amazon S3.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-datasetcontentdeliveryruledestination.html#cfn-iotanalytics-dataset-datasetcontentdeliveryruledestination-s3destinationconfiguration
*/
readonly s3DestinationConfiguration?: cdk.IResolvable | CfnDataset.S3DestinationConfigurationProperty;
}
/**
* Configuration information for delivery of dataset contents to AWS IoT Events .
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html
*/
interface IotEventsDestinationConfigurationProperty {
/**
* The name of the AWS IoT Events input to which dataset contents are delivered.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-inputname
*/
readonly inputName: string;
/**
* The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-ioteventsdestinationconfiguration.html#cfn-iotanalytics-dataset-ioteventsdestinationconfiguration-rolearn
*/
readonly roleArn: string;
}
/**
* Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html
*/
interface S3DestinationConfigurationProperty {
/**
* The name of the S3 bucket to which dataset contents are delivered.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-bucket
*/
readonly bucket: string;
/**
* Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-glueconfiguration
*/
readonly glueConfiguration?: CfnDataset.GlueConfigurationProperty | cdk.IResolvable;
/**
* The key of the dataset contents object in an S3 bucket.
*
* Each object has a key that is a unique identifier. Each object has exactly one key.
*
* You can create a unique key with the following options:
*
* - Use `!{iotanalytics:scheduleTime}` to insert the time of a scheduled SQL query run.
* - Use `!{iotanalytics:versionId}` to insert a unique hash that identifies a dataset content.
* - Use `!{iotanalytics:creationTime}` to insert the creation time of a dataset content.
*
* The following example creates a unique key for a CSV file: `dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv`
*
* > If you don't use `!{iotanalytics:versionId}` to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same `scheduleTime` but different `versionId` s. This means that one dataset content overwrites the other.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-key
*/
readonly key: string;
/**
* The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-s3destinationconfiguration.html#cfn-iotanalytics-dataset-s3destinationconfiguration-rolearn
*/
readonly roleArn: string;
}
/**
* Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html
*/
interface GlueConfigurationProperty {
/**
* The name of the database in your AWS Glue Data Catalog in which the table is located.
*
* An AWS Glue Data Catalog database contains metadata tables.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-databasename
*/
readonly databaseName: string;
/**
* The name of the table in your AWS Glue Data Catalog that is used to perform the ETL operations.
*
* An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-glueconfiguration.html#cfn-iotanalytics-dataset-glueconfiguration-tablename
*/
readonly tableName: string;
}
/**
* The "DatasetTrigger" that specifies when the data set is automatically updated.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html
*/
interface TriggerProperty {
/**
* The "Schedule" when the trigger is initiated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-schedule
*/
readonly schedule?: cdk.IResolvable | CfnDataset.ScheduleProperty;
/**
* Information about the data set whose content generation triggers the new data set content generation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-trigger.html#cfn-iotanalytics-dataset-trigger-triggeringdataset
*/
readonly triggeringDataset?: cdk.IResolvable | CfnDataset.TriggeringDatasetProperty;
}
/**
* The schedule for when to trigger an update.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.html
*/
interface ScheduleProperty {
/**
* The expression that defines when to trigger an update.
*
* For more information, see [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) in the Amazon CloudWatch documentation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-schedule.html#cfn-iotanalytics-dataset-schedule-scheduleexpression
*/
readonly scheduleExpression: string;
}
/**
* Information about the dataset whose content generation triggers the new dataset content generation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html
*/
interface TriggeringDatasetProperty {
/**
* The name of the data set whose content generation triggers the new data set content generation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-triggeringdataset.html#cfn-iotanalytics-dataset-triggeringdataset-datasetname
*/
readonly datasetName: string;
}
/**
* Information about the versioning of dataset contents.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html
*/
interface VersioningConfigurationProperty {
/**
* How many versions of dataset contents are kept.
*
* The `unlimited` parameter must be `false` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-maxversions
*/
readonly maxVersions?: number;
/**
* If true, unlimited versions of dataset contents are kept.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-versioningconfiguration.html#cfn-iotanalytics-dataset-versioningconfiguration-unlimited
*/
readonly unlimited?: boolean | cdk.IResolvable;
}
/**
* How long, in days, message data is kept.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html
*/
interface RetentionPeriodProperty {
/**
* The number of days that message data is kept.
*
* The `unlimited` parameter must be false.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-numberofdays
*/
readonly numberOfDays?: number;
/**
* If true, message data is kept indefinitely.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-dataset-retentionperiod.html#cfn-iotanalytics-dataset-retentionperiod-unlimited
*/
readonly unlimited?: boolean | cdk.IResolvable;
}
}
/**
* Properties for defining a `CfnDataset`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html
*/
export interface CfnDatasetProps {
/**
* The `DatasetAction` objects that automatically create the dataset contents.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-actions
*/
readonly actions: Array<CfnDataset.ActionProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* When dataset contents are created they are delivered to destinations specified here.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-contentdeliveryrules
*/
readonly contentDeliveryRules?: Array<CfnDataset.DatasetContentDeliveryRuleProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* The name of the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-datasetname
*/
readonly datasetName?: string;
/**
* A list of data rules that send notifications to CloudWatch, when data arrives late.
*
* To specify `lateDataRules` , the dataset must use a [DeltaTimer](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_DeltaTime.html) filter.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-latedatarules
*/
readonly lateDataRules?: Array<cdk.IResolvable | CfnDataset.LateDataRuleProperty> | cdk.IResolvable;
/**
* Optional.
*
* How long, in days, message data is kept for the dataset.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-retentionperiod
*/
readonly retentionPeriod?: cdk.IResolvable | CfnDataset.RetentionPeriodProperty;
/**
* Metadata which can be used to manage the data set.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The `DatasetTrigger` objects that specify when the dataset is automatically updated.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-triggers
*/
readonly triggers?: Array<cdk.IResolvable | CfnDataset.TriggerProperty> | cdk.IResolvable;
/**
* Optional.
*
* How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the `retentionPeriod` parameter. For more information, see [Keeping Multiple Versions of AWS IoT Analytics datasets](https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions) in the *AWS IoT Analytics User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-dataset.html#cfn-iotanalytics-dataset-versioningconfiguration
*/
readonly versioningConfiguration?: cdk.IResolvable | CfnDataset.VersioningConfigurationProperty;
}
/**
* 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* .
*
* @cloudformationResource AWS::IoTAnalytics::Datastore
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-datastore.html
*/
export declare class CfnDatastore extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDatastore from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDatastore;
/**
* @cloudformationAttribute Id
*/
readonly attrId: string;
/**
* The name of the data store.
*/
datastoreName?: string;
/**
* Information about the partition dimensions in a data store.
*/
datastorePartitions?: CfnDatastore.DatastorePartitionsProperty | cdk.IResolvable;
/**
* Where data store data is stored.
*/
datastoreStorage?: CfnDatastore.DatastoreStorageProperty | cdk.IResolvable;
/**
* Contains the configuration information of file formats. AWS IoT Analytics data stores support JSON and [Parquet](https://docs.aws.amazon.com/https://parquet.apache.org/) .
*/
fileFormatConfiguration?: CfnDatastore.FileFormatConfigurationProperty | cdk.IResolvable;
/**
* How long, in days, message data is kept for the data store.
*/
retentionPeriod?: cdk.IResolvable | CfnDatastore.RetentionPeriodProperty;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Metadata which can be used to manage the data store.
*/
tagsRaw?: Array<cdk.CfnTag>;
/**
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnDatastoreProps);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnDatastore {
/**
* Where data store data is stored.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html
*/
interface DatastoreStorageProperty {
/**
* 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-customermanageds3
*/
readonly customerManagedS3?: CfnDatastore.CustomerManagedS3Property | cdk.IResolvable;
/**
* 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-iotsitewisemultilayerstorage
*/
readonly iotSiteWiseMultiLayerStorage?: CfnDatastore.IotSiteWiseMultiLayerStorageProperty | cdk.IResolvable;
/**
* 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 http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-datastorestorage.html#cfn-iotanalytics-datastore-datastorestorage-servicemanageds3
*/
readonly serviceManagedS3?: any | cdk.IResolvable;
}
/**
* 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.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html
*/
interface CustomerManagedS3Property {
/**
* The name of the Amazon S3 bucket where your data is stored.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-bucket
*/
readonly bucket: string;
/**
* (Optional) The prefix used to create the keys of the data store data objects.
*
* Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-datastore-customermanageds3.html#cfn-iotanalytics-datastore-customermanageds3-keyprefix
*/
readonly k