Class CfnScheduledQuery
A CloudFormation AWS::Timestream::ScheduledQuery
.
Inherited Members
Namespace: Amazon.CDK.AWS.Timestream
Assembly: Amazon.CDK.AWS.Timestream.dll
Syntax (csharp)
public class CfnScheduledQuery : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnScheduledQuery
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn
parameter to run the query. You can use the NotificationConfiguration
parameter to configure notification for your scheduled query operations.
CloudformationResource: AWS::Timestream::ScheduledQuery
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 cfnScheduledQuery = new CfnScheduledQuery(this, "MyCfnScheduledQuery", 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
CfnScheduledQuery(Construct, String, ICfnScheduledQueryProps) | Create a new |
CfnScheduledQuery(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnScheduledQuery(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The |
AttrSqErrorReportConfiguration | The scheduled query error reporting configuration. |
AttrSqKmsKeyId | The KMS key used to encrypt the query resource, if a customer managed KMS key was provided. |
AttrSqName | The scheduled query name. |
AttrSqNotificationConfiguration | The scheduled query notification configuration. |
AttrSqQueryString | The scheduled query string.. |
AttrSqScheduleConfiguration | The scheduled query schedule configuration. |
AttrSqScheduledQueryExecutionRoleArn | The ARN of the IAM role that will be used by Timestream to run the query. |
AttrSqTargetConfiguration | The configuration for query output. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnScheduledQuery(Construct, String, ICfnScheduledQueryProps)
Create a new AWS::Timestream::ScheduledQuery
.
public CfnScheduledQuery(Construct scope, string id, ICfnScheduledQueryProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnScheduledQueryProps
- resource properties.
CfnScheduledQuery(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnScheduledQuery(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnScheduledQuery(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnScheduledQuery(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN
of the scheduled query.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrSqErrorReportConfiguration
The scheduled query error reporting configuration.
public virtual string AttrSqErrorReportConfiguration { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQErrorReportConfiguration
AttrSqKmsKeyId
The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.
public virtual string AttrSqKmsKeyId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQKmsKeyId
AttrSqName
The scheduled query name.
public virtual string AttrSqName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQName
AttrSqNotificationConfiguration
The scheduled query notification configuration.
public virtual string AttrSqNotificationConfiguration { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQNotificationConfiguration
AttrSqQueryString
The scheduled query string..
public virtual string AttrSqQueryString { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQQueryString
AttrSqScheduleConfiguration
The scheduled query schedule configuration.
public virtual string AttrSqScheduleConfiguration { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQScheduleConfiguration
AttrSqScheduledQueryExecutionRoleArn
The ARN of the IAM role that will be used by Timestream to run the query.
public virtual string AttrSqScheduledQueryExecutionRoleArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQScheduledQueryExecutionRoleArn
AttrSqTargetConfiguration
The configuration for query output.
public virtual string AttrSqTargetConfiguration { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SQTargetConfiguration
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientToken
Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result.
public virtual string ClientToken { get; set; }
Property Value
System.String
Remarks
Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.
ErrorReportConfiguration
Configuration for error reporting.
public virtual object ErrorReportConfiguration { get; set; }
Property Value
System.Object
Remarks
Error reports will be generated when a problem is encountered when writing the query results.
KmsKeyId
The Amazon KMS key used to encrypt the scheduled query resource, at-rest.
public virtual 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.
NotificationConfiguration
Notification configuration for the scheduled query.
public virtual 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.
QueryString
The query string to run.
public virtual 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.
ScheduleConfiguration
Schedule configuration.
public virtual object ScheduleConfiguration { get; set; }
Property Value
System.Object
Remarks
ScheduledQueryExecutionRoleArn
The ARN for the IAM role that Timestream will assume when running the scheduled query.
public virtual string ScheduledQueryExecutionRoleArn { get; set; }
Property Value
System.String
Remarks
ScheduledQueryName
A name for the query.
public virtual string ScheduledQueryName { get; set; }
Property Value
System.String
Remarks
Scheduled query names must be unique within each Region.
Tags
A list of key-value pairs to label the scheduled query.
public virtual TagManager Tags { get; }
Property Value
Remarks
TargetConfiguration
Scheduled query target store configuration.
public virtual object TargetConfiguration { get; set; }
Property Value
System.Object
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>