Package software.amazon.awscdk.services.timestream

Class CfnScheduledQuery

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.timestream.CfnScheduledQuery
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:10.703Z") @Stability(Stable) public class CfnScheduledQuery extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnScheduledQueryProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getErrorReportConfiguration

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

    • setErrorReportConfiguration

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

    • setErrorReportConfiguration

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

    • getNotificationConfiguration

      @Stability(Stable) @NotNull public Object getNotificationConfiguration()
      Notification configuration for the scheduled query.

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@NotNull IResolvable value)
      Notification configuration for the scheduled query.

    • setNotificationConfiguration

      @Stability(Stable) public void setNotificationConfiguration(@NotNull CfnScheduledQuery.NotificationConfigurationProperty value)
      Notification configuration for the scheduled query.

    • getQueryString

      @Stability(Stable) @NotNull public String getQueryString()
      The query string to run.

    • setQueryString

      @Stability(Stable) public void setQueryString(@NotNull String value)
      The query string to run.

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

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

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The Amazon KMS key used to encrypt the scheduled query resource, at-rest.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The Amazon KMS key used to encrypt the scheduled query resource, at-rest.

    • getScheduledQueryName

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

    • setScheduledQueryName

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs to label the scheduled query.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs to label the scheduled query.

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