Class: AWSCDK::Config::CfnRemediationConfiguration

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSConfig::IRemediationConfigurationRef
Defined in:
config/cfn_remediation_configuration.rb

Overview

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRemediationConfiguration

Create a new AWS::Config::RemediationConfiguration.

Parameters:



17
18
19
20
21
22
23
 
# File 'config/cfn_remediation_configuration.rb', line 17

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

Class Method Details

.arn_for_remediation_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_remediation_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25maWcuSVJlbWVkaWF0aW9uQ29uZmlndXJhdGlvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_config.CfnRemediationConfiguration", "arnForRemediationConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'config/cfn_remediation_configuration.rb', line 199

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

.from_remediation_configuration_id(scope, id, remediation_configuration_id) ⇒ AWSCDK::Interfaces::AWSConfig::IRemediationConfigurationRef

Creates a new IRemediationConfigurationRef from a remediationConfigurationId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • remediation_configuration_id (String)

Returns:



90
91
92
93
94
95
 
# File 'config/cfn_remediation_configuration.rb', line 90

def self.from_remediation_configuration_id(scope, id, remediation_configuration_id)
  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(remediation_configuration_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "remediationConfigurationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_config.CfnRemediationConfiguration", "fromRemediationConfigurationId", [scope, id, remediation_configuration_id])
end

.is_cfn_remediation_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnRemediationConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_remediation_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_config.CfnRemediationConfiguration", "isCfnRemediationConfiguration", [x])
end

.jsii_overridable_methods ⇒ Object 



25
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
 
# File 'config/cfn_remediation_configuration.rb', line 25

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_id => { kind: :property, name: "attrId", is_optional: false },
    :remediation_configuration_ref => { kind: :property, name: "remediationConfigurationRef", is_optional: false },
    :config_rule_name => { kind: :property, name: "configRuleName", is_optional: false },
    :parameters => { kind: :property, name: "parameters", is_optional: false },
    :target_id => { kind: :property, name: "targetId", is_optional: false },
    :target_type => { kind: :property, name: "targetType", is_optional: false },
    :automatic => { kind: :property, name: "automatic", is_optional: true },
    :execution_controls => { kind: :property, name: "executionControls", is_optional: true },
    :maximum_automatic_attempts => { kind: :property, name: "maximumAutomaticAttempts", is_optional: true },
    :resource_type => { kind: :property, name: "resourceType", is_optional: true },
    :retry_attempt_seconds => { kind: :property, name: "retryAttemptSeconds", is_optional: true },
    :target_version => { kind: :property, name: "targetVersion", 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.



378
379
380
381
 
# File 'config/cfn_remediation_configuration.rb', line 378

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:



390
391
392
393
 
# File 'config/cfn_remediation_configuration.rb', line 390

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:



400
401
402
403
 
# File 'config/cfn_remediation_configuration.rb', line 400

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:



411
412
413
414
415
 
# File 'config/cfn_remediation_configuration.rb', line 411

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.


468
469
470
471
472
 
# File 'config/cfn_remediation_configuration.rb', line 468

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.



478
479
480
481
 
# File 'config/cfn_remediation_configuration.rb', line 478

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.



490
491
492
493
494
 
# File 'config/cfn_remediation_configuration.rb', line 490

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:



503
504
505
506
 
# File 'config/cfn_remediation_configuration.rb', line 503

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:



525
526
527
528
529
530
 
# File 'config/cfn_remediation_configuration.rb', line 525

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

Returns:

  • (String) 


204
205
206
 
# File 'config/cfn_remediation_configuration.rb', line 204

def attr_id()
  jsii_get_property("attrId")
end

#automatic ⇒ Boolean, ...

The remediation is triggered automatically.

Returns:



268
269
270
 
# File 'config/cfn_remediation_configuration.rb', line 268

def automatic()
  jsii_get_property("automatic")
end

#automatic=(value) ⇒ Object 



272
273
274
275
 
# File 'config/cfn_remediation_configuration.rb', line 272

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



152
153
154
 
# File 'config/cfn_remediation_configuration.rb', line 152

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


157
158
159
 
# File 'config/cfn_remediation_configuration.rb', line 157

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


534
535
536
537
 
# File 'config/cfn_remediation_configuration.rb', line 534

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


162
163
164
 
# File 'config/cfn_remediation_configuration.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


169
170
171
 
# File 'config/cfn_remediation_configuration.rb', line 169

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#config_rule_name ⇒ String

The name of the AWS Config rule.

Returns:

  • (String) 


218
219
220
 
# File 'config/cfn_remediation_configuration.rb', line 218

def config_rule_name()
  jsii_get_property("configRuleName")
end

#config_rule_name=(value) ⇒ Object 



222
223
224
225
 
# File 'config/cfn_remediation_configuration.rb', line 222

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'config/cfn_remediation_configuration.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'config/cfn_remediation_configuration.rb', line 174

def env()
  jsii_get_property("env")
end

#execution_controls ⇒ AWSCDK::IResolvable, ...

An ExecutionControls object.

Returns:



280
281
282
 
# File 'config/cfn_remediation_configuration.rb', line 280

def execution_controls()
  jsii_get_property("executionControls")
end

#execution_controls=(value) ⇒ Object 



284
285
286
287
288
 
# File 'config/cfn_remediation_configuration.rb', line 284

def execution_controls=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Config::CfnRemediationConfiguration::ExecutionControlsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25maWcuQ2ZuUmVtZWRpYXRpb25Db25maWd1cmF0aW9uLkV4ZWN1dGlvbkNvbnRyb2xzUHJvcGVydHkifV19fQ==")), "executionControls") unless value.nil?
  jsii_set_property("executionControls", 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:



547
548
549
550
551
 
# File 'config/cfn_remediation_configuration.rb', line 547

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:



558
559
560
561
 
# File 'config/cfn_remediation_configuration.rb', line 558

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:



628
629
630
631
 
# File 'config/cfn_remediation_configuration.rb', line 628

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) 


126
127
128
 
# File 'config/cfn_remediation_configuration.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#maximum_automatic_attempts ⇒ Numeric?

The maximum number of failed attempts for auto-remediation.

If you do not select a number, the default is 5.

Returns:

  • (Numeric, nil) 


295
296
297
 
# File 'config/cfn_remediation_configuration.rb', line 295

def maximum_automatic_attempts()
  jsii_get_property("maximumAutomaticAttempts")
end

#maximum_automatic_attempts=(value) ⇒ Object 



299
300
301
302
 
# File 'config/cfn_remediation_configuration.rb', line 299

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


109
110
111
 
# File 'config/cfn_remediation_configuration.rb', line 109

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:



569
570
571
 
# File 'config/cfn_remediation_configuration.rb', line 569

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:



576
577
578
 
# File 'config/cfn_remediation_configuration.rb', line 576

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.



369
370
371
372
 
# File 'config/cfn_remediation_configuration.rb', line 369

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

#parameters ⇒ Object

An object of the RemediationParameterValue.

For more information, see RemediationParameterValue .

Returns:

  • (Object) 


232
233
234
 
# File 'config/cfn_remediation_configuration.rb', line 232

def parameters()
  jsii_get_property("parameters")
end

#parameters=(value) ⇒ Object 



236
237
238
239
 
# File 'config/cfn_remediation_configuration.rb', line 236

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


145
146
147
 
# File 'config/cfn_remediation_configuration.rb', line 145

def ref()
  jsii_get_property("ref")
end

#remediation_configuration_ref ⇒ AWSCDK::Interfaces::AWSConfig::RemediationConfigurationReference

A reference to a RemediationConfiguration resource.

Returns:



211
212
213
 
# File 'config/cfn_remediation_configuration.rb', line 211

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



587
588
589
590
 
# File 'config/cfn_remediation_configuration.rb', line 587

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


594
595
596
597
 
# File 'config/cfn_remediation_configuration.rb', line 594

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:



604
605
606
607
608
 
# File 'config/cfn_remediation_configuration.rb', line 604

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

#resource_type ⇒ String?

The type of a resource.

Returns:

  • (String, nil) 


307
308
309
 
# File 'config/cfn_remediation_configuration.rb', line 307

def resource_type()
  jsii_get_property("resourceType")
end

#resource_type=(value) ⇒ Object 



311
312
313
314
 
# File 'config/cfn_remediation_configuration.rb', line 311

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

#retry_attempt_seconds ⇒ Numeric?

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts.

Returns:

  • (Numeric, nil) 


319
320
321
 
# File 'config/cfn_remediation_configuration.rb', line 319

def retry_attempt_seconds()
  jsii_get_property("retryAttemptSeconds")
end

#retry_attempt_seconds=(value) ⇒ Object 



323
324
325
326
 
# File 'config/cfn_remediation_configuration.rb', line 323

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



613
614
615
 
# File 'config/cfn_remediation_configuration.rb', line 613

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:



135
136
137
 
# File 'config/cfn_remediation_configuration.rb', line 135

def stack()
  jsii_get_property("stack")
end

#target_id ⇒ String

Target ID is the name of the SSM document.

Returns:

  • (String) 


244
245
246
 
# File 'config/cfn_remediation_configuration.rb', line 244

def target_id()
  jsii_get_property("targetId")
end

#target_id=(value) ⇒ Object 



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

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

#target_type ⇒ String

The type of the target.

Returns:

  • (String) 


256
257
258
 
# File 'config/cfn_remediation_configuration.rb', line 256

def target_type()
  jsii_get_property("targetType")
end

#target_type=(value) ⇒ Object 



260
261
262
263
 
# File 'config/cfn_remediation_configuration.rb', line 260

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

#target_version ⇒ String?

Version of the target.

For example, version of the SSM document.

Returns:

  • (String, nil) 


333
334
335
 
# File 'config/cfn_remediation_configuration.rb', line 333

def target_version()
  jsii_get_property("targetVersion")
end

#target_version=(value) ⇒ Object 



337
338
339
340
 
# File 'config/cfn_remediation_configuration.rb', line 337

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



345
346
347
 
# File 'config/cfn_remediation_configuration.rb', line 345

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


182
183
184
 
# File 'config/cfn_remediation_configuration.rb', line 182

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


192
193
194
 
# File 'config/cfn_remediation_configuration.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


619
620
621
622
 
# File 'config/cfn_remediation_configuration.rb', line 619

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) 


358
359
360
361
362
363
 
# File 'config/cfn_remediation_configuration.rb', line 358

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