Package software.amazon.awscdk.cfnpropertymixins.services.timestream

Class CfnScheduledQueryPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.timestream.CfnScheduledQueryPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledQueryPropsMixin>

Enclosing class:

CfnScheduledQueryPropsMixin

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

A fluent builder for CfnScheduledQueryPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnScheduledQueryPropsMixin	build()
CfnScheduledQueryPropsMixin.Builder	clientToken(String clientToken)	Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
static CfnScheduledQueryPropsMixin.Builder	create()
static CfnScheduledQueryPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnScheduledQueryPropsMixin.Builder	errorReportConfiguration(CfnScheduledQueryPropsMixin.ErrorReportConfigurationProperty errorReportConfiguration)	Configuration for error reporting.
CfnScheduledQueryPropsMixin.Builder	errorReportConfiguration(IResolvable errorReportConfiguration)	Configuration for error reporting.
CfnScheduledQueryPropsMixin.Builder	kmsKeyId(String kmsKeyId)	The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
CfnScheduledQueryPropsMixin.Builder	kmsKeyId(IKeyRef kmsKeyId)	The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
CfnScheduledQueryPropsMixin.Builder	notificationConfiguration(CfnScheduledQueryPropsMixin.NotificationConfigurationProperty notificationConfiguration)	Notification configuration for the scheduled query.
CfnScheduledQueryPropsMixin.Builder	notificationConfiguration(IResolvable notificationConfiguration)	Notification configuration for the scheduled query.
CfnScheduledQueryPropsMixin.Builder	queryString(String queryString)	The query string to run.
CfnScheduledQueryPropsMixin.Builder	scheduleConfiguration(CfnScheduledQueryPropsMixin.ScheduleConfigurationProperty scheduleConfiguration)	Schedule configuration.
CfnScheduledQueryPropsMixin.Builder	scheduleConfiguration(IResolvable scheduleConfiguration)	Schedule configuration.
CfnScheduledQueryPropsMixin.Builder	scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)	The ARN for the IAM role that Timestream will assume when running the scheduled query.
CfnScheduledQueryPropsMixin.Builder	scheduledQueryExecutionRoleArn(IRoleRef scheduledQueryExecutionRoleArn)	The ARN for the IAM role that Timestream will assume when running the scheduled query.
CfnScheduledQueryPropsMixin.Builder	scheduledQueryName(String scheduledQueryName)	A name for the query.
CfnScheduledQueryPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to label the scheduled query.
CfnScheduledQueryPropsMixin.Builder	targetConfiguration(CfnScheduledQueryPropsMixin.TargetConfigurationProperty targetConfiguration)	Scheduled query target store configuration.
CfnScheduledQueryPropsMixin.Builder	targetConfiguration(IResolvable targetConfiguration)	Scheduled query target store configuration.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnScheduledQueryPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnScheduledQueryPropsMixin.Builder.

create

@Stability(Stable)
public static CfnScheduledQueryPropsMixin.Builder create()

Returns:

a new instance of CfnScheduledQueryPropsMixin.Builder.

clientToken

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder clientToken(String 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.

Parameters:

clientToken - Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-clienttoken

errorReportConfiguration

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

Configuration for error reporting.

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

Parameters:

errorReportConfiguration - Configuration for error reporting. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-errorreportconfiguration

errorReportConfiguration

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder errorReportConfiguration(CfnScheduledQueryPropsMixin.ErrorReportConfigurationProperty errorReportConfiguration)

Configuration for error reporting.

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

Parameters:

errorReportConfiguration - Configuration for error reporting. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-errorreportconfiguration

kmsKeyId

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder kmsKeyId(String 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.

Parameters:

kmsKeyId - The Amazon KMS key used to encrypt the scheduled query resource, at-rest. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-kmskeyid

kmsKeyId

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder kmsKeyId(IKeyRef 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.

Parameters:

kmsKeyId - The Amazon KMS key used to encrypt the scheduled query resource, at-rest. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-kmskeyid

notificationConfiguration

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

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.

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-notificationconfiguration

notificationConfiguration

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder notificationConfiguration(CfnScheduledQueryPropsMixin.NotificationConfigurationProperty notificationConfiguration)

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.

Parameters:

notificationConfiguration - Notification configuration for the scheduled query. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-notificationconfiguration

queryString

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

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.

Parameters:

queryString - The query string to run. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-querystring

scheduleConfiguration

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

Schedule configuration.

Parameters:

scheduleConfiguration - Schedule configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduleconfiguration

scheduleConfiguration

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder scheduleConfiguration(CfnScheduledQueryPropsMixin.ScheduleConfigurationProperty scheduleConfiguration)

Schedule configuration.

Parameters:

scheduleConfiguration - Schedule configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduleconfiguration

scheduledQueryExecutionRoleArn

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

The ARN for the IAM role that Timestream will assume when running the scheduled query.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn

scheduledQueryExecutionRoleArn

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder scheduledQueryExecutionRoleArn(IRoleRef scheduledQueryExecutionRoleArn)

The ARN for the IAM role that Timestream will assume when running the scheduled query.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryexecutionrolearn

scheduledQueryName

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

A name for the query.

Scheduled query names must be unique within each Region.

Parameters:

scheduledQueryName - A name for the query. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-scheduledqueryname

tags

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

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

Parameters:

tags - A list of key-value pairs to label the scheduled query. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-tags

targetConfiguration

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

Scheduled query target store configuration.

Parameters:

targetConfiguration - Scheduled query target store configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-targetconfiguration

targetConfiguration

@Stability(Stable)
public CfnScheduledQueryPropsMixin.Builder targetConfiguration(CfnScheduledQueryPropsMixin.TargetConfigurationProperty targetConfiguration)

Scheduled query target store configuration.

Parameters:

targetConfiguration - Scheduled query target store configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html#cfn-timestream-scheduledquery-targetconfiguration

build

@Stability(Stable)
public CfnScheduledQueryPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnScheduledQueryPropsMixin.