Class: AWSCDK::CloudFormation::CfnGuardHook

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSCloudformation::IGuardHookRef
Defined in:
cloud_formation/cfn_guard_hook.rb

Overview

The AWS::CloudFormation::GuardHook resource creates and activates a Guard Hook.

Using the Guard domain specific language (DSL), you can author Guard Hooks to evaluate your resources before allowing stack operations.

For more information, see Guard Hooks in the CloudFormation Hooks User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGuardHook

Create a new AWS::CloudFormation::GuardHook.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::CloudFormation::CfnGuardHookProps) —

    Resource properties.



21
22
23
24
25
26
27
 
# File 'cloud_formation/cfn_guard_hook.rb', line 21

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


183
184
185
 
# File 'cloud_formation/cfn_guard_hook.rb', line 183

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

.is_cfn_guard_hook(x) ⇒ Boolean

Checks whether the given object is a CfnGuardHook.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


85
86
87
88
 
# File 'cloud_formation/cfn_guard_hook.rb', line 85

def self.is_cfn_guard_hook(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudformation.CfnGuardHook", "isCfnGuardHook", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'cloud_formation/cfn_guard_hook.rb', line 29

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_hook_arn => { kind: :property, name: "attrHookArn", is_optional: false },
    :guard_hook_ref => { kind: :property, name: "guardHookRef", is_optional: false },
    :_alias => { kind: :property, name: "alias", is_optional: false },
    :execution_role => { kind: :property, name: "executionRole", is_optional: false },
    :failure_mode => { kind: :property, name: "failureMode", is_optional: false },
    :hook_status => { kind: :property, name: "hookStatus", is_optional: false },
    :rule_location => { kind: :property, name: "ruleLocation", is_optional: false },
    :target_operations => { kind: :property, name: "targetOperations", is_optional: false },
    :log_bucket => { kind: :property, name: "logBucket", is_optional: true },
    :options => { kind: :property, name: "options", is_optional: true },
    :stack_filters => { kind: :property, name: "stackFilters", is_optional: true },
    :target_filters => { kind: :property, name: "targetFilters", 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

#_alias ⇒ String

The type name alias for the Hook.

This alias must be unique per account and Region.

Returns:

  • (String) 


206
207
208
 
# File 'cloud_formation/cfn_guard_hook.rb', line 206

def _alias()
  jsii_get_property("alias")
end

#_alias=(value) ⇒ Object 



210
211
212
213
 
# File 'cloud_formation/cfn_guard_hook.rb', line 210

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



363
364
365
366
 
# File 'cloud_formation/cfn_guard_hook.rb', line 363

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:



375
376
377
378
 
# File 'cloud_formation/cfn_guard_hook.rb', line 375

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:



385
386
387
388
 
# File 'cloud_formation/cfn_guard_hook.rb', line 385

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:



396
397
398
399
400
 
# File 'cloud_formation/cfn_guard_hook.rb', line 396

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.


453
454
455
456
457
 
# File 'cloud_formation/cfn_guard_hook.rb', line 453

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.



463
464
465
466
 
# File 'cloud_formation/cfn_guard_hook.rb', line 463

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.



475
476
477
478
479
 
# File 'cloud_formation/cfn_guard_hook.rb', line 475

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:



488
489
490
491
 
# File 'cloud_formation/cfn_guard_hook.rb', line 488

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:



510
511
512
513
514
515
 
# File 'cloud_formation/cfn_guard_hook.rb', line 510

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

Returns the ARN of a Guard Hook.

Returns:

  • (String) 


190
191
192
 
# File 'cloud_formation/cfn_guard_hook.rb', line 190

def attr_hook_arn()
  jsii_get_property("attrHookArn")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



136
137
138
 
# File 'cloud_formation/cfn_guard_hook.rb', line 136

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


141
142
143
 
# File 'cloud_formation/cfn_guard_hook.rb', line 141

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


519
520
521
522
 
# File 'cloud_formation/cfn_guard_hook.rb', line 519

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


146
147
148
 
# File 'cloud_formation/cfn_guard_hook.rb', line 146

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


153
154
155
 
# File 'cloud_formation/cfn_guard_hook.rb', line 153

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


98
99
100
 
# File 'cloud_formation/cfn_guard_hook.rb', line 98

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



158
159
160
 
# File 'cloud_formation/cfn_guard_hook.rb', line 158

def env()
  jsii_get_property("env")
end

#execution_role ⇒ String

The IAM role that the Hook assumes to retrieve your Guard rules from S3 and optionally write a detailed Guard output report back.

Returns:

  • (String) 


218
219
220
 
# File 'cloud_formation/cfn_guard_hook.rb', line 218

def execution_role()
  jsii_get_property("executionRole")
end

#execution_role=(value) ⇒ Object 



222
223
224
225
 
# File 'cloud_formation/cfn_guard_hook.rb', line 222

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

#failure_mode ⇒ String

Specifies how the Hook responds when rules fail their evaluation.

Returns:

  • (String) 


230
231
232
 
# File 'cloud_formation/cfn_guard_hook.rb', line 230

def failure_mode()
  jsii_get_property("failureMode")
end

#failure_mode=(value) ⇒ Object 



234
235
236
237
 
# File 'cloud_formation/cfn_guard_hook.rb', line 234

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



532
533
534
535
536
 
# File 'cloud_formation/cfn_guard_hook.rb', line 532

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:



543
544
545
546
 
# File 'cloud_formation/cfn_guard_hook.rb', line 543

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#guard_hook_ref ⇒ AWSCDK::Interfaces::AWSCloudformation::GuardHookReference

A reference to a GuardHook resource.

Returns:



197
198
199
 
# File 'cloud_formation/cfn_guard_hook.rb', line 197

def guard_hook_ref()
  jsii_get_property("guardHookRef")
end

#hook_status ⇒ String

Specifies if the Hook is ENABLED or DISABLED .

Returns:

  • (String) 


242
243
244
 
# File 'cloud_formation/cfn_guard_hook.rb', line 242

def hook_status()
  jsii_get_property("hookStatus")
end

#hook_status=(value) ⇒ Object 



246
247
248
249
 
# File 'cloud_formation/cfn_guard_hook.rb', line 246

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



613
614
615
616
 
# File 'cloud_formation/cfn_guard_hook.rb', line 613

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

#log_bucket ⇒ String?

Specifies the name of an S3 bucket to store the Guard output report.

Returns:

  • (String, nil) 


279
280
281
 
# File 'cloud_formation/cfn_guard_hook.rb', line 279

def log_bucket()
  jsii_get_property("logBucket")
end

#log_bucket=(value) ⇒ Object 



283
284
285
286
 
# File 'cloud_formation/cfn_guard_hook.rb', line 283

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


110
111
112
 
# File 'cloud_formation/cfn_guard_hook.rb', line 110

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


93
94
95
 
# File 'cloud_formation/cfn_guard_hook.rb', line 93

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:



554
555
556
 
# File 'cloud_formation/cfn_guard_hook.rb', line 554

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:



561
562
563
 
# File 'cloud_formation/cfn_guard_hook.rb', line 561

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#options ⇒ AWSCDK::IResolvable, ...

Specifies the S3 location of your input parameters.

Returns:



291
292
293
 
# File 'cloud_formation/cfn_guard_hook.rb', line 291

def options()
  jsii_get_property("options")
end

#options=(value) ⇒ Object 



295
296
297
298
299
 
# File 'cloud_formation/cfn_guard_hook.rb', line 295

def options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFormation::CfnGuardHook::OptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZvcm1hdGlvbi5DZm5HdWFyZEhvb2suT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "options") unless value.nil?
  jsii_set_property("options", value)
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.



354
355
356
357
 
# File 'cloud_formation/cfn_guard_hook.rb', line 354

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) 


129
130
131
 
# File 'cloud_formation/cfn_guard_hook.rb', line 129

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:



572
573
574
575
 
# File 'cloud_formation/cfn_guard_hook.rb', line 572

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


579
580
581
582
 
# File 'cloud_formation/cfn_guard_hook.rb', line 579

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:



589
590
591
592
593
 
# File 'cloud_formation/cfn_guard_hook.rb', line 589

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_location ⇒ AWSCDK::IResolvable, AWSCDK::CloudFormation::CfnGuardHook::S3LocationProperty

Specifies the S3 location of your Guard rules.

Returns:



254
255
256
 
# File 'cloud_formation/cfn_guard_hook.rb', line 254

def rule_location()
  jsii_get_property("ruleLocation")
end

#rule_location=(value) ⇒ Object 



258
259
260
261
262
 
# File 'cloud_formation/cfn_guard_hook.rb', line 258

def rule_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFormation::CfnGuardHook::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZvcm1hdGlvbi5DZm5HdWFyZEhvb2suUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "ruleLocation")
  jsii_set_property("ruleLocation", 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.



598
599
600
 
# File 'cloud_formation/cfn_guard_hook.rb', line 598

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:



119
120
121
 
# File 'cloud_formation/cfn_guard_hook.rb', line 119

def stack()
  jsii_get_property("stack")
end

#stack_filters ⇒ AWSCDK::IResolvable, ...

Specifies the stack level filters for the Hook.

Returns:



304
305
306
 
# File 'cloud_formation/cfn_guard_hook.rb', line 304

def stack_filters()
  jsii_get_property("stackFilters")
end

#stack_filters=(value) ⇒ Object 



308
309
310
311
312
 
# File 'cloud_formation/cfn_guard_hook.rb', line 308

def stack_filters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFormation::CfnGuardHook::StackFiltersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZvcm1hdGlvbi5DZm5HdWFyZEhvb2suU3RhY2tGaWx0ZXJzUHJvcGVydHkifV19fQ==")), "stackFilters") unless value.nil?
  jsii_set_property("stackFilters", value)
end

#target_filters ⇒ AWSCDK::IResolvable, ...

Specifies the target filters for the Hook.

Returns:



317
318
319
 
# File 'cloud_formation/cfn_guard_hook.rb', line 317

def target_filters()
  jsii_get_property("targetFilters")
end

#target_filters=(value) ⇒ Object 



321
322
323
324
325
 
# File 'cloud_formation/cfn_guard_hook.rb', line 321

def target_filters=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFormation::CfnGuardHook::TargetFiltersProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZvcm1hdGlvbi5DZm5HdWFyZEhvb2suVGFyZ2V0RmlsdGVyc1Byb3BlcnR5In1dfX0=")), "targetFilters") unless value.nil?
  jsii_set_property("targetFilters", value)
end

#target_operations ⇒ Array<String>

Specifies the list of operations the Hook is run against.

Returns:

  • (Array<String>) 


267
268
269
 
# File 'cloud_formation/cfn_guard_hook.rb', line 267

def target_operations()
  jsii_get_property("targetOperations")
end

#target_operations=(value) ⇒ Object 



271
272
273
274
 
# File 'cloud_formation/cfn_guard_hook.rb', line 271

def target_operations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "targetOperations")
  jsii_set_property("targetOperations", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



330
331
332
 
# File 'cloud_formation/cfn_guard_hook.rb', line 330

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


166
167
168
 
# File 'cloud_formation/cfn_guard_hook.rb', line 166

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


176
177
178
 
# File 'cloud_formation/cfn_guard_hook.rb', line 176

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


604
605
606
607
 
# File 'cloud_formation/cfn_guard_hook.rb', line 604

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) 


343
344
345
346
347
348
 
# File 'cloud_formation/cfn_guard_hook.rb', line 343

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