Class: AWSCDK::Timestream::CfnScheduledQuery

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSTimestream::IScheduledQueryRef
Defined in:
timestream/cfn_scheduled_query.rb

Overview

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.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnScheduledQuery

Create a new AWS::Timestream::ScheduledQuery.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Timestream::CfnScheduledQueryProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'timestream/cfn_scheduled_query.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Timestream::CfnScheduledQueryProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdGltZXN0cmVhbS5DZm5TY2hlZHVsZWRRdWVyeVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_scheduled_query(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'timestream/cfn_scheduled_query.rb', line 91

def self.arn_for_scheduled_query(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190aW1lc3RyZWFtLklTY2hlZHVsZWRRdWVyeVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_timestream.CfnScheduledQuery", "arnForScheduledQuery", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'timestream/cfn_scheduled_query.rb', line 198

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_timestream.CfnScheduledQuery", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_scheduled_query(x) ⇒ Boolean

Checks whether the given object is a CfnScheduledQuery.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'timestream/cfn_scheduled_query.rb', line 100

def self.is_cfn_scheduled_query(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_timestream.CfnScheduledQuery", "isCfnScheduledQuery", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'timestream/cfn_scheduled_query.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_sq_error_report_configuration => { kind: :property, name: "attrSqErrorReportConfiguration", is_optional: false },
    :attr_sq_kms_key_id => { kind: :property, name: "attrSqKmsKeyId", is_optional: false },
    :attr_sq_name => { kind: :property, name: "attrSqName", is_optional: false },
    :attr_sq_notification_configuration => { kind: :property, name: "attrSqNotificationConfiguration", is_optional: false },
    :attr_sq_query_string => { kind: :property, name: "attrSqQueryString", is_optional: false },
    :attr_sq_schedule_configuration => { kind: :property, name: "attrSqScheduleConfiguration", is_optional: false },
    :attr_sq_scheduled_query_execution_role_arn => { kind: :property, name: "attrSqScheduledQueryExecutionRoleArn", is_optional: false },
    :attr_sq_target_configuration => { kind: :property, name: "attrSqTargetConfiguration", is_optional: false },
    :scheduled_query_ref => { kind: :property, name: "scheduledQueryRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :error_report_configuration => { kind: :property, name: "errorReportConfiguration", is_optional: false },
    :notification_configuration => { kind: :property, name: "notificationConfiguration", is_optional: false },
    :query_string => { kind: :property, name: "queryString", is_optional: false },
    :schedule_configuration => { kind: :property, name: "scheduleConfiguration", is_optional: false },
    :scheduled_query_execution_role_arn => { kind: :property, name: "scheduledQueryExecutionRoleArn", is_optional: false },
    :client_token => { kind: :property, name: "clientToken", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :scheduled_query_name => { kind: :property, name: "scheduledQueryName", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :target_configuration => { kind: :property, name: "targetConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



440
441
442
443
 
# File 'timestream/cfn_scheduled_query.rb', line 440

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



452
453
454
455
 
# File 'timestream/cfn_scheduled_query.rb', line 452

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



462
463
464
465
 
# File 'timestream/cfn_scheduled_query.rb', line 462

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



473
474
475
476
477
 
# File 'timestream/cfn_scheduled_query.rb', line 473

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


530
531
532
533
534
 
# File 'timestream/cfn_scheduled_query.rb', line 530

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



540
541
542
543
 
# File 'timestream/cfn_scheduled_query.rb', line 540

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



552
553
554
555
556
 
# File 'timestream/cfn_scheduled_query.rb', line 552

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



565
566
567
568
 
# File 'timestream/cfn_scheduled_query.rb', line 565

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



587
588
589
590
591
592
 
# File 'timestream/cfn_scheduled_query.rb', line 587

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the scheduled query.

Returns:

  • (String) 


205
206
207
 
# File 'timestream/cfn_scheduled_query.rb', line 205

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_sq_error_report_configuration ⇒ String

The scheduled query error reporting configuration.

Returns:

  • (String) 


212
213
214
 
# File 'timestream/cfn_scheduled_query.rb', line 212

def attr_sq_error_report_configuration()
  jsii_get_property("attrSqErrorReportConfiguration")
end

#attr_sq_kms_key_id ⇒ String

The KMS key used to encrypt the query resource, if a customer managed KMS key was provided.

Returns:

  • (String) 


219
220
221
 
# File 'timestream/cfn_scheduled_query.rb', line 219

def attr_sq_kms_key_id()
  jsii_get_property("attrSqKmsKeyId")
end

#attr_sq_name ⇒ String

The scheduled query name.

Returns:

  • (String) 


226
227
228
 
# File 'timestream/cfn_scheduled_query.rb', line 226

def attr_sq_name()
  jsii_get_property("attrSqName")
end

#attr_sq_notification_configuration ⇒ String

The scheduled query notification configuration.

Returns:

  • (String) 


233
234
235
 
# File 'timestream/cfn_scheduled_query.rb', line 233

def attr_sq_notification_configuration()
  jsii_get_property("attrSqNotificationConfiguration")
end

#attr_sq_query_string ⇒ String

The scheduled query string..

Returns:

  • (String) 


240
241
242
 
# File 'timestream/cfn_scheduled_query.rb', line 240

def attr_sq_query_string()
  jsii_get_property("attrSqQueryString")
end

#attr_sq_schedule_configuration ⇒ String

The scheduled query schedule configuration.

Returns:

  • (String) 


247
248
249
 
# File 'timestream/cfn_scheduled_query.rb', line 247

def attr_sq_schedule_configuration()
  jsii_get_property("attrSqScheduleConfiguration")
end

#attr_sq_scheduled_query_execution_role_arn ⇒ String

The ARN of the IAM role that will be used by Timestream to run the query.

Returns:

  • (String) 


254
255
256
 
# File 'timestream/cfn_scheduled_query.rb', line 254

def attr_sq_scheduled_query_execution_role_arn()
  jsii_get_property("attrSqScheduledQueryExecutionRoleArn")
end

#attr_sq_target_configuration ⇒ String

The configuration for query output.

Returns:

  • (String) 


261
262
263
 
# File 'timestream/cfn_scheduled_query.rb', line 261

def attr_sq_target_configuration()
  jsii_get_property("attrSqTargetConfiguration")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



151
152
153
 
# File 'timestream/cfn_scheduled_query.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'timestream/cfn_scheduled_query.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


596
597
598
599
 
# File 'timestream/cfn_scheduled_query.rb', line 596

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


161
162
163
 
# File 'timestream/cfn_scheduled_query.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'timestream/cfn_scheduled_query.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#client_token ⇒ String?

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

Returns:

  • (String, nil) 


345
346
347
 
# File 'timestream/cfn_scheduled_query.rb', line 345

def client_token()
  jsii_get_property("clientToken")
end

#client_token=(value) ⇒ Object 



349
350
351
352
 
# File 'timestream/cfn_scheduled_query.rb', line 349

def client_token=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientToken") unless value.nil?
  jsii_set_property("clientToken", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'timestream/cfn_scheduled_query.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



173
174
175
 
# File 'timestream/cfn_scheduled_query.rb', line 173

def env()
  jsii_get_property("env")
end

#error_report_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Timestream::CfnScheduledQuery::ErrorReportConfigurationProperty

Configuration for error reporting.

Returns:



282
283
284
 
# File 'timestream/cfn_scheduled_query.rb', line 282

def error_report_configuration()
  jsii_get_property("errorReportConfiguration")
end

#error_report_configuration=(value) ⇒ Object 



286
287
288
289
290
 
# File 'timestream/cfn_scheduled_query.rb', line 286

def error_report_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnScheduledQuery::ErrorReportConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmblNjaGVkdWxlZFF1ZXJ5LkVycm9yUmVwb3J0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "errorReportConfiguration")
  jsii_set_property("errorReportConfiguration", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



609
610
611
612
613
 
# File 'timestream/cfn_scheduled_query.rb', line 609

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



620
621
622
623
 
# File 'timestream/cfn_scheduled_query.rb', line 620

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



690
691
692
693
 
# File 'timestream/cfn_scheduled_query.rb', line 690

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kms_key_id ⇒ String?

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

Returns:

  • (String, nil) 


357
358
359
 
# File 'timestream/cfn_scheduled_query.rb', line 357

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



361
362
363
364
 
# File 'timestream/cfn_scheduled_query.rb', line 361

def kms_key_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil?
  jsii_set_property("kmsKeyId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


125
126
127
 
# File 'timestream/cfn_scheduled_query.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'timestream/cfn_scheduled_query.rb', line 108

def node()
  jsii_get_property("node")
end

#notification_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Timestream::CfnScheduledQuery::NotificationConfigurationProperty

Notification configuration for the scheduled query.

Returns:



295
296
297
 
# File 'timestream/cfn_scheduled_query.rb', line 295

def notification_configuration()
  jsii_get_property("notificationConfiguration")
end

#notification_configuration=(value) ⇒ Object 



299
300
301
302
303
 
# File 'timestream/cfn_scheduled_query.rb', line 299

def notification_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnScheduledQuery::NotificationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmblNjaGVkdWxlZFF1ZXJ5Lk5vdGlmaWNhdGlvbkNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "notificationConfiguration")
  jsii_set_property("notificationConfiguration", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



631
632
633
 
# File 'timestream/cfn_scheduled_query.rb', line 631

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



638
639
640
 
# File 'timestream/cfn_scheduled_query.rb', line 638

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



431
432
433
434
 
# File 'timestream/cfn_scheduled_query.rb', line 431

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#query_string ⇒ String

The query string to run.

Returns:

  • (String) 


308
309
310
 
# File 'timestream/cfn_scheduled_query.rb', line 308

def query_string()
  jsii_get_property("queryString")
end

#query_string=(value) ⇒ Object 



312
313
314
315
 
# File 'timestream/cfn_scheduled_query.rb', line 312

def query_string=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "queryString")
  jsii_set_property("queryString", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


144
145
146
 
# File 'timestream/cfn_scheduled_query.rb', line 144

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



649
650
651
652
 
# File 'timestream/cfn_scheduled_query.rb', line 649

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


656
657
658
659
 
# File 'timestream/cfn_scheduled_query.rb', line 656

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



666
667
668
669
670
 
# File 'timestream/cfn_scheduled_query.rb', line 666

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#schedule_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Timestream::CfnScheduledQuery::ScheduleConfigurationProperty

Schedule configuration.

Returns:



320
321
322
 
# File 'timestream/cfn_scheduled_query.rb', line 320

def schedule_configuration()
  jsii_get_property("scheduleConfiguration")
end

#schedule_configuration=(value) ⇒ Object 



324
325
326
327
328
 
# File 'timestream/cfn_scheduled_query.rb', line 324

def schedule_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnScheduledQuery::ScheduleConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmblNjaGVkdWxlZFF1ZXJ5LlNjaGVkdWxlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "scheduleConfiguration")
  jsii_set_property("scheduleConfiguration", value)
end

#scheduled_query_execution_role_arn ⇒ String

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

Returns:

  • (String) 


333
334
335
 
# File 'timestream/cfn_scheduled_query.rb', line 333

def scheduled_query_execution_role_arn()
  jsii_get_property("scheduledQueryExecutionRoleArn")
end

#scheduled_query_execution_role_arn=(value) ⇒ Object 



337
338
339
340
 
# File 'timestream/cfn_scheduled_query.rb', line 337

def scheduled_query_execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduledQueryExecutionRoleArn")
  jsii_set_property("scheduledQueryExecutionRoleArn", value)
end

#scheduled_query_name ⇒ String?

A name for the query.

Returns:

  • (String, nil) 


369
370
371
 
# File 'timestream/cfn_scheduled_query.rb', line 369

def scheduled_query_name()
  jsii_get_property("scheduledQueryName")
end

#scheduled_query_name=(value) ⇒ Object 



373
374
375
376
 
# File 'timestream/cfn_scheduled_query.rb', line 373

def scheduled_query_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scheduledQueryName") unless value.nil?
  jsii_set_property("scheduledQueryName", value)
end

#scheduled_query_ref ⇒ AWSCDK::Interfaces::AWSTimestream::ScheduledQueryReference

A reference to a ScheduledQuery resource.

Returns:



268
269
270
 
# File 'timestream/cfn_scheduled_query.rb', line 268

def scheduled_query_ref()
  jsii_get_property("scheduledQueryRef")
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



675
676
677
 
# File 'timestream/cfn_scheduled_query.rb', line 675

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



134
135
136
 
# File 'timestream/cfn_scheduled_query.rb', line 134

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



275
276
277
 
# File 'timestream/cfn_scheduled_query.rb', line 275

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



381
382
383
 
# File 'timestream/cfn_scheduled_query.rb', line 381

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



385
386
387
388
389
 
# File 'timestream/cfn_scheduled_query.rb', line 385

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#target_configuration ⇒ AWSCDK::IResolvable, ...

Scheduled query target store configuration.

Returns:



394
395
396
 
# File 'timestream/cfn_scheduled_query.rb', line 394

def target_configuration()
  jsii_get_property("targetConfiguration")
end

#target_configuration=(value) ⇒ Object 



398
399
400
401
402
 
# File 'timestream/cfn_scheduled_query.rb', line 398

def target_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnScheduledQuery::TargetConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmblNjaGVkdWxlZFF1ZXJ5LlRhcmdldENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "targetConfiguration") unless value.nil?
  jsii_set_property("targetConfiguration", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



407
408
409
 
# File 'timestream/cfn_scheduled_query.rb', line 407

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


181
182
183
 
# File 'timestream/cfn_scheduled_query.rb', line 181

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


191
192
193
 
# File 'timestream/cfn_scheduled_query.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


681
682
683
684
 
# File 'timestream/cfn_scheduled_query.rb', line 681

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


420
421
422
423
424
425
 
# File 'timestream/cfn_scheduled_query.rb', line 420

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end