AWS Native

Pulumi Official
Package maintained by Pulumi
v0.18.0 published on Friday, May 27, 2022 by Pulumi

getScheduledQuery

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

Using getScheduledQuery

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 getScheduledQuery(args: GetScheduledQueryArgs, opts?: InvokeOptions): Promise<GetScheduledQueryResult>
function getScheduledQueryOutput(args: GetScheduledQueryOutputArgs, opts?: InvokeOptions): Output<GetScheduledQueryResult>
def get_scheduled_query(arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetScheduledQueryResult
def get_scheduled_query_output(arn: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetScheduledQueryResult]
func LookupScheduledQuery(ctx *Context, args *LookupScheduledQueryArgs, opts ...InvokeOption) (*LookupScheduledQueryResult, error)
func LookupScheduledQueryOutput(ctx *Context, args *LookupScheduledQueryOutputArgs, opts ...InvokeOption) LookupScheduledQueryResultOutput

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

public static class GetScheduledQuery 
{
    public static Task<GetScheduledQueryResult> InvokeAsync(GetScheduledQueryArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledQueryResult> Invoke(GetScheduledQueryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScheduledQueryResult> getScheduledQuery(GetScheduledQueryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:timestream:getScheduledQuery
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Arn string
Arn string
arn String
arn string
arn str
arn String

getScheduledQuery Result

The following output properties are available:

Arn string
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.

Tags List<Pulumi.AwsNative.Timestream.Outputs.ScheduledQueryTag>
Arn string
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.

Tags []ScheduledQueryTag
arn String
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.

tags List<ScheduledQueryTag>
arn string
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.

tags ScheduledQueryTag[]
arn str
s_q_error_report_configuration str

Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

s_q_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.

s_q_name str

The name of the scheduled query. Scheduled query names must be unique within each Region.

s_q_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.

s_q_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.

s_q_schedule_configuration str

Configuration for when the scheduled query is executed.

s_q_scheduled_query_execution_role_arn str

The ARN for the IAM role that Timestream will assume when running the scheduled query.

s_q_target_configuration str

Configuration of target store where scheduled query results are written to.

tags Sequence[ScheduledQueryTag]
arn String
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.

tags List<Property Map>

Supporting Types

ScheduledQueryTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0