Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. iotanalytics
  5. getDataset

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotanalytics.getDataset

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IoTAnalytics::Dataset

    Using getDataset

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
    def get_dataset(dataset_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(dataset_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

    > Note: This function is named LookupDataset in the Go SDK.

    public static class GetDataset 
{
    public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
    public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:iotanalytics:getDataset
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatasetName string
    The name of the dataset.
    DatasetName string
    The name of the dataset.
    datasetName String
    The name of the dataset.
    datasetName string
    The name of the dataset.
    dataset_name str
    The name of the dataset.
    datasetName String
    The name of the dataset.

    getDataset Result

    The following output properties are available:

    Actions List<Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetAction>
    The DatasetAction objects that automatically create the dataset contents.
    ContentDeliveryRules List<Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetContentDeliveryRule>
    When dataset contents are created they are delivered to destinations specified here.
    Id string
    LateDataRules List<Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetLateDataRule>
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    RetentionPeriod Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetRetentionPeriod
    Optional. How long, in days, message data is kept for the dataset.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    Triggers List<Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetTrigger>
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    VersioningConfiguration Pulumi.AwsNative.IoTAnalytics.Outputs.DatasetVersioningConfiguration
    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 in the AWS IoT Analytics User Guide .
    Actions []DatasetAction
    The DatasetAction objects that automatically create the dataset contents.
    ContentDeliveryRules []DatasetContentDeliveryRule
    When dataset contents are created they are delivered to destinations specified here.
    Id string
    LateDataRules []DatasetLateDataRule
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    RetentionPeriod DatasetRetentionPeriod
    Optional. How long, in days, message data is kept for the dataset.
    Tags Tag

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    Triggers []DatasetTrigger
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    VersioningConfiguration DatasetVersioningConfiguration
    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 in the AWS IoT Analytics User Guide .
    actions List<DatasetAction>
    The DatasetAction objects that automatically create the dataset contents.
    contentDeliveryRules List<DatasetContentDeliveryRule>
    When dataset contents are created they are delivered to destinations specified here.
    id String
    lateDataRules List<DatasetLateDataRule>
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    retentionPeriod DatasetRetentionPeriod
    Optional. How long, in days, message data is kept for the dataset.
    tags List<Tag>

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    triggers List<DatasetTrigger>
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    versioningConfiguration DatasetVersioningConfiguration
    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 in the AWS IoT Analytics User Guide .
    actions DatasetAction[]
    The DatasetAction objects that automatically create the dataset contents.
    contentDeliveryRules DatasetContentDeliveryRule[]
    When dataset contents are created they are delivered to destinations specified here.
    id string
    lateDataRules DatasetLateDataRule[]
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    retentionPeriod DatasetRetentionPeriod
    Optional. How long, in days, message data is kept for the dataset.
    tags Tag[]

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    triggers DatasetTrigger[]
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    versioningConfiguration DatasetVersioningConfiguration
    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 in the AWS IoT Analytics User Guide .
    actions Sequence[DatasetAction]
    The DatasetAction objects that automatically create the dataset contents.
    content_delivery_rules Sequence[DatasetContentDeliveryRule]
    When dataset contents are created they are delivered to destinations specified here.
    id str
    late_data_rules Sequence[DatasetLateDataRule]
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    retention_period DatasetRetentionPeriod
    Optional. How long, in days, message data is kept for the dataset.
    tags Sequence[root_Tag]

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    triggers Sequence[DatasetTrigger]
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    versioning_configuration DatasetVersioningConfiguration
    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 in the AWS IoT Analytics User Guide .
    actions List<Property Map>
    The DatasetAction objects that automatically create the dataset contents.
    contentDeliveryRules List<Property Map>
    When dataset contents are created they are delivered to destinations specified here.
    id String
    lateDataRules List<Property Map>
    A list of data rules that send notifications to CloudWatch, when data arrives late. To specify lateDataRules , the dataset must use a DeltaTimer filter.
    retentionPeriod Property Map
    Optional. How long, in days, message data is kept for the dataset.
    tags List<Property Map>

    Metadata which can be used to manage the data set.

    For more information, see Tag .

    triggers List<Property Map>
    The DatasetTrigger objects that specify when the dataset is automatically updated.
    versioningConfiguration Property Map
    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 in the AWS IoT Analytics User Guide .

    Supporting Types

    DatasetAction

    ActionName string
    The name of the data set action by which data set contents are automatically created.
    ContainerAction Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetContainerAction
    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.
    QueryAction Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetQueryAction
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    ActionName string
    The name of the data set action by which data set contents are automatically created.
    ContainerAction DatasetContainerAction
    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.
    QueryAction DatasetQueryAction
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    actionName String
    The name of the data set action by which data set contents are automatically created.
    containerAction DatasetContainerAction
    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.
    queryAction DatasetQueryAction
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    actionName string
    The name of the data set action by which data set contents are automatically created.
    containerAction DatasetContainerAction
    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.
    queryAction DatasetQueryAction
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    action_name str
    The name of the data set action by which data set contents are automatically created.
    container_action DatasetContainerAction
    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.
    query_action DatasetQueryAction
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    actionName String
    The name of the data set action by which data set contents are automatically created.
    containerAction Property Map
    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.
    queryAction Property Map
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.

    DatasetContainerAction

    ExecutionRoleArn string
    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.
    Image 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.
    ResourceConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetResourceConfiguration
    Configuration of the resource which executes the "containerAction".
    Variables List<Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetVariable>
    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".
    ExecutionRoleArn string
    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.
    Image 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.
    ResourceConfiguration DatasetResourceConfiguration
    Configuration of the resource which executes the "containerAction".
    Variables []DatasetVariable
    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".
    executionRoleArn String
    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.
    image 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.
    resourceConfiguration DatasetResourceConfiguration
    Configuration of the resource which executes the "containerAction".
    variables List<DatasetVariable>
    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".
    executionRoleArn string
    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.
    image 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.
    resourceConfiguration DatasetResourceConfiguration
    Configuration of the resource which executes the "containerAction".
    variables DatasetVariable[]
    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".
    execution_role_arn str
    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.
    image str
    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.
    resource_configuration DatasetResourceConfiguration
    Configuration of the resource which executes the "containerAction".
    variables Sequence[DatasetVariable]
    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".
    executionRoleArn String
    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.
    image 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.
    resourceConfiguration Property Map
    Configuration of the resource which executes the "containerAction".
    variables List<Property Map>
    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".

    DatasetContentDeliveryRule

    Destination Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetContentDeliveryRuleDestination
    The destination to which dataset contents are delivered.
    EntryName string
    The name of the dataset content delivery rules entry.
    Destination DatasetContentDeliveryRuleDestination
    The destination to which dataset contents are delivered.
    EntryName string
    The name of the dataset content delivery rules entry.
    destination DatasetContentDeliveryRuleDestination
    The destination to which dataset contents are delivered.
    entryName String
    The name of the dataset content delivery rules entry.
    destination DatasetContentDeliveryRuleDestination
    The destination to which dataset contents are delivered.
    entryName string
    The name of the dataset content delivery rules entry.
    destination DatasetContentDeliveryRuleDestination
    The destination to which dataset contents are delivered.
    entry_name str
    The name of the dataset content delivery rules entry.
    destination Property Map
    The destination to which dataset contents are delivered.
    entryName String
    The name of the dataset content delivery rules entry.

    DatasetContentDeliveryRuleDestination

    IotEventsDestinationConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetIotEventsDestinationConfiguration
    Configuration information for delivery of dataset contents to AWS IoT Events .
    S3DestinationConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetS3DestinationConfiguration
    Configuration information for delivery of dataset contents to Amazon S3.
    IotEventsDestinationConfiguration DatasetIotEventsDestinationConfiguration
    Configuration information for delivery of dataset contents to AWS IoT Events .
    S3DestinationConfiguration DatasetS3DestinationConfiguration
    Configuration information for delivery of dataset contents to Amazon S3.
    iotEventsDestinationConfiguration DatasetIotEventsDestinationConfiguration
    Configuration information for delivery of dataset contents to AWS IoT Events .
    s3DestinationConfiguration DatasetS3DestinationConfiguration
    Configuration information for delivery of dataset contents to Amazon S3.
    iotEventsDestinationConfiguration DatasetIotEventsDestinationConfiguration
    Configuration information for delivery of dataset contents to AWS IoT Events .
    s3DestinationConfiguration DatasetS3DestinationConfiguration
    Configuration information for delivery of dataset contents to Amazon S3.
    iot_events_destination_configuration DatasetIotEventsDestinationConfiguration
    Configuration information for delivery of dataset contents to AWS IoT Events .
    s3_destination_configuration DatasetS3DestinationConfiguration
    Configuration information for delivery of dataset contents to Amazon S3.
    iotEventsDestinationConfiguration Property Map
    Configuration information for delivery of dataset contents to AWS IoT Events .
    s3DestinationConfiguration Property Map
    Configuration information for delivery of dataset contents to Amazon S3.

    DatasetContentVersionValue

    DatasetName string
    The name of the dataset whose latest contents are used as input to the notebook or application.
    DatasetName string
    The name of the dataset whose latest contents are used as input to the notebook or application.
    datasetName String
    The name of the dataset whose latest contents are used as input to the notebook or application.
    datasetName string
    The name of the dataset whose latest contents are used as input to the notebook or application.
    dataset_name str
    The name of the dataset whose latest contents are used as input to the notebook or application.
    datasetName String
    The name of the dataset whose latest contents are used as input to the notebook or application.

    DatasetDeltaTime

    OffsetSeconds int
    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.
    TimeExpression string
    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.
    OffsetSeconds int
    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.
    TimeExpression string
    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.
    offsetSeconds Integer
    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.
    timeExpression String
    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.
    offsetSeconds number
    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.
    timeExpression string
    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.
    offset_seconds int
    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.
    time_expression str
    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.
    offsetSeconds Number
    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.
    timeExpression String
    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.

    DatasetDeltaTimeSessionWindowConfiguration

    TimeoutInMinutes int

    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 , in the Presto 0.172 Documentation .

    TimeoutInMinutes int

    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 , in the Presto 0.172 Documentation .

    timeoutInMinutes Integer

    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 , in the Presto 0.172 Documentation .

    timeoutInMinutes number

    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 , in the Presto 0.172 Documentation .

    timeout_in_minutes int

    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 , in the Presto 0.172 Documentation .

    timeoutInMinutes Number

    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 , in the Presto 0.172 Documentation .

    DatasetFilter

    DeltaTime Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetDeltaTime
    Used to limit data to that which has arrived since the last execution of the action.
    DeltaTime DatasetDeltaTime
    Used to limit data to that which has arrived since the last execution of the action.
    deltaTime DatasetDeltaTime
    Used to limit data to that which has arrived since the last execution of the action.
    deltaTime DatasetDeltaTime
    Used to limit data to that which has arrived since the last execution of the action.
    delta_time DatasetDeltaTime
    Used to limit data to that which has arrived since the last execution of the action.
    deltaTime Property Map
    Used to limit data to that which has arrived since the last execution of the action.

    DatasetGlueConfiguration

    DatabaseName string
    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.
    TableName 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.
    DatabaseName string
    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.
    TableName 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.
    databaseName String
    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.
    tableName 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.
    databaseName string
    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.
    tableName 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.
    database_name str
    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.
    table_name str
    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.
    databaseName String
    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.
    tableName 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.

    DatasetIotEventsDestinationConfiguration

    InputName string
    The name of the AWS IoT Events input to which dataset contents are delivered.
    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
    InputName string
    The name of the AWS IoT Events input to which dataset contents are delivered.
    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
    inputName String
    The name of the AWS IoT Events input to which dataset contents are delivered.
    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
    inputName string
    The name of the AWS IoT Events input to which dataset contents are delivered.
    roleArn string
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
    input_name str
    The name of the AWS IoT Events input to which dataset contents are delivered.
    role_arn str
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.
    inputName String
    The name of the AWS IoT Events input to which dataset contents are delivered.
    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents to an AWS IoT Events input.

    DatasetLateDataRule

    RuleConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetLateDataRuleConfiguration
    The information needed to configure the late data rule.
    RuleName string
    The name of the late data rule.
    RuleConfiguration DatasetLateDataRuleConfiguration
    The information needed to configure the late data rule.
    RuleName string
    The name of the late data rule.
    ruleConfiguration DatasetLateDataRuleConfiguration
    The information needed to configure the late data rule.
    ruleName String
    The name of the late data rule.
    ruleConfiguration DatasetLateDataRuleConfiguration
    The information needed to configure the late data rule.
    ruleName string
    The name of the late data rule.
    rule_configuration DatasetLateDataRuleConfiguration
    The information needed to configure the late data rule.
    rule_name str
    The name of the late data rule.
    ruleConfiguration Property Map
    The information needed to configure the late data rule.
    ruleName String
    The name of the late data rule.

    DatasetLateDataRuleConfiguration

    DeltaTimeSessionWindowConfiguration DatasetDeltaTimeSessionWindowConfiguration
    The information needed to configure a delta time session window.
    deltaTimeSessionWindowConfiguration DatasetDeltaTimeSessionWindowConfiguration
    The information needed to configure a delta time session window.
    deltaTimeSessionWindowConfiguration DatasetDeltaTimeSessionWindowConfiguration
    The information needed to configure a delta time session window.
    delta_time_session_window_configuration DatasetDeltaTimeSessionWindowConfiguration
    The information needed to configure a delta time session window.
    deltaTimeSessionWindowConfiguration Property Map
    The information needed to configure a delta time session window.

    DatasetOutputFileUriValue

    FileName string
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
    FileName string
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
    fileName String
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
    fileName string
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
    file_name str
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.
    fileName String
    The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.

    DatasetQueryAction

    SqlQuery string
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    Filters List<Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetFilter>
    Pre-filters applied to message data.
    SqlQuery string
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    Filters []DatasetFilter
    Pre-filters applied to message data.
    sqlQuery String
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    filters List<DatasetFilter>
    Pre-filters applied to message data.
    sqlQuery string
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    filters DatasetFilter[]
    Pre-filters applied to message data.
    sql_query str
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    filters Sequence[DatasetFilter]
    Pre-filters applied to message data.
    sqlQuery String
    An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
    filters List<Property Map>
    Pre-filters applied to message data.

    DatasetResourceConfiguration

    ComputeType Pulumi.AwsNative.IoTAnalytics.DatasetResourceConfigurationComputeType
    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).
    VolumeSizeInGb int
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
    ComputeType DatasetResourceConfigurationComputeType
    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).
    VolumeSizeInGb int
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
    computeType DatasetResourceConfigurationComputeType
    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).
    volumeSizeInGb Integer
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
    computeType DatasetResourceConfigurationComputeType
    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).
    volumeSizeInGb number
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
    compute_type DatasetResourceConfigurationComputeType
    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).
    volume_size_in_gb int
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).
    computeType "ACU_1" | "ACU_2"
    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).
    volumeSizeInGb Number
    The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).

    DatasetResourceConfigurationComputeType

    DatasetRetentionPeriod

    NumberOfDays int
    The number of days that message data is kept. The unlimited parameter must be false.
    Unlimited bool
    If true, message data is kept indefinitely.
    NumberOfDays int
    The number of days that message data is kept. The unlimited parameter must be false.
    Unlimited bool
    If true, message data is kept indefinitely.
    numberOfDays Integer
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited Boolean
    If true, message data is kept indefinitely.
    numberOfDays number
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited boolean
    If true, message data is kept indefinitely.
    number_of_days int
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited bool
    If true, message data is kept indefinitely.
    numberOfDays Number
    The number of days that message data is kept. The unlimited parameter must be false.
    unlimited Boolean
    If true, message data is kept indefinitely.

    DatasetS3DestinationConfiguration

    Bucket string
    The name of the S3 bucket to which dataset contents are delivered.
    Key string

    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.

    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    GlueConfiguration Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetGlueConfiguration
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
    Bucket string
    The name of the S3 bucket to which dataset contents are delivered.
    Key string

    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.

    RoleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    GlueConfiguration DatasetGlueConfiguration
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
    bucket String
    The name of the S3 bucket to which dataset contents are delivered.
    key String

    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.

    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    glueConfiguration DatasetGlueConfiguration
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
    bucket string
    The name of the S3 bucket to which dataset contents are delivered.
    key string

    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.

    roleArn string
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    glueConfiguration DatasetGlueConfiguration
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
    bucket str
    The name of the S3 bucket to which dataset contents are delivered.
    key str

    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.

    role_arn str
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    glue_configuration DatasetGlueConfiguration
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.
    bucket String
    The name of the S3 bucket to which dataset contents are delivered.
    key String

    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.

    roleArn String
    The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.
    glueConfiguration Property Map
    Configuration information for coordination with AWS Glue , a fully managed extract, transform and load (ETL) service.

    DatasetSchedule

    ScheduleExpression string
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
    ScheduleExpression string
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
    scheduleExpression String
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
    scheduleExpression string
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
    schedule_expression str
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.
    scheduleExpression String
    The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch documentation.

    DatasetTrigger

    Schedule Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetSchedule
    The "Schedule" when the trigger is initiated.
    TriggeringDataset Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetTriggeringDataset
    Information about the data set whose content generation triggers the new data set content generation.
    Schedule DatasetSchedule
    The "Schedule" when the trigger is initiated.
    TriggeringDataset DatasetTriggeringDataset
    Information about the data set whose content generation triggers the new data set content generation.
    schedule DatasetSchedule
    The "Schedule" when the trigger is initiated.
    triggeringDataset DatasetTriggeringDataset
    Information about the data set whose content generation triggers the new data set content generation.
    schedule DatasetSchedule
    The "Schedule" when the trigger is initiated.
    triggeringDataset DatasetTriggeringDataset
    Information about the data set whose content generation triggers the new data set content generation.
    schedule DatasetSchedule
    The "Schedule" when the trigger is initiated.
    triggering_dataset DatasetTriggeringDataset
    Information about the data set whose content generation triggers the new data set content generation.
    schedule Property Map
    The "Schedule" when the trigger is initiated.
    triggeringDataset Property Map
    Information about the data set whose content generation triggers the new data set content generation.

    DatasetTriggeringDataset

    DatasetName string
    The name of the data set whose content generation triggers the new data set content generation.
    DatasetName string
    The name of the data set whose content generation triggers the new data set content generation.
    datasetName String
    The name of the data set whose content generation triggers the new data set content generation.
    datasetName string
    The name of the data set whose content generation triggers the new data set content generation.
    dataset_name str
    The name of the data set whose content generation triggers the new data set content generation.
    datasetName String
    The name of the data set whose content generation triggers the new data set content generation.

    DatasetVariable

    VariableName string
    The name of the variable.
    DatasetContentVersionValue Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetContentVersionValue
    The value of the variable as a structure that specifies a dataset content version.
    DoubleValue double
    The value of the variable as a double (numeric).
    OutputFileUriValue Pulumi.AwsNative.IoTAnalytics.Inputs.DatasetOutputFileUriValue
    The value of the variable as a structure that specifies an output file URI.
    StringValue string
    The value of the variable as a string.
    VariableName string
    The name of the variable.
    DatasetContentVersionValue DatasetContentVersionValue
    The value of the variable as a structure that specifies a dataset content version.
    DoubleValue float64
    The value of the variable as a double (numeric).
    OutputFileUriValue DatasetOutputFileUriValue
    The value of the variable as a structure that specifies an output file URI.
    StringValue string
    The value of the variable as a string.
    variableName String
    The name of the variable.
    datasetContentVersionValue DatasetContentVersionValue
    The value of the variable as a structure that specifies a dataset content version.
    doubleValue Double
    The value of the variable as a double (numeric).
    outputFileUriValue DatasetOutputFileUriValue
    The value of the variable as a structure that specifies an output file URI.
    stringValue String
    The value of the variable as a string.
    variableName string
    The name of the variable.
    datasetContentVersionValue DatasetContentVersionValue
    The value of the variable as a structure that specifies a dataset content version.
    doubleValue number
    The value of the variable as a double (numeric).
    outputFileUriValue DatasetOutputFileUriValue
    The value of the variable as a structure that specifies an output file URI.
    stringValue string
    The value of the variable as a string.
    variable_name str
    The name of the variable.
    dataset_content_version_value DatasetContentVersionValue
    The value of the variable as a structure that specifies a dataset content version.
    double_value float
    The value of the variable as a double (numeric).
    output_file_uri_value DatasetOutputFileUriValue
    The value of the variable as a structure that specifies an output file URI.
    string_value str
    The value of the variable as a string.
    variableName String
    The name of the variable.
    datasetContentVersionValue Property Map
    The value of the variable as a structure that specifies a dataset content version.
    doubleValue Number
    The value of the variable as a double (numeric).
    outputFileUriValue Property Map
    The value of the variable as a structure that specifies an output file URI.
    stringValue String
    The value of the variable as a string.

    DatasetVersioningConfiguration

    MaxVersions int
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    Unlimited bool
    If true, unlimited versions of dataset contents are kept.
    MaxVersions int
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    Unlimited bool
    If true, unlimited versions of dataset contents are kept.
    maxVersions Integer
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    unlimited Boolean
    If true, unlimited versions of dataset contents are kept.
    maxVersions number
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    unlimited boolean
    If true, unlimited versions of dataset contents are kept.
    max_versions int
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    unlimited bool
    If true, unlimited versions of dataset contents are kept.
    maxVersions Number
    How many versions of dataset contents are kept. The unlimited parameter must be false .
    unlimited Boolean
    If true, unlimited versions of dataset contents are kept.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native