Module: AWSCDK::Config::IRule

Includes:
IResource, Interfaces::AWSConfig::IConfigRuleRef
Included in:
CustomPolicy, CustomRule, ManagedRule
Defined in:
config/i_rule.rb

Overview

Interface representing an AWS Config rule.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'config/i_rule.rb', line 122

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :config_rule_ref => { kind: :property, name: "configRuleRef", is_optional: false },
    :config_rule_name => { kind: :property, name: "configRuleName", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :on_compliance_change => { kind: :method, name: "onComplianceChange", is_optional: false },
    :on_event => { kind: :method, name: "onEvent", is_optional: false },
    :on_re_evaluation_status => { kind: :method, name: "onReEvaluationStatus", is_optional: false },
  }
end

Instance Method Details

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



78
79
80
81
 
# File 'config/i_rule.rb', line 78

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#config_rule_name ⇒ String

The name of the rule.

Returns:

  • (String) 


48
49
50
 
# File 'config/i_rule.rb', line 48

def config_rule_name()
  jsii_get_property("configRuleName")
end

#config_rule_ref ⇒ AWSCDK::Interfaces::AWSConfig::ConfigRuleReference

A reference to a ConfigRule resource.

Returns:



41
42
43
 
# File 'config/i_rule.rb', line 41

def config_rule_ref()
  jsii_get_property("configRuleRef")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'config/i_rule.rb', line 27

def env()
  jsii_get_property("env")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'config/i_rule.rb', line 12

def node()
  jsii_get_property("node")
end

#on_compliance_change(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines a EventBridge event rule which triggers for rule compliance events.

Parameters:

Returns:



88
89
90
91
92
93
 
# File 'config/i_rule.rb', line 88

def on_compliance_change(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onComplianceChange", [id, options])
end

#on_event(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines an EventBridge event rule which triggers for rule events.

Use rule.addEventPattern(pattern) to specify a filter.

Parameters:

Returns:



103
104
105
106
107
108
 
# File 'config/i_rule.rb', line 103

def on_event(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onEvent", [id, options])
end

#on_re_evaluation_status(id, options = nil) ⇒ AWSCDK::Events::Rule

Defines a EventBridge event rule which triggers for rule re-evaluation status events.

Parameters:

Returns:



115
116
117
118
119
120
 
# File 'config/i_rule.rb', line 115

def on_re_evaluation_status(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Events::OnEventOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZXZlbnRzLk9uRXZlbnRPcHRpb25zIn0=")), "options") unless options.nil?
  jsii_call_method("onReEvaluationStatus", [id, options])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'config/i_rule.rb', line 34

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



59
60
61
62
63
64
 
# File 'config/i_rule.rb', line 59

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