Class: AWSCDK::Logs::CfnScheduledQuery

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSLogs::IScheduledQueryRef
Defined in:
logs/cfn_scheduled_query.rb

Overview

Creates a new Scheduled Query that allows you to define a Logs Insights query that will run on a schedule and configure actions to take with the query results.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnScheduledQuery

Create a new AWS::Logs::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::Logs::CfnScheduledQueryProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'logs/cfn_scheduled_query.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Logs::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbG9ncy5DZm5TY2hlZHVsZWRRdWVyeVByb3BzIn0=")), "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) 


89
90
91
92
 
# File 'logs/cfn_scheduled_query.rb', line 89

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

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'logs/cfn_scheduled_query.rb', line 196

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_logs.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) 


98
99
100
101
 
# File 'logs/cfn_scheduled_query.rb', line 98

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_logs.CfnScheduledQuery", "isCfnScheduledQuery", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'logs/cfn_scheduled_query.rb', line 26

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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_last_execution_status => { kind: :property, name: "attrLastExecutionStatus", is_optional: false },
    :attr_last_triggered_time => { kind: :property, name: "attrLastTriggeredTime", is_optional: false },
    :attr_last_updated_time => { kind: :property, name: "attrLastUpdatedTime", is_optional: false },
    :attr_scheduled_query_arn => { kind: :property, name: "attrScheduledQueryArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :scheduled_query_ref => { kind: :property, name: "scheduledQueryRef", is_optional: false },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :query_language => { kind: :property, name: "queryLanguage", is_optional: false },
    :query_string => { kind: :property, name: "queryString", is_optional: false },
    :schedule_expression => { kind: :property, name: "scheduleExpression", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :destination_configuration => { kind: :property, name: "destinationConfiguration", is_optional: true },
    :log_group_identifiers => { kind: :property, name: "logGroupIdentifiers", is_optional: true },
    :schedule_end_time => { kind: :property, name: "scheduleEndTime", is_optional: true },
    :schedule_start_time => { kind: :property, name: "scheduleStartTime", is_optional: true },
    :start_time_offset => { kind: :property, name: "startTimeOffset", is_optional: true },
    :state => { kind: :property, name: "state", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :timezone => { kind: :property, name: "timezone", 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.



417
418
419
420
 
# File 'logs/cfn_scheduled_query.rb', line 417

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:



429
430
431
432
 
# File 'logs/cfn_scheduled_query.rb', line 429

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:



439
440
441
442
 
# File 'logs/cfn_scheduled_query.rb', line 439

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:



450
451
452
453
454
 
# File 'logs/cfn_scheduled_query.rb', line 450

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.


507
508
509
510
511
 
# File 'logs/cfn_scheduled_query.rb', line 507

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.



517
518
519
520
 
# File 'logs/cfn_scheduled_query.rb', line 517

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.



529
530
531
532
533
 
# File 'logs/cfn_scheduled_query.rb', line 529

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:



542
543
544
545
 
# File 'logs/cfn_scheduled_query.rb', line 542

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:



564
565
566
567
568
569
 
# File 'logs/cfn_scheduled_query.rb', line 564

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_creation_time ⇒ AWSCDK::IResolvable

Returns:



201
202
203
 
# File 'logs/cfn_scheduled_query.rb', line 201

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_last_execution_status ⇒ String

Returns:

  • (String) 


206
207
208
 
# File 'logs/cfn_scheduled_query.rb', line 206

def attr_last_execution_status()
  jsii_get_property("attrLastExecutionStatus")
end

#attr_last_triggered_time ⇒ AWSCDK::IResolvable

Returns:



211
212
213
 
# File 'logs/cfn_scheduled_query.rb', line 211

def attr_last_triggered_time()
  jsii_get_property("attrLastTriggeredTime")
end

#attr_last_updated_time ⇒ AWSCDK::IResolvable

Returns:



216
217
218
 
# File 'logs/cfn_scheduled_query.rb', line 216

def attr_last_updated_time()
  jsii_get_property("attrLastUpdatedTime")
end

#attr_scheduled_query_arn ⇒ String

Returns:

  • (String) 


221
222
223
 
# File 'logs/cfn_scheduled_query.rb', line 221

def attr_scheduled_query_arn()
  jsii_get_property("attrScheduledQueryArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



228
229
230
 
# File 'logs/cfn_scheduled_query.rb', line 228

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'logs/cfn_scheduled_query.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'logs/cfn_scheduled_query.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


573
574
575
576
 
# File 'logs/cfn_scheduled_query.rb', line 573

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}) 


159
160
161
 
# File 'logs/cfn_scheduled_query.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'logs/cfn_scheduled_query.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'logs/cfn_scheduled_query.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

Returns:

  • (String, nil) 


290
291
292
 
# File 'logs/cfn_scheduled_query.rb', line 290

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#destination_configuration ⇒ AWSCDK::IResolvable, ...

Returns:



300
301
302
 
# File 'logs/cfn_scheduled_query.rb', line 300

def destination_configuration()
  jsii_get_property("destinationConfiguration")
end

#destination_configuration=(value) ⇒ Object 



304
305
306
307
308
 
# File 'logs/cfn_scheduled_query.rb', line 304

def destination_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Logs::CfnScheduledQuery::DestinationConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb2dzLkNmblNjaGVkdWxlZFF1ZXJ5LkRlc3RpbmF0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "destinationConfiguration") unless value.nil?
  jsii_set_property("destinationConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'logs/cfn_scheduled_query.rb', line 171

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String

Returns:

  • (String) 


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

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



244
245
246
247
 
# File 'logs/cfn_scheduled_query.rb', line 244

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn")
  jsii_set_property("executionRoleArn", 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:



586
587
588
589
590
 
# File 'logs/cfn_scheduled_query.rb', line 586

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:



597
598
599
600
 
# File 'logs/cfn_scheduled_query.rb', line 597

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:



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

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

#log_group_identifiers ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


311
312
313
 
# File 'logs/cfn_scheduled_query.rb', line 311

def log_group_identifiers()
  jsii_get_property("logGroupIdentifiers")
end

#log_group_identifiers=(value) ⇒ Object 



315
316
317
318
 
# File 'logs/cfn_scheduled_query.rb', line 315

def log_group_identifiers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logGroupIdentifiers") unless value.nil?
  jsii_set_property("logGroupIdentifiers", 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) 


123
124
125
 
# File 'logs/cfn_scheduled_query.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'logs/cfn_scheduled_query.rb', line 250

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'logs/cfn_scheduled_query.rb', line 106

def node()
  jsii_get_property("node")
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:



608
609
610
 
# File 'logs/cfn_scheduled_query.rb', line 608

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:



615
616
617
 
# File 'logs/cfn_scheduled_query.rb', line 615

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.



408
409
410
411
 
# File 'logs/cfn_scheduled_query.rb', line 408

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_language ⇒ String

Returns:

  • (String) 


260
261
262
 
# File 'logs/cfn_scheduled_query.rb', line 260

def query_language()
  jsii_get_property("queryLanguage")
end

#query_language=(value) ⇒ Object 



264
265
266
267
 
# File 'logs/cfn_scheduled_query.rb', line 264

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

#query_string ⇒ String

Returns:

  • (String) 


270
271
272
 
# File 'logs/cfn_scheduled_query.rb', line 270

def query_string()
  jsii_get_property("queryString")
end

#query_string=(value) ⇒ Object 



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

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) 


142
143
144
 
# File 'logs/cfn_scheduled_query.rb', line 142

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:



626
627
628
629
 
# File 'logs/cfn_scheduled_query.rb', line 626

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}) 


633
634
635
636
 
# File 'logs/cfn_scheduled_query.rb', line 633

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:



643
644
645
646
647
 
# File 'logs/cfn_scheduled_query.rb', line 643

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_end_time ⇒ Numeric?

Returns:

  • (Numeric, nil) 


321
322
323
 
# File 'logs/cfn_scheduled_query.rb', line 321

def schedule_end_time()
  jsii_get_property("scheduleEndTime")
end

#schedule_end_time=(value) ⇒ Object 



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

def schedule_end_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scheduleEndTime") unless value.nil?
  jsii_set_property("scheduleEndTime", value)
end

#schedule_expression ⇒ String

Returns:

  • (String) 


280
281
282
 
# File 'logs/cfn_scheduled_query.rb', line 280

def schedule_expression()
  jsii_get_property("scheduleExpression")
end

#schedule_expression=(value) ⇒ Object 



284
285
286
287
 
# File 'logs/cfn_scheduled_query.rb', line 284

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

#schedule_start_time ⇒ Numeric?

Returns:

  • (Numeric, nil) 


331
332
333
 
# File 'logs/cfn_scheduled_query.rb', line 331

def schedule_start_time()
  jsii_get_property("scheduleStartTime")
end

#schedule_start_time=(value) ⇒ Object 



335
336
337
338
 
# File 'logs/cfn_scheduled_query.rb', line 335

def schedule_start_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "scheduleStartTime") unless value.nil?
  jsii_set_property("scheduleStartTime", value)
end

#scheduled_query_ref ⇒ AWSCDK::Interfaces::AWSLogs::ScheduledQueryReference

A reference to a ScheduledQuery resource.

Returns:



235
236
237
 
# File 'logs/cfn_scheduled_query.rb', line 235

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.



652
653
654
 
# File 'logs/cfn_scheduled_query.rb', line 652

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:



132
133
134
 
# File 'logs/cfn_scheduled_query.rb', line 132

def stack()
  jsii_get_property("stack")
end

#start_time_offset ⇒ Numeric?

Returns:

  • (Numeric, nil) 


341
342
343
 
# File 'logs/cfn_scheduled_query.rb', line 341

def start_time_offset()
  jsii_get_property("startTimeOffset")
end

#start_time_offset=(value) ⇒ Object 



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

def start_time_offset=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "startTimeOffset") unless value.nil?
  jsii_set_property("startTimeOffset", value)
end

#state ⇒ String?

Returns:

  • (String, nil) 


351
352
353
 
# File 'logs/cfn_scheduled_query.rb', line 351

def state()
  jsii_get_property("state")
end

#state=(value) ⇒ Object 



355
356
357
358
 
# File 'logs/cfn_scheduled_query.rb', line 355

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

#tags ⇒ Array<AWSCDK::Logs::CfnScheduledQuery::TagsItemsProperty>?

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



365
366
367
368
369
 
# File 'logs/cfn_scheduled_query.rb', line 365

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::Logs::CfnScheduledQuery::TagsItemsProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sb2dzLkNmblNjaGVkdWxlZFF1ZXJ5LlRhZ3NJdGVtc1Byb3BlcnR5In0sImtpbmQiOiJhcnJheSJ9fQ==")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#timezone ⇒ String?

Returns:

  • (String, nil) 


372
373
374
 
# File 'logs/cfn_scheduled_query.rb', line 372

def timezone()
  jsii_get_property("timezone")
end

#timezone=(value) ⇒ Object 



376
377
378
379
 
# File 'logs/cfn_scheduled_query.rb', line 376

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



384
385
386
 
# File 'logs/cfn_scheduled_query.rb', line 384

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}) 


179
180
181
 
# File 'logs/cfn_scheduled_query.rb', line 179

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}) 


189
190
191
 
# File 'logs/cfn_scheduled_query.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


658
659
660
661
 
# File 'logs/cfn_scheduled_query.rb', line 658

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) 


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

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