Package software.amazon.awscdk.services.timestream

Class CfnScheduledQuery

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.timestream.CfnScheduledQuery
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.876Z") @Stability(Stable) public class CfnScheduledQuery extends CfnResource implements IInspectable
A CloudFormation AWS::Timestream::ScheduledQuery.

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.timestream.*;
 CfnScheduledQuery cfnScheduledQuery = CfnScheduledQuery.Builder.create(this, "MyCfnScheduledQuery")
         .errorReportConfiguration(ErrorReportConfigurationProperty.builder()
                 .s3Configuration(S3ConfigurationProperty.builder()
                         .bucketName("bucketName")
                         // the properties below are optional
                         .encryptionOption("encryptionOption")
                         .objectKeyPrefix("objectKeyPrefix")
                         .build())
                 .build())
         .notificationConfiguration(NotificationConfigurationProperty.builder()
                 .snsConfiguration(SnsConfigurationProperty.builder()
                         .topicArn("topicArn")
                         .build())
                 .build())
         .queryString("queryString")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .scheduleExpression("scheduleExpression")
                 .build())
         .scheduledQueryExecutionRoleArn("scheduledQueryExecutionRoleArn")
         // the properties below are optional
         .clientToken("clientToken")
         .kmsKeyId("kmsKeyId")
         .scheduledQueryName("scheduledQueryName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .timestreamConfiguration(TimestreamConfigurationProperty.builder()
                         .databaseName("databaseName")
                         .dimensionMappings(List.of(DimensionMappingProperty.builder()
                                 .dimensionValueType("dimensionValueType")
                                 .name("name")
                                 .build()))
                         .tableName("tableName")
                         .timeColumn("timeColumn")
                         // the properties below are optional
                         .measureNameColumn("measureNameColumn")
                         .mixedMeasureMappings(List.of(MixedMeasureMappingProperty.builder()
                                 .measureValueType("measureValueType")
                                 // the properties below are optional
                                 .measureName("measureName")
                                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                                         .measureValueType("measureValueType")
                                         .sourceColumn("sourceColumn")
                                         // the properties below are optional
                                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                                         .build()))
                                 .sourceColumn("sourceColumn")
                                 .targetMeasureName("targetMeasureName")
                                 .build()))
                         .multiMeasureMappings(MultiMeasureMappingsProperty.builder()
                                 .multiMeasureAttributeMappings(List.of(MultiMeasureAttributeMappingProperty.builder()
                                         .measureValueType("measureValueType")
                                         .sourceColumn("sourceColumn")
                                         // the properties below are optional
                                         .targetMultiMeasureAttributeName("targetMultiMeasureAttributeName")
                                         .build()))
                                 // the properties below are optional
                                 .targetMultiMeasureName("targetMultiMeasureName")
                                 .build())
                         .build())
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnScheduledQuery

      protected CfnScheduledQuery(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnScheduledQuery

      protected CfnScheduledQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnScheduledQuery

      @Stability(Stable) public CfnScheduledQuery(@NotNull Construct scope, @NotNull String id, @NotNull CfnScheduledQueryProps props)
      Create a new AWS::Timestream::ScheduledQuery.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the scheduled query.

    • getAttrSqErrorReportConfiguration

      @Stability(Stable) @NotNull public String getAttrSqErrorReportConfiguration()
      The scheduled query error reporting configuration.

    • getAttrSqKmsKeyId

      @Stability(Stable) @NotNull public String getAttrSqKmsKeyId()
      The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.

    • getAttrSqName

      @Stability(Stable) @NotNull public String getAttrSqName()
      The scheduled query name.

    • getAttrSqNotificationConfiguration

      @Stability(Stable) @NotNull public String getAttrSqNotificationConfiguration()
      The scheduled query notification configuration.

    • getAttrSqQueryString

      @Stability(Stable) @NotNull public String getAttrSqQueryString()
      The scheduled query string..

    • getAttrSqScheduleConfiguration

      @Stability(Stable) @NotNull public String getAttrSqScheduleConfiguration()
      The scheduled query schedule configuration.

    • getAttrSqScheduledQueryExecutionRoleArn

      @Stability(Stable) @NotNull public String getAttrSqScheduledQueryExecutionRoleArn()
      The ARN of the IAM role that will be used by Timestream to run the query.

    • getAttrSqTargetConfiguration

      @Stability(Stable) @NotNull public String getAttrSqTargetConfiguration()
      The configuration for query output.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of key-value pairs to label the scheduled query.

    • getErrorReportConfiguration

      @Stability(Stable) @NotNull public Object getErrorReportConfiguration()
      Configuration for error reporting.

      Error reports will be generated when a problem is encountered when writing the query results.

    • setErrorReportConfiguration

      @Stability(Stable) public void setErrorReportConfiguration(@NotNull CfnScheduledQuery.ErrorReportConfigurationProperty value)
      Configuration for error reporting.

      Error reports will be generated when a problem is encountered when writing the query results.

    • setErrorReportConfiguration

      @Stability(Stable) public void setErrorReportConfiguration(@NotNull IResolvable value)
      Configuration for error reporting.

      Error reports will be generated when a problem is encountered when writing the query results.

    • getNotificationConfiguration

      @Stability(Stable) @NotNull public Object getNotificationConfiguration()
      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.

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@NotNull IResolvable value)
      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.

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@NotNull CfnScheduledQuery.NotificationConfigurationProperty value)
      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.

    • getQueryString

      @Stability(Stable) @NotNull public String getQueryString()
      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.

    • setQueryString

      @Stability(Stable) public void setQueryString(@NotNull String value)
      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.

    • getScheduleConfiguration

      @Stability(Stable) @NotNull public Object getScheduleConfiguration()
      Schedule configuration.

    • setScheduleConfiguration

      @Stability(Stable) public void setScheduleConfiguration(@NotNull IResolvable value)
      Schedule configuration.

    • setScheduleConfiguration

      @Stability(Stable) public void setScheduleConfiguration(@NotNull CfnScheduledQuery.ScheduleConfigurationProperty value)
      Schedule configuration.

    • getScheduledQueryExecutionRoleArn

      @Stability(Stable) @NotNull public String getScheduledQueryExecutionRoleArn()
      The ARN for the IAM role that Timestream will assume when running the scheduled query.

    • setScheduledQueryExecutionRoleArn

      @Stability(Stable) public void setScheduledQueryExecutionRoleArn(@NotNull String value)
      The ARN for the IAM role that Timestream will assume when running the scheduled query.

    • getClientToken

      @Stability(Stable) @Nullable public String getClientToken()
      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.

    • setClientToken

      @Stability(Stable) public void setClientToken(@Nullable String value)
      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.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      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.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      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.

    • getScheduledQueryName

      @Stability(Stable) @Nullable public String getScheduledQueryName()
      A name for the query.

      Scheduled query names must be unique within each Region.

    • setScheduledQueryName

      @Stability(Stable) public void setScheduledQueryName(@Nullable String value)
      A name for the query.

      Scheduled query names must be unique within each Region.

    • getTargetConfiguration

      @Stability(Stable) @Nullable public Object getTargetConfiguration()
      Scheduled query target store configuration.

    • setTargetConfiguration

      @Stability(Stable) public void setTargetConfiguration(@Nullable IResolvable value)
      Scheduled query target store configuration.

    • setTargetConfiguration

      @Stability(Stable) public void setTargetConfiguration(@Nullable CfnScheduledQuery.TargetConfigurationProperty value)
      Scheduled query target store configuration.