Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. timestream
  5. ScheduledQuery

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.timestream.ScheduledQuery

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScheduledQuery resource accepts the following input properties:

    ErrorReportConfiguration Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryErrorReportConfiguration
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    NotificationConfiguration Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryNotificationConfiguration
    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.
    QueryString 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.

    ScheduleConfiguration Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryScheduleConfiguration
    Schedule configuration.
    ScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    ClientToken string
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    KmsKeyId 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.

    ScheduledQueryName string
    A name for the query. Scheduled query names must be unique within each Region.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs to label the scheduled query.
    TargetConfiguration Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryTargetConfiguration
    Scheduled query target store configuration.
    ErrorReportConfiguration ScheduledQueryErrorReportConfigurationArgs
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    NotificationConfiguration ScheduledQueryNotificationConfigurationArgs
    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.
    QueryString 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.

    ScheduleConfiguration ScheduledQueryScheduleConfigurationArgs
    Schedule configuration.
    ScheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    ClientToken string
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    KmsKeyId 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.

    ScheduledQueryName string
    A name for the query. Scheduled query names must be unique within each Region.
    Tags TagArgs
    A list of key-value pairs to label the scheduled query.
    TargetConfiguration ScheduledQueryTargetConfigurationArgs
    Scheduled query target store configuration.
    errorReportConfiguration ScheduledQueryErrorReportConfiguration
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    notificationConfiguration ScheduledQueryNotificationConfiguration
    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.
    queryString 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.

    scheduleConfiguration ScheduledQueryScheduleConfiguration
    Schedule configuration.
    scheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    clientToken String
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    kmsKeyId 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.

    scheduledQueryName String
    A name for the query. Scheduled query names must be unique within each Region.
    tags List<Tag>
    A list of key-value pairs to label the scheduled query.
    targetConfiguration ScheduledQueryTargetConfiguration
    Scheduled query target store configuration.
    errorReportConfiguration ScheduledQueryErrorReportConfiguration
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    notificationConfiguration ScheduledQueryNotificationConfiguration
    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.
    queryString 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.

    scheduleConfiguration ScheduledQueryScheduleConfiguration
    Schedule configuration.
    scheduledQueryExecutionRoleArn string
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    clientToken string
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    kmsKeyId 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.

    scheduledQueryName string
    A name for the query. Scheduled query names must be unique within each Region.
    tags Tag[]
    A list of key-value pairs to label the scheduled query.
    targetConfiguration ScheduledQueryTargetConfiguration
    Scheduled query target store configuration.
    error_report_configuration ScheduledQueryErrorReportConfigurationArgs
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    notification_configuration ScheduledQueryNotificationConfigurationArgs
    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.
    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.

    schedule_configuration ScheduledQueryScheduleConfigurationArgs
    Schedule configuration.
    scheduled_query_execution_role_arn str
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    client_token str
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    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.

    scheduled_query_name str
    A name for the query. Scheduled query names must be unique within each Region.
    tags Sequence[TagArgs]
    A list of key-value pairs to label the scheduled query.
    target_configuration ScheduledQueryTargetConfigurationArgs
    Scheduled query target store configuration.
    errorReportConfiguration Property Map
    Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
    notificationConfiguration Property Map
    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.
    queryString 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.

    scheduleConfiguration Property Map
    Schedule configuration.
    scheduledQueryExecutionRoleArn String
    The ARN for the IAM role that Timestream will assume when running the scheduled query.
    clientToken String
    Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

    • If CreateScheduledQuery is called without a ClientToken , the Query SDK generates a ClientToken on your behalf.
    • After 8 hours, any request with the same ClientToken is treated as a new request.
    kmsKeyId 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.

    scheduledQueryName String
    A name for the query. Scheduled query names must be unique within each Region.
    tags List<Property Map>
    A list of key-value pairs to label the scheduled query.
    targetConfiguration Property Map
    Scheduled query target store configuration.

    Outputs

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

    Arn string
    The ARN of the scheduled query.
    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
    The ARN of the scheduled query.
    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
    The ARN of the scheduled query.
    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
    The ARN of the scheduled query.
    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
    The ARN of the scheduled query.
    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
    The ARN of the scheduled query.
    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

    S3Configuration ScheduledQueryS3Configuration
    The S3 configuration for the error reports.
    s3Configuration ScheduledQueryS3Configuration
    The S3 configuration for the error reports.
    s3Configuration ScheduledQueryS3Configuration
    The S3 configuration for the error reports.
    s3_configuration ScheduledQueryS3Configuration
    The S3 configuration for the error reports.
    s3Configuration Property Map
    The S3 configuration for the error reports.

    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

    MultiMeasureAttributeMappings List<Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryMultiMeasureAttributeMapping>
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    TargetMultiMeasureName string
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
    MultiMeasureAttributeMappings []ScheduledQueryMultiMeasureAttributeMapping
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    TargetMultiMeasureName string
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
    multiMeasureAttributeMappings List<ScheduledQueryMultiMeasureAttributeMapping>
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    targetMultiMeasureName String
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
    multiMeasureAttributeMappings ScheduledQueryMultiMeasureAttributeMapping[]
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    targetMultiMeasureName string
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
    multi_measure_attribute_mappings Sequence[ScheduledQueryMultiMeasureAttributeMapping]
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    target_multi_measure_name str
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.
    multiMeasureAttributeMappings List<Property Map>
    Required. Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes.
    targetMultiMeasureName String
    The name of the target multi-measure name in the derived table. This input is required when measureNameColumn is not provided. If MeasureNameColumn is provided, then value from that column will be used as multi-measure name.

    ScheduledQueryNotificationConfiguration, ScheduledQueryNotificationConfigurationArgs

    snsConfiguration Property Map
    Details on SNS configuration.

    ScheduledQueryS3Configuration, ScheduledQueryS3ConfigurationArgs

    BucketName string
    Name of the S3 bucket under which error reports will be created.
    EncryptionOption Pulumi.AwsNative.Timestream.ScheduledQueryEncryptionOption
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    ObjectKeyPrefix string
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
    BucketName string
    Name of the S3 bucket under which error reports will be created.
    EncryptionOption ScheduledQueryEncryptionOption
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    ObjectKeyPrefix string
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
    bucketName String
    Name of the S3 bucket under which error reports will be created.
    encryptionOption ScheduledQueryEncryptionOption
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    objectKeyPrefix String
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
    bucketName string
    Name of the S3 bucket under which error reports will be created.
    encryptionOption ScheduledQueryEncryptionOption
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    objectKeyPrefix string
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
    bucket_name str
    Name of the S3 bucket under which error reports will be created.
    encryption_option ScheduledQueryEncryptionOption
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    object_key_prefix str
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.
    bucketName String
    Name of the S3 bucket under which error reports will be created.
    encryptionOption "SSE_S3" | "SSE_KMS"
    Encryption at rest options for the error reports. If no encryption option is specified, Timestream will choose SSE_S3 as default.
    objectKeyPrefix String
    Prefix for the error report key. Timestream by default adds the following prefix to the error report path.

    ScheduledQueryScheduleConfiguration, ScheduledQueryScheduleConfigurationArgs

    ScheduleExpression string
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
    ScheduleExpression string
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
    scheduleExpression String
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
    scheduleExpression string
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
    schedule_expression str
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.
    scheduleExpression String
    An expression that denotes when to trigger the scheduled query run. This can be a cron expression or a rate expression.

    ScheduledQuerySnsConfiguration, ScheduledQuerySnsConfigurationArgs

    TopicArn string
    SNS topic ARN that the scheduled query status notifications will be sent to.
    TopicArn string
    SNS topic ARN that the scheduled query status notifications will be sent to.
    topicArn String
    SNS topic ARN that the scheduled query status notifications will be sent to.
    topicArn string
    SNS topic ARN that the scheduled query status notifications will be sent to.
    topic_arn str
    SNS topic ARN that the scheduled query status notifications will be sent to.
    topicArn String
    SNS topic ARN that the scheduled query status notifications will be sent to.

    ScheduledQueryTargetConfiguration, ScheduledQueryTargetConfigurationArgs

    TimestreamConfiguration Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryTimestreamConfiguration
    Configuration needed to write data into the Timestream database and table.
    TimestreamConfiguration ScheduledQueryTimestreamConfiguration
    Configuration needed to write data into the Timestream database and table.
    timestreamConfiguration ScheduledQueryTimestreamConfiguration
    Configuration needed to write data into the Timestream database and table.
    timestreamConfiguration ScheduledQueryTimestreamConfiguration
    Configuration needed to write data into the Timestream database and table.
    timestream_configuration ScheduledQueryTimestreamConfiguration
    Configuration needed to write data into the Timestream database and table.
    timestreamConfiguration Property Map
    Configuration needed to write data into the Timestream database and table.

    ScheduledQueryTimestreamConfiguration, ScheduledQueryTimestreamConfigurationArgs

    DatabaseName string
    Name of Timestream database to which the query result will be written.
    DimensionMappings List<Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryDimensionMapping>
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    TableName string
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    TimeColumn string
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    MeasureNameColumn string
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    MixedMeasureMappings List<Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryMixedMeasureMapping>
    Specifies how to map measures to multi-measure records.
    MultiMeasureMappings Pulumi.AwsNative.Timestream.Inputs.ScheduledQueryMultiMeasureMappings
    Multi-measure mappings.
    DatabaseName string
    Name of Timestream database to which the query result will be written.
    DimensionMappings []ScheduledQueryDimensionMapping
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    TableName string
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    TimeColumn string
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    MeasureNameColumn string
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    MixedMeasureMappings []ScheduledQueryMixedMeasureMapping
    Specifies how to map measures to multi-measure records.
    MultiMeasureMappings ScheduledQueryMultiMeasureMappings
    Multi-measure mappings.
    databaseName String
    Name of Timestream database to which the query result will be written.
    dimensionMappings List<ScheduledQueryDimensionMapping>
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    tableName String
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    timeColumn String
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    measureNameColumn String
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    mixedMeasureMappings List<ScheduledQueryMixedMeasureMapping>
    Specifies how to map measures to multi-measure records.
    multiMeasureMappings ScheduledQueryMultiMeasureMappings
    Multi-measure mappings.
    databaseName string
    Name of Timestream database to which the query result will be written.
    dimensionMappings ScheduledQueryDimensionMapping[]
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    tableName string
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    timeColumn string
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    measureNameColumn string
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    mixedMeasureMappings ScheduledQueryMixedMeasureMapping[]
    Specifies how to map measures to multi-measure records.
    multiMeasureMappings ScheduledQueryMultiMeasureMappings
    Multi-measure mappings.
    database_name str
    Name of Timestream database to which the query result will be written.
    dimension_mappings Sequence[ScheduledQueryDimensionMapping]
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    table_name str
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    time_column str
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    measure_name_column str
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    mixed_measure_mappings Sequence[ScheduledQueryMixedMeasureMapping]
    Specifies how to map measures to multi-measure records.
    multi_measure_mappings ScheduledQueryMultiMeasureMappings
    Multi-measure mappings.
    databaseName String
    Name of Timestream database to which the query result will be written.
    dimensionMappings List<Property Map>
    This is to allow mapping column(s) from the query result to the dimension in the destination table.
    tableName String
    Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration.
    timeColumn String
    Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP.
    measureNameColumn String
    Name of the measure column. Also see MultiMeasureMappings and MixedMeasureMappings for how measure name properties on those relate to MeasureNameColumn .
    mixedMeasureMappings List<Property Map>
    Specifies how to map measures to multi-measure records.
    multiMeasureMappings Property Map
    Multi-measure mappings.

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native