@Stability(value=Stable) public static final class CfnScheduledQueryProps.Builder extends Object implements software.amazon.jsii.Builder<CfnScheduledQueryProps>
CfnScheduledQueryProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnScheduledQueryProps.Builder errorReportConfiguration(CfnScheduledQuery.ErrorReportConfigurationProperty errorReportConfiguration)
CfnScheduledQueryProps.getErrorReportConfiguration()errorReportConfiguration - Configuration for error reporting. This parameter is required.
Error reports will be generated when a problem is encountered when writing the query results.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder errorReportConfiguration(IResolvable errorReportConfiguration)
CfnScheduledQueryProps.getErrorReportConfiguration()errorReportConfiguration - Configuration for error reporting. This parameter is required.
Error reports will be generated when a problem is encountered when writing the query results.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder notificationConfiguration(CfnScheduledQuery.NotificationConfigurationProperty notificationConfiguration)
CfnScheduledQueryProps.getNotificationConfiguration()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.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder notificationConfiguration(IResolvable notificationConfiguration)
CfnScheduledQueryProps.getNotificationConfiguration()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.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder queryString(String queryString)
CfnScheduledQueryProps.getQueryString()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.
this@Stability(value=Stable) public CfnScheduledQueryProps.Builder scheduleConfiguration(CfnScheduledQuery.ScheduleConfigurationProperty scheduleConfiguration)
CfnScheduledQueryProps.getScheduleConfiguration()scheduleConfiguration - Schedule configuration. This parameter is required.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder scheduleConfiguration(IResolvable scheduleConfiguration)
CfnScheduledQueryProps.getScheduleConfiguration()scheduleConfiguration - Schedule configuration. This parameter is required.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder scheduledQueryExecutionRoleArn(String scheduledQueryExecutionRoleArn)
CfnScheduledQueryProps.getScheduledQueryExecutionRoleArn()scheduledQueryExecutionRoleArn - The ARN for the IAM role that Timestream will assume when running the scheduled query. This parameter is required.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder clientToken(String clientToken)
CfnScheduledQueryProps.getClientToken()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.
ClientToken , the Query SDK generates a ClientToken on your behalf.ClientToken is treated as a new request.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder kmsKeyId(String kmsKeyId)
CfnScheduledQueryProps.getKmsKeyId()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.
this@Stability(value=Stable) public CfnScheduledQueryProps.Builder scheduledQueryName(String scheduledQueryName)
CfnScheduledQueryProps.getScheduledQueryName()scheduledQueryName - A name for the query.
Scheduled query names must be unique within each Region.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder tags(List<? extends CfnTag> tags)
CfnScheduledQueryProps.getTags()tags - A list of key-value pairs to label the scheduled query.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder targetConfiguration(CfnScheduledQuery.TargetConfigurationProperty targetConfiguration)
CfnScheduledQueryProps.getTargetConfiguration()targetConfiguration - Scheduled query target store configuration.this@Stability(value=Stable) public CfnScheduledQueryProps.Builder targetConfiguration(IResolvable targetConfiguration)
CfnScheduledQueryProps.getTargetConfiguration()targetConfiguration - Scheduled query target store configuration.this@Stability(value=Stable) public CfnScheduledQueryProps build()
build in interface software.amazon.jsii.Builder<CfnScheduledQueryProps>CfnScheduledQueryPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.