Class: AWSCDK::SecurityHub::CfnAutomationRuleV2

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSSecurityhub::IAutomationRuleV2Ref
Defined in:
security_hub/cfn_automation_rule_v2.rb

Overview

Creates a V2 automation rule.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAutomationRuleV2

Create a new AWS::SecurityHub::AutomationRuleV2.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::SecurityHub::CfnAutomationRuleV2Props) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnAutomationRuleV2Props.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjdXJpdHlodWIuQ2ZuQXV0b21hdGlvblJ1bGVWMlByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


181
182
183
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 181

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

.is_cfn_automation_rule_v2(x) ⇒ Boolean

Checks whether the given object is a CfnAutomationRuleV2.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


83
84
85
86
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 83

def self.is_cfn_automation_rule_v2(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_securityhub.CfnAutomationRuleV2", "isCfnAutomationRuleV2", [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
 
# File 'security_hub/cfn_automation_rule_v2.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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_rule_arn => { kind: :property, name: "attrRuleArn", is_optional: false },
    :attr_rule_id => { kind: :property, name: "attrRuleId", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :automation_rule_v2_ref => { kind: :property, name: "automationRuleV2Ref", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :actions => { kind: :property, name: "actions", is_optional: false },
    :criteria => { kind: :property, name: "criteria", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :rule_name => { kind: :property, name: "ruleName", is_optional: false },
    :rule_order => { kind: :property, name: "ruleOrder", is_optional: false },
    :rule_status => { kind: :property, name: "ruleStatus", is_optional: true },
    :tags => { kind: :property, name: "tags", 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

#actions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnAutomationRuleV2::AutomationRulesActionV2Property>

A list of actions to be performed when the rule criteria is met.

Returns:



230
231
232
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 230

def actions()
  jsii_get_property("actions")
end

#actions=(value) ⇒ Object 



234
235
236
237
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 234

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

#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.



348
349
350
351
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 348

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:



360
361
362
363
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 360

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:



370
371
372
373
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 370

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:



381
382
383
384
385
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 381

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.


438
439
440
441
442
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 438

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.



448
449
450
451
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 448

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.



460
461
462
463
464
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 460

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:



473
474
475
476
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 473

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:



495
496
497
498
499
500
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 495

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

The timestamp when the V2 automation rule was created.

Returns:

  • (String) 


188
189
190
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 188

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_rule_arn ⇒ String

The ARN of the V2 automation rule.

Returns:

  • (String) 


195
196
197
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 195

def attr_rule_arn()
  jsii_get_property("attrRuleArn")
end

#attr_rule_id ⇒ String

The ID of the V2 automation rule.

Returns:

  • (String) 


202
203
204
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 202

def attr_rule_id()
  jsii_get_property("attrRuleId")
end

#attr_updated_at ⇒ String

The timestamp when the V2 automation rule was updated.

Returns:

  • (String) 


209
210
211
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 209

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#automation_rule_v2_ref ⇒ AWSCDK::Interfaces::AWSSecurityhub::AutomationRuleV2Reference

A reference to a AutomationRuleV2 resource.

Returns:



216
217
218
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 216

def automation_rule_v2_ref()
  jsii_get_property("automationRuleV2Ref")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



223
224
225
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 223

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



134
135
136
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 134

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


139
140
141
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 139

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


504
505
506
507
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 504

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


144
145
146
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 144

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


151
152
153
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 151

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


96
97
98
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 96

def creation_stack()
  jsii_get_property("creationStack")
end

#criteria ⇒ AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnAutomationRuleV2::CriteriaProperty

The filtering type and configuration of the automation rule.

Returns:



242
243
244
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 242

def criteria()
  jsii_get_property("criteria")
end

#criteria=(value) ⇒ Object 



246
247
248
249
250
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 246

def criteria=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnAutomationRuleV2::CriteriaProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZWN1cml0eWh1Yi5DZm5BdXRvbWF0aW9uUnVsZVYyLkNyaXRlcmlhUHJvcGVydHkifV19fQ==")), "criteria")
  jsii_set_property("criteria", value)
end

#description ⇒ String

A description of the V2 automation rule.

Returns:

  • (String) 


255
256
257
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 255

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



259
260
261
262
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 259

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



156
157
158
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 156

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



517
518
519
520
521
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 517

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:



528
529
530
531
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 528

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:



598
599
600
601
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 598

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


108
109
110
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 108

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


91
92
93
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 91

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:



539
540
541
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 539

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:



546
547
548
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 546

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.



339
340
341
342
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 339

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

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


127
128
129
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 127

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:



557
558
559
560
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 557

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


564
565
566
567
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 564

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:



574
575
576
577
578
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 574

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

#rule_name ⇒ String

The name of the V2 automation rule.

Returns:

  • (String) 


267
268
269
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 267

def rule_name()
  jsii_get_property("ruleName")
end

#rule_name=(value) ⇒ Object 



271
272
273
274
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 271

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

#rule_order ⇒ Numeric

The value for the rule priority.

Returns:

  • (Numeric) 


279
280
281
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 279

def rule_order()
  jsii_get_property("ruleOrder")
end

#rule_order=(value) ⇒ Object 



283
284
285
286
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 283

def rule_order=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ruleOrder")
  jsii_set_property("ruleOrder", value)
end

#rule_status ⇒ String?

The status of the V2 automation rule.

Returns:

  • (String, nil) 


291
292
293
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 291

def rule_status()
  jsii_get_property("ruleStatus")
end

#rule_status=(value) ⇒ Object 



295
296
297
298
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 295

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



583
584
585
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 583

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:



117
118
119
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 117

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

A list of key-value pairs associated with the V2 automation rule.

Returns:

  • (Hash{String => String}, nil) 


303
304
305
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 303

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



307
308
309
310
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 307

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



315
316
317
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 315

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


164
165
166
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 164

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


174
175
176
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 174

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


589
590
591
592
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 589

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) 


328
329
330
331
332
333
 
# File 'security_hub/cfn_automation_rule_v2.rb', line 328

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