1. Packages
  2. AWS Native
  3. API Docs
  4. timestream
  5. ScheduledQuery

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.timestream.ScheduledQuery

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.

    Create ScheduledQuery Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScheduledQuery(name: string, args: ScheduledQueryArgs, opts?: CustomResourceOptions);
    @overload
    def ScheduledQuery(resource_name: str,
                       args: ScheduledQueryArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ScheduledQuery(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       error_report_configuration: Optional[ScheduledQueryErrorReportConfigurationArgs] = None,
                       notification_configuration: Optional[ScheduledQueryNotificationConfigurationArgs] = None,
                       query_string: Optional[str] = None,
                       schedule_configuration: Optional[ScheduledQueryScheduleConfigurationArgs] = None,
                       scheduled_query_execution_role_arn: Optional[str] = None,
                       client_token: Optional[str] = None,
                       kms_key_id: Optional[str] = None,
                       scheduled_query_name: Optional[str] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                       target_configuration: Optional[ScheduledQueryTargetConfigurationArgs] = None)
    func NewScheduledQuery(ctx *Context, name string, args ScheduledQueryArgs, opts ...ResourceOption) (*ScheduledQuery, error)
    public ScheduledQuery(string name, ScheduledQueryArgs args, CustomResourceOptions? opts = null)
    public ScheduledQuery(String name, ScheduledQueryArgs args)
    public ScheduledQuery(String name, ScheduledQueryArgs args, CustomResourceOptions options)
    
    type: aws-native:timestream:ScheduledQuery
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledQueryArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const scheduledQueryResource = new aws_native.timestream.ScheduledQuery("scheduledQueryResource", {
        errorReportConfiguration: {
            s3Configuration: {
                bucketName: "string",
                encryptionOption: aws_native.timestream.ScheduledQueryEncryptionOption.SseS3,
                objectKeyPrefix: "string",
            },
        },
        notificationConfiguration: {
            snsConfiguration: {
                topicArn: "string",
            },
        },
        queryString: "string",
        scheduleConfiguration: {
            scheduleExpression: "string",
        },
        scheduledQueryExecutionRoleArn: "string",
        clientToken: "string",
        kmsKeyId: "string",
        scheduledQueryName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        targetConfiguration: {
            timestreamConfiguration: {
                databaseName: "string",
                dimensionMappings: [{
                    dimensionValueType: aws_native.timestream.ScheduledQueryDimensionValueType.Varchar,
                    name: "string",
                }],
                tableName: "string",
                timeColumn: "string",
                measureNameColumn: "string",
                mixedMeasureMappings: [{
                    measureValueType: aws_native.timestream.ScheduledQueryMixedMeasureMappingMeasureValueType.Bigint,
                    measureName: "string",
                    multiMeasureAttributeMappings: [{
                        measureValueType: aws_native.timestream.ScheduledQueryMultiMeasureAttributeMappingMeasureValueType.Bigint,
                        sourceColumn: "string",
                        targetMultiMeasureAttributeName: "string",
                    }],
                    sourceColumn: "string",
                    targetMeasureName: "string",
                }],
                multiMeasureMappings: {
                    multiMeasureAttributeMappings: [{
                        measureValueType: aws_native.timestream.ScheduledQueryMultiMeasureAttributeMappingMeasureValueType.Bigint,
                        sourceColumn: "string",
                        targetMultiMeasureAttributeName: "string",
                    }],
                    targetMultiMeasureName: "string",
                },
            },
        },
    });
    
    Coming soon!
    

    ScheduledQuery Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScheduledQuery resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledQuery resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    SqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    SqKmsKeyId string
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    SqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    SqNotificationConfiguration string
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    SqQueryString string
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    SqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    SqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    SqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    SqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    SqKmsKeyId string
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    SqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    SqNotificationConfiguration string
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    SqQueryString string
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    SqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    SqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    SqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    sqErrorReportConfiguration String
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId String
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    sqName String
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration String
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    sqQueryString String
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    sqScheduleConfiguration String
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration String
    Configuration of target store where scheduled query results are written to.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    sqErrorReportConfiguration string
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId string
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    sqName string
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration string
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    sqQueryString string
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    sqScheduleConfiguration string
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration string
    Configuration of target store where scheduled query results are written to.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    sq_error_report_configuration str
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sq_kms_key_id str
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    sq_name str
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sq_notification_configuration str
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    sq_query_string str
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    sq_schedule_configuration str
    Configuration for when the scheduled query is executed.
    sq_scheduled_query_execution_role_arn str
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sq_target_configuration str
    Configuration of target store where scheduled query results are written to.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    sqErrorReportConfiguration String
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    sqKmsKeyId String
    The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/. If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.
    sqName String
    The name of the scheduled query. Scheduled query names must be unique within each Region.
    sqNotificationConfiguration String
    Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.
    sqQueryString String
    The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter @scheduled_runtime is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of @scheduled_runtime paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the @scheduled_runtime parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.
    sqScheduleConfiguration String
    Configuration for when the scheduled query is executed.
    sqScheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    sqTargetConfiguration String
    Configuration of target store where scheduled query results are written to.

    Supporting Types

    ScheduledQueryDimensionMapping, ScheduledQueryDimensionMappingArgs

    ScheduledQueryDimensionValueType, ScheduledQueryDimensionValueTypeArgs

    Varchar
    VARCHAR
    ScheduledQueryDimensionValueTypeVarchar
    VARCHAR
    Varchar
    VARCHAR
    Varchar
    VARCHAR
    VARCHAR
    VARCHAR
    "VARCHAR"
    VARCHAR

    ScheduledQueryEncryptionOption, ScheduledQueryEncryptionOptionArgs

    SseS3
    SSE_S3
    SseKms
    SSE_KMS
    ScheduledQueryEncryptionOptionSseS3
    SSE_S3
    ScheduledQueryEncryptionOptionSseKms
    SSE_KMS
    SseS3
    SSE_S3
    SseKms
    SSE_KMS
    SseS3
    SSE_S3
    SseKms
    SSE_KMS
    SSE_S3
    SSE_S3
    SSE_KMS
    SSE_KMS
    "SSE_S3"
    SSE_S3
    "SSE_KMS"
    SSE_KMS

    ScheduledQueryErrorReportConfiguration, ScheduledQueryErrorReportConfigurationArgs

    ScheduledQueryMixedMeasureMapping, ScheduledQueryMixedMeasureMappingArgs

    ScheduledQueryMixedMeasureMappingMeasureValueType, ScheduledQueryMixedMeasureMappingMeasureValueTypeArgs

    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Multi
    MULTI
    ScheduledQueryMixedMeasureMappingMeasureValueTypeBigint
    BIGINT
    ScheduledQueryMixedMeasureMappingMeasureValueTypeBoolean
    BOOLEAN
    ScheduledQueryMixedMeasureMappingMeasureValueTypeDouble
    DOUBLE
    ScheduledQueryMixedMeasureMappingMeasureValueTypeVarchar
    VARCHAR
    ScheduledQueryMixedMeasureMappingMeasureValueTypeMulti
    MULTI
    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Multi
    MULTI
    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Multi
    MULTI
    BIGINT
    BIGINT
    BOOLEAN
    BOOLEAN
    DOUBLE
    DOUBLE
    VARCHAR
    VARCHAR
    MULTI
    MULTI
    "BIGINT"
    BIGINT
    "BOOLEAN"
    BOOLEAN
    "DOUBLE"
    DOUBLE
    "VARCHAR"
    VARCHAR
    "MULTI"
    MULTI

    ScheduledQueryMultiMeasureAttributeMapping, ScheduledQueryMultiMeasureAttributeMappingArgs

    ScheduledQueryMultiMeasureAttributeMappingMeasureValueType, ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeArgs

    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Timestamp
    TIMESTAMP
    ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeBigint
    BIGINT
    ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeBoolean
    BOOLEAN
    ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeDouble
    DOUBLE
    ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeVarchar
    VARCHAR
    ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeTimestamp
    TIMESTAMP
    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Timestamp
    TIMESTAMP
    Bigint
    BIGINT
    Boolean
    BOOLEAN
    Double
    DOUBLE
    Varchar
    VARCHAR
    Timestamp
    TIMESTAMP
    BIGINT
    BIGINT
    BOOLEAN
    BOOLEAN
    DOUBLE
    DOUBLE
    VARCHAR
    VARCHAR
    TIMESTAMP
    TIMESTAMP
    "BIGINT"
    BIGINT
    "BOOLEAN"
    BOOLEAN
    "DOUBLE"
    DOUBLE
    "VARCHAR"
    VARCHAR
    "TIMESTAMP"
    TIMESTAMP

    ScheduledQueryMultiMeasureMappings, ScheduledQueryMultiMeasureMappingsArgs

    ScheduledQueryNotificationConfiguration, ScheduledQueryNotificationConfigurationArgs

    ScheduledQueryS3Configuration, ScheduledQueryS3ConfigurationArgs

    ScheduledQueryScheduleConfiguration, ScheduledQueryScheduleConfigurationArgs

    ScheduledQuerySnsConfiguration, ScheduledQuerySnsConfigurationArgs

    TopicArn string
    TopicArn string
    topicArn String
    topicArn string
    topicArn String

    ScheduledQueryTargetConfiguration, ScheduledQueryTargetConfigurationArgs

    ScheduledQueryTimestreamConfiguration, ScheduledQueryTimestreamConfigurationArgs

    Tag, TagArgs

    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.102.0 published on Tuesday, Apr 16, 2024 by Pulumi