Package software.amazon.awscdk.services.timestream

Class CfnScheduledQueryProps.Builder

java.lang.Object

software.amazon.awscdk.services.timestream.CfnScheduledQueryProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledQueryProps>

Enclosing interface:

CfnScheduledQueryProps

@Stability(Stable)
public static final class CfnScheduledQueryProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScheduledQueryProps>

A builder for CfnScheduledQueryProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScheduledQueryProps	build()	Builds the configured instance.
CfnScheduledQueryProps.Builder	clientToken(String clientToken)	Sets the value of CfnScheduledQueryProps.getClientToken()
CfnScheduledQueryProps.Builder	errorReportConfiguration(IResolvable errorReportConfiguration)	Sets the value of CfnScheduledQueryProps.getErrorReportConfiguration()
CfnScheduledQueryProps.Builder	errorReportConfiguration(CfnScheduledQuery.ErrorReportConfigurationProperty errorReportConfiguration)	Sets the value of CfnScheduledQueryProps.getErrorReportConfiguration()
CfnScheduledQueryProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnScheduledQueryProps.getKmsKeyId()
CfnScheduledQueryProps.Builder	notificationConfiguration(IResolvable notificationConfiguration)	Sets the value of CfnScheduledQueryProps.getNotificationConfiguration()
CfnScheduledQueryProps.Builder	notificationConfiguration(CfnScheduledQuery.NotificationConfigurationProperty notificationConfiguration)	Sets the value of CfnScheduledQueryProps.getNotificationConfiguration()
CfnScheduledQueryProps.Builder	queryString(String queryString)	Sets the value of CfnScheduledQueryProps.getQueryString()
CfnScheduledQueryProps.Builder	scheduleConfiguration(IResolvable scheduleConfiguration)	Sets the value of CfnScheduledQueryProps.getScheduleConfiguration()
CfnScheduledQueryProps.Builder	scheduleConfiguration(CfnScheduledQuery.ScheduleConfigurationProperty scheduleConfiguration)	Sets the value of CfnScheduledQueryProps.getScheduleConfiguration()
CfnScheduledQueryProps.Builder	scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)	Sets the value of CfnScheduledQueryProps.getScheduledQueryExecutionRoleArn()
CfnScheduledQueryProps.Builder	scheduledQueryName(String scheduledQueryName)	Sets the value of CfnScheduledQueryProps.getScheduledQueryName()
CfnScheduledQueryProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnScheduledQueryProps.getTags()
CfnScheduledQueryProps.Builder	targetConfiguration(IResolvable targetConfiguration)	Sets the value of CfnScheduledQueryProps.getTargetConfiguration()
CfnScheduledQueryProps.Builder	targetConfiguration(CfnScheduledQuery.TargetConfigurationProperty targetConfiguration)	Sets the value of CfnScheduledQueryProps.getTargetConfiguration()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

errorReportConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder errorReportConfiguration(CfnScheduledQuery.ErrorReportConfigurationProperty errorReportConfiguration)

Sets the value of CfnScheduledQueryProps.getErrorReportConfiguration()

Parameters:

errorReportConfiguration - Configuration for error reporting. This parameter is required. Error reports will be generated when a problem is encountered when writing the query results.

Returns:

this

errorReportConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder errorReportConfiguration(IResolvable errorReportConfiguration)

Sets the value of CfnScheduledQueryProps.getErrorReportConfiguration()

Parameters:

errorReportConfiguration - Configuration for error reporting. This parameter is required. Error reports will be generated when a problem is encountered when writing the query results.

Returns:

this

notificationConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder notificationConfiguration(IResolvable notificationConfiguration)

Sets the value of CfnScheduledQueryProps.getNotificationConfiguration()

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. This parameter is required. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Returns:

this

notificationConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder notificationConfiguration(CfnScheduledQuery.NotificationConfigurationProperty notificationConfiguration)

Sets the value of CfnScheduledQueryProps.getNotificationConfiguration()

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. This parameter is required. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

Returns:

this

queryString

@Stability(Stable)
public CfnScheduledQueryProps.Builder queryString(String queryString)

Sets the value of CfnScheduledQueryProps.getQueryString()

Parameters:

queryString - The query string to run. This parameter is required. 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.

Returns:

this

scheduleConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder scheduleConfiguration(IResolvable scheduleConfiguration)

Sets the value of CfnScheduledQueryProps.getScheduleConfiguration()

Parameters:

scheduleConfiguration - Schedule configuration. This parameter is required.

Returns:

this

scheduleConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder scheduleConfiguration(CfnScheduledQuery.ScheduleConfigurationProperty scheduleConfiguration)

Sets the value of CfnScheduledQueryProps.getScheduleConfiguration()

Parameters:

scheduleConfiguration - Schedule configuration. This parameter is required.

Returns:

this

scheduledQueryExecutionRoleArn

@Stability(Stable)
public CfnScheduledQueryProps.Builder scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)

Sets the value of CfnScheduledQueryProps.getScheduledQueryExecutionRoleArn()

Parameters:

scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query. This parameter is required.

Returns:

this

clientToken

@Stability(Stable)
public CfnScheduledQueryProps.Builder clientToken(String clientToken)

Sets the value of CfnScheduledQueryProps.getClientToken()

Parameters:

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

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnScheduledQueryProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnScheduledQueryProps.getKmsKeyId()

Parameters:

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

Returns:

this

scheduledQueryName

@Stability(Stable)
public CfnScheduledQueryProps.Builder scheduledQueryName(String scheduledQueryName)

Sets the value of CfnScheduledQueryProps.getScheduledQueryName()

Parameters:

scheduledQueryName - A name for the query. Scheduled query names must be unique within each Region.

Returns:

this

tags

@Stability(Stable)
public CfnScheduledQueryProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnScheduledQueryProps.getTags()

Parameters:

tags - A list of key-value pairs to label the scheduled query.

Returns:

this

targetConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder targetConfiguration(IResolvable targetConfiguration)

Sets the value of CfnScheduledQueryProps.getTargetConfiguration()

Parameters:

targetConfiguration - Scheduled query target store configuration.

Returns:

this

targetConfiguration

@Stability(Stable)
public CfnScheduledQueryProps.Builder targetConfiguration(CfnScheduledQuery.TargetConfigurationProperty targetConfiguration)

Sets the value of CfnScheduledQueryProps.getTargetConfiguration()

Parameters:

targetConfiguration - Scheduled query target store configuration.

Returns:

this

build

@Stability(Stable)
public CfnScheduledQueryProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScheduledQueryProps>

Returns:

a new instance of CfnScheduledQueryProps

Throws:

NullPointerException - if any required attribute was not provided