Class: AWSCDK::Config::CloudFormationStackDriftDetectionCheck

Inherits:
ManagedRule
  • Object
show all
Defined in:
config/cloud_formation_stack_drift_detection_check.rb

Overview

Checks whether your CloudFormation stacks' actual configuration differs, or has drifted, from its expected configuration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CloudFormationStackDriftDetectionCheck

Returns a new instance of CloudFormationStackDriftDetectionCheck.

Parameters:



13
14
15
16
17
18
19
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 13

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Config::CloudFormationStackDriftDetectionCheckProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29uZmlnLkNsb3VkRm9ybWF0aW9uU3RhY2tEcmlmdERldGVjdGlvbkNoZWNrUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :config_rule_arn => { kind: :property, name: "configRuleArn", is_optional: false },
    :config_rule_compliance_type => { kind: :property, name: "configRuleComplianceType", is_optional: false },
    :config_rule_id => { kind: :property, name: "configRuleId", is_optional: false },
    :config_rule_name => { kind: :property, name: "configRuleName", is_optional: false },
    :config_rule_ref => { kind: :property, name: "configRuleRef", is_optional: false },
    :is_custom_with_changes => { kind: :property, name: "isCustomWithChanges", is_optional: true },
    :is_managed => { kind: :property, name: "isManaged", is_optional: true },
    :rule_scope => { kind: :property, name: "ruleScope", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", 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

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


94
95
96
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 94

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_config.CloudFormationStackDriftDetectionCheck", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



196
197
198
199
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 196

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) ⇒ 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:



213
214
215
216
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 213

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

The arn of the rule.

Returns:

  • (String) 


101
102
103
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 101

def config_rule_arn()
  jsii_get_property("configRuleArn")
end

#config_rule_compliance_type ⇒ String

The compliance status of the rule.

Returns:

  • (String) 


108
109
110
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 108

def config_rule_compliance_type()
  jsii_get_property("configRuleComplianceType")
end

#config_rule_id ⇒ String

The id of the rule.

Returns:

  • (String) 


115
116
117
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 115

def config_rule_id()
  jsii_get_property("configRuleId")
end

#config_rule_name ⇒ String

The name of the rule.

Returns:

  • (String) 


122
123
124
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 122

def config_rule_name()
  jsii_get_property("configRuleName")
end

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

A reference to a ConfigRule resource.

Returns:



129
130
131
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 129

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:



66
67
68
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 66

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


219
220
221
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 219

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


233
234
235
236
237
238
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 233

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


248
249
250
251
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 248

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#is_custom_with_changes ⇒ Boolean?

Returns:

  • (Boolean, nil) 


134
135
136
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 134

def is_custom_with_changes()
  jsii_get_property("isCustomWithChanges")
end

#is_custom_with_changes=(value) ⇒ Object 



138
139
140
141
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 138

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

#is_managed ⇒ Boolean?

Returns:

  • (Boolean, nil) 


144
145
146
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 144

def is_managed()
  jsii_get_property("isManaged")
end

#is_managed=(value) ⇒ Object 



148
149
150
151
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 148

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


51
52
53
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 51

def node()
  jsii_get_property("node")
end

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

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

Parameters:

Returns:



258
259
260
261
262
263
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 258

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:



273
274
275
276
277
278
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 273

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 an EventBridge event rule which triggers for rule re-evaluation status events.

Parameters:

Returns:



285
286
287
288
289
290
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 285

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

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


80
81
82
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 80

def physical_name()
  jsii_get_property("physicalName")
end

#rule_scope ⇒ AWSCDK::Config::RuleScope?

Returns:



154
155
156
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 154

def rule_scope()
  jsii_get_property("ruleScope")
end

#rule_scope=(value) ⇒ Object 



158
159
160
161
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 158

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

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



87
88
89
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 87

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


166
167
168
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 166

def to_string()
  jsii_call_method("toString", [])
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) 


179
180
181
182
183
184
 
# File 'config/cloud_formation_stack_drift_detection_check.rb', line 179

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