Class: AWSCDK::Route53RecoveryControl::CfnSafetyRule

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSRoute53Recoverycontrol::ISafetyRuleRef
Defined in:
route53_recovery_control/cfn_safety_rule.rb

Overview

Creates a safety rule in a control panel in Amazon Route 53 Application Recovery Controller.

Safety rules in Amazon Route 53 Application Recovery Controller let you add safeguards around changing routing control states, and enabling and disabling routing controls, to help prevent unwanted outcomes. Note that the name of a safety rule must be unique within a control panel.

There are two types of safety rules in Route 53 ARC: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, certain criteria are met. For example, the criteria might be that at least one routing control state is On after the transaction completes so that traffic continues to be directed to at least one cell for the application. This prevents a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall on-off switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example, by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSafetyRule

Create a new AWS::Route53RecoveryControl::SafetyRule.

Parameters:



28
29
30
31
32
33
34
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 28

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

Class Method Details

.arn_for_safety_rule(resource) ⇒ String

Parameters:

Returns:

  • (String) 


88
89
90
91
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 88

def self.arn_for_safety_rule(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19yb3V0ZTUzcmVjb3Zlcnljb250cm9sLklTYWZldHlSdWxlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53recoverycontrol.CfnSafetyRule", "arnForSafetyRule", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 195

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

.is_cfn_safety_rule(x) ⇒ Boolean

Checks whether the given object is a CfnSafetyRule.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 97

def self.is_cfn_safety_rule(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_route53recoverycontrol.CfnSafetyRule", "isCfnSafetyRule", [x])
end

.jsii_overridable_methods ⇒ Object 



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
80
81
82
83
84
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 36

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_safety_rule_arn => { kind: :property, name: "attrSafetyRuleArn", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :safety_rule_ref => { kind: :property, name: "safetyRuleRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :control_panel_arn => { kind: :property, name: "controlPanelArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :rule_config => { kind: :property, name: "ruleConfig", is_optional: false },
    :assertion_rule => { kind: :property, name: "assertionRule", is_optional: true },
    :gating_rule => { kind: :property, name: "gatingRule", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



341
342
343
344
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 341

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:



353
354
355
356
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 353

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:



363
364
365
366
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 363

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:



374
375
376
377
378
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 374

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.


431
432
433
434
435
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 431

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.



441
442
443
444
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 441

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.



453
454
455
456
457
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 453

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:



466
467
468
469
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 466

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:



488
489
490
491
492
493
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 488

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

#assertion_rule ⇒ AWSCDK::IResolvable, ...

An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met.

Returns:



269
270
271
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 269

def assertion_rule()
  jsii_get_property("assertionRule")
end

#assertion_rule=(value) ⇒ Object 



273
274
275
276
277
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 273

def assertion_rule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53RecoveryControl::CfnSafetyRule::AssertionRuleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzcmVjb3Zlcnljb250cm9sLkNmblNhZmV0eVJ1bGUuQXNzZXJ0aW9uUnVsZVByb3BlcnR5In1dfX0=")), "assertionRule") unless value.nil?
  jsii_set_property("assertionRule", value)
end

#attr_safety_rule_arn ⇒ String

The Amazon Resource Name (ARN) of the safety rule.

Returns:

  • (String) 


202
203
204
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 202

def attr_safety_rule_arn()
  jsii_get_property("attrSafetyRuleArn")
end

#attr_status ⇒ String

The deployment status of the safety rule.

Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

Returns:

  • (String) 


211
212
213
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 211

def attr_status()
  jsii_get_property("attrStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



148
149
150
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


497
498
499
500
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 497

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


158
159
160
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#control_panel_arn ⇒ String

The Amazon Resource Name (ARN) of the control panel.

Returns:

  • (String) 


232
233
234
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 232

def control_panel_arn()
  jsii_get_property("controlPanelArn")
end

#control_panel_arn=(value) ⇒ Object 



236
237
238
239
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 236

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 170

def env()
  jsii_get_property("env")
end

#gating_rule ⇒ AWSCDK::IResolvable, ...

A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.

Returns:



282
283
284
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 282

def gating_rule()
  jsii_get_property("gatingRule")
end

#gating_rule=(value) ⇒ Object 



286
287
288
289
290
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 286

def gating_rule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53RecoveryControl::CfnSafetyRule::GatingRuleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzcmVjb3Zlcnljb250cm9sLkNmblNhZmV0eVJ1bGUuR2F0aW5nUnVsZVByb3BlcnR5In1dfX0=")), "gatingRule") unless value.nil?
  jsii_set_property("gatingRule", 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:



510
511
512
513
514
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 510

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:



521
522
523
524
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 521

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:



591
592
593
594
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 591

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) 


122
123
124
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the assertion rule.

Returns:

  • (String) 


244
245
246
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 244

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



248
249
250
251
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 248

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 105

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:



532
533
534
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 532

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:



539
540
541
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 539

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.



332
333
334
335
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 332

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) 


141
142
143
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 141

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:



550
551
552
553
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 550

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


557
558
559
560
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 557

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:



567
568
569
570
571
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 567

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_config ⇒ AWSCDK::IResolvable, AWSCDK::Route53RecoveryControl::CfnSafetyRule::RuleConfigProperty

The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction.

Returns:



256
257
258
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 256

def rule_config()
  jsii_get_property("ruleConfig")
end

#rule_config=(value) ⇒ Object 



260
261
262
263
264
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 260

def rule_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Route53RecoveryControl::CfnSafetyRule::RuleConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19yb3V0ZTUzcmVjb3Zlcnljb250cm9sLkNmblNhZmV0eVJ1bGUuUnVsZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "ruleConfig")
  jsii_set_property("ruleConfig", value)
end

#safety_rule_ref ⇒ AWSCDK::Interfaces::AWSRoute53Recoverycontrol::SafetyRuleReference

A reference to a SafetyRule resource.

Returns:



218
219
220
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 218

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



576
577
578
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 576

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:



131
132
133
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 131

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



225
226
227
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 225

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags associated with the safety rule.

Returns:



295
296
297
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 295

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



299
300
301
302
303
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 299

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



308
309
310
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 308

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


178
179
180
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 178

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


188
189
190
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


582
583
584
585
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 582

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) 


321
322
323
324
325
326
 
# File 'route53_recovery_control/cfn_safety_rule.rb', line 321

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