Class CfnScheduledQueryProps

Properties for defining a CfnScheduledQuery.

Inheritance
System.Object
CfnScheduledQueryProps
Namespace: Amazon.CDK.AWS.Timestream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnScheduledQueryProps : Object, ICfnScheduledQueryProps
Syntax (vb)
Public Class CfnScheduledQueryProps
    Inherits Object
    Implements ICfnScheduledQueryProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-timestream-scheduledquery.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Timestream;

var cfnScheduledQueryProps = new CfnScheduledQueryProps {
    ErrorReportConfiguration = new ErrorReportConfigurationProperty {
        S3Configuration = new S3ConfigurationProperty {
            BucketName = "bucketName",

            // the properties below are optional
            EncryptionOption = "encryptionOption",
            ObjectKeyPrefix = "objectKeyPrefix"
        }
    },
    NotificationConfiguration = new NotificationConfigurationProperty {
        SnsConfiguration = new SnsConfigurationProperty {
            TopicArn = "topicArn"
        }
    },
    QueryString = "queryString",
    ScheduleConfiguration = new ScheduleConfigurationProperty {
        ScheduleExpression = "scheduleExpression"
    },
    ScheduledQueryExecutionRoleArn = "scheduledQueryExecutionRoleArn",

    // the properties below are optional
    ClientToken = "clientToken",
    KmsKeyId = "kmsKeyId",
    ScheduledQueryName = "scheduledQueryName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TargetConfiguration = new TargetConfigurationProperty {
        TimestreamConfiguration = new TimestreamConfigurationProperty {
            DatabaseName = "databaseName",
            DimensionMappings = new [] { new DimensionMappingProperty {
                DimensionValueType = "dimensionValueType",
                Name = "name"
            } },
            TableName = "tableName",
            TimeColumn = "timeColumn",

            // the properties below are optional
            MeasureNameColumn = "measureNameColumn",
            MixedMeasureMappings = new [] { new MixedMeasureMappingProperty {
                MeasureValueType = "measureValueType",

                // the properties below are optional
                MeasureName = "measureName",
                MultiMeasureAttributeMappings = new [] { new MultiMeasureAttributeMappingProperty {
                    MeasureValueType = "measureValueType",
                    SourceColumn = "sourceColumn",

                    // the properties below are optional
                    TargetMultiMeasureAttributeName = "targetMultiMeasureAttributeName"
                } },
                SourceColumn = "sourceColumn",
                TargetMeasureName = "targetMeasureName"
            } },
            MultiMeasureMappings = new MultiMeasureMappingsProperty {
                MultiMeasureAttributeMappings = new [] { new MultiMeasureAttributeMappingProperty {
                    MeasureValueType = "measureValueType",
                    SourceColumn = "sourceColumn",

                    // the properties below are optional
                    TargetMultiMeasureAttributeName = "targetMultiMeasureAttributeName"
                } },

                // the properties below are optional
                TargetMultiMeasureName = "targetMultiMeasureName"
            }
        }
    }
};

Synopsis

Constructors

CfnScheduledQueryProps()

Properties

ClientToken

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
ErrorReportConfiguration

Configuration for error reporting.
KmsKeyId

The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
NotificationConfiguration

Notification configuration for the scheduled query.
QueryString

The query string to run.
ScheduleConfiguration

Schedule configuration.
ScheduledQueryExecutionRoleArn

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

A name for the query.
Tags

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

Scheduled query target store configuration.

Constructors

CfnScheduledQueryProps()

public CfnScheduledQueryProps()

Properties

ClientToken

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.

public string ClientToken { get; set; }
Property Value

System.String

Remarks

Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

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

    ErrorReportConfiguration

    Configuration for error reporting.

    public object ErrorReportConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

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

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

    KmsKeyId

    The Amazon KMS key used to encrypt the scheduled query resource, at-rest.

    public string KmsKeyId { get; set; }
    Property Value

    System.String

    Remarks

    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.

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

    NotificationConfiguration

    Notification configuration for the scheduled query.

    public object NotificationConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

    A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

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

    QueryString

    The query string to run.

    public string QueryString { get; set; }
    Property Value

    System.String

    Remarks

    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.

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

    ScheduleConfiguration

    Schedule configuration.

    public object ScheduleConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

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

    ScheduledQueryExecutionRoleArn

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

    public string ScheduledQueryExecutionRoleArn { get; set; }
    Property Value

    System.String

    Remarks

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

    ScheduledQueryName

    A name for the query.

    public string ScheduledQueryName { get; set; }
    Property Value

    System.String

    Remarks

    Scheduled query names must be unique within each Region.

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

    Tags

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

    public ICfnTag[] Tags { get; set; }
    Property Value

    ICfnTag[]

    Remarks

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

    TargetConfiguration

    Scheduled query target store configuration.

    public object TargetConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

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

    Implements