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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.553Z")
 @Stability(value=Stable)
public class CfnScheduledQuery
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Timestream::ScheduledQuery`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScheduledQuery.Builder A fluent builder for CfnScheduledQuery.
static interface	CfnScheduledQuery.DimensionMappingProperty Example:
static interface	CfnScheduledQuery.ErrorReportConfigurationProperty Example:
static interface	CfnScheduledQuery.MixedMeasureMappingProperty Example:
static interface	CfnScheduledQuery.MultiMeasureAttributeMappingProperty Example:
static interface	CfnScheduledQuery.MultiMeasureMappingsProperty Example:
static interface	CfnScheduledQuery.NotificationConfigurationProperty Example:
static interface	CfnScheduledQuery.S3ConfigurationProperty Example:
static interface	CfnScheduledQuery.ScheduleConfigurationProperty Example:
static interface	CfnScheduledQuery.SnsConfigurationProperty Example:
static interface	CfnScheduledQuery.TargetConfigurationProperty Example:
static interface	CfnScheduledQuery.TimestreamConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScheduledQuery(software.constructs.Construct scope, String id, CfnScheduledQueryProps props) Create a new `AWS::Timestream::ScheduledQuery`.
protected	CfnScheduledQuery(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScheduledQuery(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrSqErrorReportConfiguration()
String	getAttrSqKmsKeyId()
String	getAttrSqName()
String	getAttrSqNotificationConfiguration()
String	getAttrSqQueryString()
String	getAttrSqScheduleConfiguration()
String	getAttrSqScheduledQueryExecutionRoleArn()
String	getAttrSqTargetConfiguration()
protected Map<String,Object>	getCfnProperties()
String	getClientToken() `AWS::Timestream::ScheduledQuery.ClientToken`.
Object	getErrorReportConfiguration() `AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.
String	getKmsKeyId() `AWS::Timestream::ScheduledQuery.KmsKeyId`.
Object	getNotificationConfiguration() `AWS::Timestream::ScheduledQuery.NotificationConfiguration`.
String	getQueryString() `AWS::Timestream::ScheduledQuery.QueryString`.
Object	getScheduleConfiguration() `AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.
String	getScheduledQueryExecutionRoleArn() `AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.
String	getScheduledQueryName() `AWS::Timestream::ScheduledQuery.ScheduledQueryName`.
TagManager	getTags() `AWS::Timestream::ScheduledQuery.Tags`.
Object	getTargetConfiguration() `AWS::Timestream::ScheduledQuery.TargetConfiguration`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClientToken(String value) `AWS::Timestream::ScheduledQuery.ClientToken`.
void	setErrorReportConfiguration(CfnScheduledQuery.ErrorReportConfigurationProperty value) `AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.
void	setErrorReportConfiguration(IResolvable value) `AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.
void	setKmsKeyId(String value) `AWS::Timestream::ScheduledQuery.KmsKeyId`.
void	setNotificationConfiguration(CfnScheduledQuery.NotificationConfigurationProperty value) `AWS::Timestream::ScheduledQuery.NotificationConfiguration`.
void	setNotificationConfiguration(IResolvable value) `AWS::Timestream::ScheduledQuery.NotificationConfiguration`.
void	setQueryString(String value) `AWS::Timestream::ScheduledQuery.QueryString`.
void	setScheduleConfiguration(CfnScheduledQuery.ScheduleConfigurationProperty value) `AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.
void	setScheduleConfiguration(IResolvable value) `AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.
void	setScheduledQueryExecutionRoleArn(String value) `AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.
void	setScheduledQueryName(String value) `AWS::Timestream::ScheduledQuery.ScheduledQueryName`.
void	setTargetConfiguration(CfnScheduledQuery.TargetConfigurationProperty value) `AWS::Timestream::ScheduledQuery.TargetConfiguration`.
void	setTargetConfiguration(IResolvable value) `AWS::Timestream::ScheduledQuery.TargetConfiguration`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScheduledQuery

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

CfnScheduledQuery

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

CfnScheduledQuery

@Stability(value=Stable)
public CfnScheduledQuery(@NotNull
                                                  software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

getAttrSqErrorReportConfiguration

@Stability(value=Stable)
 @NotNull
public String getAttrSqErrorReportConfiguration()

getAttrSqKmsKeyId

@Stability(value=Stable)
 @NotNull
public String getAttrSqKmsKeyId()

getAttrSqName

@Stability(value=Stable)
 @NotNull
public String getAttrSqName()

getAttrSqNotificationConfiguration

@Stability(value=Stable)
 @NotNull
public String getAttrSqNotificationConfiguration()

getAttrSqQueryString

@Stability(value=Stable)
 @NotNull
public String getAttrSqQueryString()

getAttrSqScheduleConfiguration

@Stability(value=Stable)
 @NotNull
public String getAttrSqScheduleConfiguration()

getAttrSqScheduledQueryExecutionRoleArn

@Stability(value=Stable)
 @NotNull
public String getAttrSqScheduledQueryExecutionRoleArn()

getAttrSqTargetConfiguration

@Stability(value=Stable)
 @NotNull
public String getAttrSqTargetConfiguration()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClientToken

@Stability(value=Stable)
 @Nullable
public String getClientToken()

`AWS::Timestream::ScheduledQuery.ClientToken`.

setClientToken

@Stability(value=Stable)
public void setClientToken(@Nullable
                                                    String value)

`AWS::Timestream::ScheduledQuery.ClientToken`.

getErrorReportConfiguration

@Stability(value=Stable)
 @NotNull
public Object getErrorReportConfiguration()

`AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.

setErrorReportConfiguration

@Stability(value=Stable)
public void setErrorReportConfiguration(@NotNull
                                                                 CfnScheduledQuery.ErrorReportConfigurationProperty value)

`AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.

setErrorReportConfiguration

@Stability(value=Stable)
public void setErrorReportConfiguration(@NotNull
                                                                 IResolvable value)

`AWS::Timestream::ScheduledQuery.ErrorReportConfiguration`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

`AWS::Timestream::ScheduledQuery.KmsKeyId`.

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

`AWS::Timestream::ScheduledQuery.KmsKeyId`.

getNotificationConfiguration

@Stability(value=Stable)
 @NotNull
public Object getNotificationConfiguration()

`AWS::Timestream::ScheduledQuery.NotificationConfiguration`.

setNotificationConfiguration

@Stability(value=Stable)
public void setNotificationConfiguration(@NotNull
                                                                  CfnScheduledQuery.NotificationConfigurationProperty value)

`AWS::Timestream::ScheduledQuery.NotificationConfiguration`.

setNotificationConfiguration

@Stability(value=Stable)
public void setNotificationConfiguration(@NotNull
                                                                  IResolvable value)

`AWS::Timestream::ScheduledQuery.NotificationConfiguration`.

getQueryString

@Stability(value=Stable)
 @NotNull
public String getQueryString()

`AWS::Timestream::ScheduledQuery.QueryString`.

setQueryString

@Stability(value=Stable)
public void setQueryString(@NotNull
                                                    String value)

`AWS::Timestream::ScheduledQuery.QueryString`.

getScheduleConfiguration

@Stability(value=Stable)
 @NotNull
public Object getScheduleConfiguration()

`AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.

setScheduleConfiguration

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

`AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.

setScheduleConfiguration

@Stability(value=Stable)
public void setScheduleConfiguration(@NotNull
                                                              IResolvable value)

`AWS::Timestream::ScheduledQuery.ScheduleConfiguration`.

getScheduledQueryExecutionRoleArn

@Stability(value=Stable)
 @NotNull
public String getScheduledQueryExecutionRoleArn()

`AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.

setScheduledQueryExecutionRoleArn

@Stability(value=Stable)
public void setScheduledQueryExecutionRoleArn(@NotNull
                                                                       String value)

`AWS::Timestream::ScheduledQuery.ScheduledQueryExecutionRoleArn`.

getScheduledQueryName

@Stability(value=Stable)
 @Nullable
public String getScheduledQueryName()

`AWS::Timestream::ScheduledQuery.ScheduledQueryName`.

setScheduledQueryName

@Stability(value=Stable)
public void setScheduledQueryName(@Nullable
                                                           String value)

`AWS::Timestream::ScheduledQuery.ScheduledQueryName`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Timestream::ScheduledQuery.Tags`.

getTargetConfiguration

@Stability(value=Stable)
 @Nullable
public Object getTargetConfiguration()

`AWS::Timestream::ScheduledQuery.TargetConfiguration`.

setTargetConfiguration

@Stability(value=Stable)
public void setTargetConfiguration(@Nullable
                                                            CfnScheduledQuery.TargetConfigurationProperty value)

`AWS::Timestream::ScheduledQuery.TargetConfiguration`.

setTargetConfiguration

@Stability(value=Stable)
public void setTargetConfiguration(@Nullable
                                                            IResolvable value)

`AWS::Timestream::ScheduledQuery.TargetConfiguration`.