AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi
aws-native.timestream.ScheduledQuery
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi
The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Create ScheduledQuery Resource
new ScheduledQuery(name: string, args: ScheduledQueryArgs, opts?: CustomResourceOptions);
@overload
def ScheduledQuery(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_token: Optional[str] = None,
error_report_configuration: Optional[ScheduledQueryErrorReportConfigurationArgs] = None,
kms_key_id: Optional[str] = None,
notification_configuration: Optional[ScheduledQueryNotificationConfigurationArgs] = None,
query_string: Optional[str] = None,
schedule_configuration: Optional[ScheduledQueryScheduleConfigurationArgs] = None,
scheduled_query_execution_role_arn: Optional[str] = None,
scheduled_query_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
target_configuration: Optional[ScheduledQueryTargetConfigurationArgs] = None)
@overload
def ScheduledQuery(resource_name: str,
args: ScheduledQueryArgs,
opts: Optional[ResourceOptions] = None)
func NewScheduledQuery(ctx *Context, name string, args ScheduledQueryArgs, opts ...ResourceOption) (*ScheduledQuery, error)
public ScheduledQuery(string name, ScheduledQueryArgs args, CustomResourceOptions? opts = null)
public ScheduledQuery(String name, ScheduledQueryArgs args)
public ScheduledQuery(String name, ScheduledQueryArgs args, CustomResourceOptions options)
type: aws-native:timestream:ScheduledQuery
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScheduledQueryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ScheduledQueryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ScheduledQueryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScheduledQueryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ScheduledQueryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ScheduledQuery Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ScheduledQuery resource accepts the following input properties:
- Error
Report Pulumi.Configuration Aws Native. Timestream. Inputs. Scheduled Query Error Report Configuration - Notification
Configuration Pulumi.Aws Native. Timestream. Inputs. Scheduled Query Notification Configuration - Query
String string - Schedule
Configuration Pulumi.Aws Native. Timestream. Inputs. Scheduled Query Schedule Configuration - Scheduled
Query stringExecution Role Arn - Client
Token string - Kms
Key stringId - Scheduled
Query stringName - List<Pulumi.
Aws Native. Inputs. Tag> - Target
Configuration Pulumi.Aws Native. Timestream. Inputs. Scheduled Query Target Configuration
- Error
Report ScheduledConfiguration Query Error Report Configuration Args - Notification
Configuration ScheduledQuery Notification Configuration Args - Query
String string - Schedule
Configuration ScheduledQuery Schedule Configuration Args - Scheduled
Query stringExecution Role Arn - Client
Token string - Kms
Key stringId - Scheduled
Query stringName - Tag
Args - Target
Configuration ScheduledQuery Target Configuration Args
- error
Report ScheduledConfiguration Query Error Report Configuration - notification
Configuration ScheduledQuery Notification Configuration - query
String String - schedule
Configuration ScheduledQuery Schedule Configuration - scheduled
Query StringExecution Role Arn - client
Token String - kms
Key StringId - scheduled
Query StringName - List<Tag>
- target
Configuration ScheduledQuery Target Configuration
- error
Report ScheduledConfiguration Query Error Report Configuration - notification
Configuration ScheduledQuery Notification Configuration - query
String string - schedule
Configuration ScheduledQuery Schedule Configuration - scheduled
Query stringExecution Role Arn - client
Token string - kms
Key stringId - scheduled
Query stringName - Tag[]
- target
Configuration ScheduledQuery Target Configuration
- error_
report_ Scheduledconfiguration Query Error Report Configuration Args - notification_
configuration ScheduledQuery Notification Configuration Args - query_
string str - schedule_
configuration ScheduledQuery Schedule Configuration Args - scheduled_
query_ strexecution_ role_ arn - client_
token str - kms_
key_ strid - scheduled_
query_ strname - Tag
Args] - target_
configuration ScheduledQuery Target Configuration Args
Outputs
All input properties are implicitly available as output properties. Additionally, the ScheduledQuery resource produces the following output properties:
- Arn string
- Id string
- The provider-assigned unique ID for this managed resource.
- Sq
Error stringReport Configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- Sq
Kms stringKey Id - 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.
- Sq
Name string - The name of the scheduled query. Scheduled query names must be unique within each Region.
- Sq
Notification stringConfiguration - 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.
- Sq
Query stringString - 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.
- Sq
Schedule stringConfiguration - Configuration for when the scheduled query is executed.
- Sq
Scheduled stringQuery Execution Role Arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- Sq
Target stringConfiguration - Configuration of target store where scheduled query results are written to.
- Arn string
- Id string
- The provider-assigned unique ID for this managed resource.
- Sq
Error stringReport Configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- Sq
Kms stringKey Id - 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.
- Sq
Name string - The name of the scheduled query. Scheduled query names must be unique within each Region.
- Sq
Notification stringConfiguration - 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.
- Sq
Query stringString - 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.
- Sq
Schedule stringConfiguration - Configuration for when the scheduled query is executed.
- Sq
Scheduled stringQuery Execution Role Arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- Sq
Target stringConfiguration - Configuration of target store where scheduled query results are written to.
- arn String
- id String
- The provider-assigned unique ID for this managed resource.
- sq
Error StringReport Configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- sq
Kms StringKey Id - 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.
- sq
Name String - The name of the scheduled query. Scheduled query names must be unique within each Region.
- sq
Notification StringConfiguration - 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.
- sq
Query StringString - 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.
- sq
Schedule StringConfiguration - Configuration for when the scheduled query is executed.
- sq
Scheduled StringQuery Execution Role Arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- sq
Target StringConfiguration - Configuration of target store where scheduled query results are written to.
- arn string
- id string
- The provider-assigned unique ID for this managed resource.
- sq
Error stringReport Configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- sq
Kms stringKey Id - 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.
- sq
Name string - The name of the scheduled query. Scheduled query names must be unique within each Region.
- sq
Notification stringConfiguration - 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.
- sq
Query stringString - 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.
- sq
Schedule stringConfiguration - Configuration for when the scheduled query is executed.
- sq
Scheduled stringQuery Execution Role Arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- sq
Target stringConfiguration - Configuration of target store where scheduled query results are written to.
- arn str
- id str
- The provider-assigned unique ID for this managed resource.
- sq_
error_ strreport_ configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- sq_
kms_ strkey_ id - 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.
- sq_
name str - The name of the scheduled query. Scheduled query names must be unique within each Region.
- sq_
notification_ strconfiguration - 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.
- sq_
query_ strstring - 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.
- sq_
schedule_ strconfiguration - Configuration for when the scheduled query is executed.
- sq_
scheduled_ strquery_ execution_ role_ arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- sq_
target_ strconfiguration - Configuration of target store where scheduled query results are written to.
- arn String
- id String
- The provider-assigned unique ID for this managed resource.
- sq
Error StringReport Configuration - Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
- sq
Kms StringKey Id - 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.
- sq
Name String - The name of the scheduled query. Scheduled query names must be unique within each Region.
- sq
Notification StringConfiguration - 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.
- sq
Query StringString - 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.
- sq
Schedule StringConfiguration - Configuration for when the scheduled query is executed.
- sq
Scheduled StringQuery Execution Role Arn - The ARN for the IAM role that Timestream will assume when running the scheduled query.
- sq
Target StringConfiguration - Configuration of target store where scheduled query results are written to.
Supporting Types
ScheduledQueryDimensionMapping, ScheduledQueryDimensionMappingArgs
- dimension
Value "VARCHAR"Type - name String
ScheduledQueryDimensionValueType, ScheduledQueryDimensionValueTypeArgs
- Varchar
- VARCHAR
- Scheduled
Query Dimension Value Type Varchar - VARCHAR
- Varchar
- VARCHAR
- Varchar
- VARCHAR
- VARCHAR
- VARCHAR
- "VARCHAR"
- VARCHAR
ScheduledQueryEncryptionOption, ScheduledQueryEncryptionOptionArgs
- Sse
S3 - SSE_S3
- Sse
Kms - SSE_KMS
- Scheduled
Query Encryption Option Sse S3 - SSE_S3
- Scheduled
Query Encryption Option Sse Kms - SSE_KMS
- Sse
S3 - SSE_S3
- Sse
Kms - SSE_KMS
- Sse
S3 - SSE_S3
- Sse
Kms - SSE_KMS
- SSE_S3
- SSE_S3
- SSE_KMS
- SSE_KMS
- "SSE_S3"
- SSE_S3
- "SSE_KMS"
- SSE_KMS
ScheduledQueryErrorReportConfiguration, ScheduledQueryErrorReportConfigurationArgs
ScheduledQueryMixedMeasureMapping, ScheduledQueryMixedMeasureMappingArgs
ScheduledQueryMixedMeasureMappingMeasureValueType, ScheduledQueryMixedMeasureMappingMeasureValueTypeArgs
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Multi
- MULTI
- Scheduled
Query Mixed Measure Mapping Measure Value Type Bigint - BIGINT
- Scheduled
Query Mixed Measure Mapping Measure Value Type Boolean - BOOLEAN
- Scheduled
Query Mixed Measure Mapping Measure Value Type Double - DOUBLE
- Scheduled
Query Mixed Measure Mapping Measure Value Type Varchar - VARCHAR
- Scheduled
Query Mixed Measure Mapping Measure Value Type Multi - MULTI
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Multi
- MULTI
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Multi
- MULTI
- BIGINT
- BIGINT
- BOOLEAN
- BOOLEAN
- DOUBLE
- DOUBLE
- VARCHAR
- VARCHAR
- MULTI
- MULTI
- "BIGINT"
- BIGINT
- "BOOLEAN"
- BOOLEAN
- "DOUBLE"
- DOUBLE
- "VARCHAR"
- VARCHAR
- "MULTI"
- MULTI
ScheduledQueryMultiMeasureAttributeMapping, ScheduledQueryMultiMeasureAttributeMappingArgs
ScheduledQueryMultiMeasureAttributeMappingMeasureValueType, ScheduledQueryMultiMeasureAttributeMappingMeasureValueTypeArgs
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Timestamp
- TIMESTAMP
- Scheduled
Query Multi Measure Attribute Mapping Measure Value Type Bigint - BIGINT
- Scheduled
Query Multi Measure Attribute Mapping Measure Value Type Boolean - BOOLEAN
- Scheduled
Query Multi Measure Attribute Mapping Measure Value Type Double - DOUBLE
- Scheduled
Query Multi Measure Attribute Mapping Measure Value Type Varchar - VARCHAR
- Scheduled
Query Multi Measure Attribute Mapping Measure Value Type Timestamp - TIMESTAMP
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Timestamp
- TIMESTAMP
- Bigint
- BIGINT
- Boolean
- BOOLEAN
- Double
- DOUBLE
- Varchar
- VARCHAR
- Timestamp
- TIMESTAMP
- BIGINT
- BIGINT
- BOOLEAN
- BOOLEAN
- DOUBLE
- DOUBLE
- VARCHAR
- VARCHAR
- TIMESTAMP
- TIMESTAMP
- "BIGINT"
- BIGINT
- "BOOLEAN"
- BOOLEAN
- "DOUBLE"
- DOUBLE
- "VARCHAR"
- VARCHAR
- "TIMESTAMP"
- TIMESTAMP
ScheduledQueryMultiMeasureMappings, ScheduledQueryMultiMeasureMappingsArgs
ScheduledQueryNotificationConfiguration, ScheduledQueryNotificationConfigurationArgs
ScheduledQueryS3Configuration, ScheduledQueryS3ConfigurationArgs
ScheduledQueryScheduleConfiguration, ScheduledQueryScheduleConfigurationArgs
- Schedule
Expression string
- Schedule
Expression string
- schedule
Expression String
- schedule
Expression string
- schedule
Expression String
ScheduledQuerySnsConfiguration, ScheduledQuerySnsConfigurationArgs
- Topic
Arn string
- Topic
Arn string
- topic
Arn String
- topic
Arn string
- topic_
arn str
- topic
Arn String
ScheduledQueryTargetConfiguration, ScheduledQueryTargetConfigurationArgs
ScheduledQueryTimestreamConfiguration, ScheduledQueryTimestreamConfigurationArgs
- Database
Name string - Dimension
Mappings List<Pulumi.Aws Native. Timestream. Inputs. Scheduled Query Dimension Mapping> - Table
Name string - Time
Column string - Measure
Name stringColumn - Mixed
Measure List<Pulumi.Mappings Aws Native. Timestream. Inputs. Scheduled Query Mixed Measure Mapping> - Multi
Measure Pulumi.Mappings Aws Native. Timestream. Inputs. Scheduled Query Multi Measure Mappings
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi