Class ScheduledQueryState
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.timestreamquery.inputs.ScheduledQueryState
-
public final class ScheduledQueryState extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classScheduledQueryState.Builder
-
Field Summary
Fields Modifier and Type Field Description static ScheduledQueryStateEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.String>>arn()static ScheduledQueryState.Builderbuilder()static ScheduledQueryState.Builderbuilder(ScheduledQueryState defaults)java.util.Optional<com.pulumi.core.Output<java.lang.String>>creationTime()java.util.Optional<com.pulumi.core.Output<ScheduledQueryErrorReportConfigurationArgs>>errorReportConfiguration()java.util.Optional<com.pulumi.core.Output<java.lang.String>>executionRoleArn()java.util.Optional<com.pulumi.core.Output<java.lang.String>>kmsKeyId()java.util.Optional<com.pulumi.core.Output<java.util.List<ScheduledQueryLastRunSummaryArgs>>>lastRunSummaries()java.util.Optional<com.pulumi.core.Output<java.lang.String>>name()java.util.Optional<com.pulumi.core.Output<java.lang.String>>nextInvocationTime()java.util.Optional<com.pulumi.core.Output<ScheduledQueryNotificationConfigurationArgs>>notificationConfiguration()java.util.Optional<com.pulumi.core.Output<java.lang.String>>previousInvocationTime()java.util.Optional<com.pulumi.core.Output<java.lang.String>>queryString()java.util.Optional<com.pulumi.core.Output<java.util.List<ScheduledQueryRecentlyFailedRunArgs>>>recentlyFailedRuns()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<ScheduledQueryScheduleConfigurationArgs>>scheduleConfiguration()java.util.Optional<com.pulumi.core.Output<java.lang.String>>state()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tags()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tagsAll()java.util.Optional<com.pulumi.core.Output<ScheduledQueryTargetConfigurationArgs>>targetConfiguration()java.util.Optional<com.pulumi.core.Output<ScheduledQueryTimeoutsArgs>>timeouts()
-
-
-
Field Detail
-
Empty
public static final ScheduledQueryState Empty
-
-
Method Detail
-
arn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
- Returns:
- ARN of the Scheduled Query.
-
creationTime
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> creationTime()
- Returns:
- Creation time for the scheduled query.
-
errorReportConfiguration
public java.util.Optional<com.pulumi.core.Output<ScheduledQueryErrorReportConfigurationArgs>> errorReportConfiguration()
- Returns:
- Configuration block for error reporting configuration. See below.
-
executionRoleArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> executionRoleArn()
- Returns:
- ARN for the IAM role that Timestream will assume when running the scheduled query.
-
kmsKeyId
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<ScheduledQueryLastRunSummaryArgs>>> lastRunSummaries()
- Returns:
- Runtime summary for the last scheduled query run. See `lastRunSummary` Block for details.
-
name
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
- Returns:
- Name of the scheduled query.
-
nextInvocationTime
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> nextInvocationTime()
- Returns:
- Next time the scheduled query is scheduled to run.
-
notificationConfiguration
public java.util.Optional<com.pulumi.core.Output<ScheduledQueryNotificationConfigurationArgs>> notificationConfiguration()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> previousInvocationTime()
- Returns:
- Last time the scheduled query was run.
-
queryString
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> queryString()
- Returns:
- 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` parameter 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<ScheduledQueryRecentlyFailedRunArgs>>> recentlyFailedRuns()
- Returns:
- Runtime summary for the last five failed scheduled query runs. See `recentlyFailedRuns` Block for details.
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
scheduleConfiguration
public java.util.Optional<com.pulumi.core.Output<ScheduledQueryScheduleConfigurationArgs>> scheduleConfiguration()
- Returns:
- Configuration block for schedule configuration for the query. See below.
-
state
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> state()
- Returns:
- State of the scheduled query, either `ENABLED` or `DISABLED`.
-
tags
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
targetConfiguration
public java.util.Optional<com.pulumi.core.Output<ScheduledQueryTargetConfigurationArgs>> targetConfiguration()
- Returns:
- Configuration block for writing the result of a query. See below. The following arguments are optional:
-
timeouts
public java.util.Optional<com.pulumi.core.Output<ScheduledQueryTimeoutsArgs>> timeouts()
-
builder
public static ScheduledQueryState.Builder builder()
-
builder
public static ScheduledQueryState.Builder builder(ScheduledQueryState defaults)
-
-