ScheduledQueryState class

Input properties used for looking up and filtering ScheduledQuery resources.

Constructors

ScheduledQueryState({Input<String?>? arn, Input<String?>? creationTime, Input<ScheduledQueryErrorReportConfiguration?>? errorReportConfiguration, Input<String?>? executionRoleArn, Input<String?>? kmsKeyId, Input<List<ScheduledQueryLastRunSummary>?>? lastRunSummaries, Input<String?>? name, Input<String?>? nextInvocationTime, Input<ScheduledQueryNotificationConfiguration?>? notificationConfiguration, Input<String?>? previousInvocationTime, Input<String?>? queryString, Input<List<ScheduledQueryRecentlyFailedRun>?>? recentlyFailedRuns, Input<String?>? region, Input<ScheduledQueryScheduleConfiguration?>? scheduleConfiguration, Input<String?>? state, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<ScheduledQueryTargetConfiguration?>? targetConfiguration, Input<ScheduledQueryTimeouts?>? timeouts})
Creates a new ScheduledQueryState. arn ARN of the Scheduled Query. creationTime Creation time for the scheduled query. errorReportConfiguration Configuration block for error reporting configuration. See below. executionRoleArn ARN for the IAM role that Timestream will assume when running the scheduled query. kmsKeyId Amazon KMS key used to encrypt the scheduled query resource, at-rest. If 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 the encryption type, the same kmsKeyId is used to encrypt the error report at rest. lastRunSummaries Runtime summary for the last scheduled query run. name Name of the scheduled query. nextInvocationTime Next time the scheduled query is scheduled to run. notificationConfiguration Configuration block for notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated, or when it is deleted. See below. previousInvocationTime Last time the scheduled query was run. queryString Query string to run. Parameter names can be specified in the query string using the @ 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. recentlyFailedRuns Runtime summary for the last five failed scheduled query runs. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. scheduleConfiguration Configuration block for schedule configuration for the query. See below. state State of the scheduled query, either ENABLED or DISABLED. tags Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. targetConfiguration Configuration block for writing the result of a query. See below. timeouts Optional.
const
ScheduledQueryState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the Scheduled Query.
final
creationTime → Input<String?>?
Creation time for the scheduled query.
final
errorReportConfiguration → Input<ScheduledQueryErrorReportConfiguration?>?
Configuration block for error reporting configuration. See below.
final
executionRoleArn → Input<String?>?
ARN for the IAM role that Timestream will assume when running the scheduled query.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
Amazon KMS key used to encrypt the scheduled query resource, at-rest. If 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 the encryption type, the same kmsKeyId is used to encrypt the error report at rest.
final
lastRunSummaries → Input<List<ScheduledQueryLastRunSummary>?>?
Runtime summary for the last scheduled query run.
final
name → Input<String?>?
Name of the scheduled query.
final
nextInvocationTime → Input<String?>?
Next time the scheduled query is scheduled to run.
final
notificationConfiguration → Input<ScheduledQueryNotificationConfiguration?>?
Configuration block for notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated, or when it is deleted. See below.
final
previousInvocationTime → Input<String?>?
Last time the scheduled query was run.
final
queryString → Input<String?>?
Query string to run. Parameter names can be specified in the query string using the @ 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.
final
recentlyFailedRuns → Input<List<ScheduledQueryRecentlyFailedRun>?>?
Runtime summary for the last five failed scheduled query runs.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduleConfiguration → Input<ScheduledQueryScheduleConfiguration?>?
Configuration block for schedule configuration for the query. See below.
final
state → Input<String?>?
State of the scheduled query, either ENABLED or DISABLED.
final
tags → Input<Map<String, String>?>?
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
targetConfiguration → Input<ScheduledQueryTargetConfiguration?>?
Configuration block for writing the result of a query. See below.
final
timeouts → Input<ScheduledQueryTimeouts?>?
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited