Package com.pulumi.aws.timestreamquery

Class ScheduledQueryArgs

  • public final class ScheduledQueryArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • executionRoleArn

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

      • notificationConfiguration

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

      • queryString

        public 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 com.pulumi.core.Output<ScheduledQueryScheduleConfigurationArgs> scheduleConfiguration()
        Returns:
        Configuration block for schedule configuration for the query. See below.

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

      • targetConfiguration

        public com.pulumi.core.Output<ScheduledQueryTargetConfigurationArgs> targetConfiguration()
        Returns:
        Configuration block for writing the result of a query. See below. The following arguments are optional: