Class: AWSCDK::ARCRegionSwitch::CfnPlan

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSArcregionswitch::IPlanRef
Defined in:
arc_region_switch/cfn_plan.rb

Overview

Represents a Region switch plan.

A plan defines the steps required to shift traffic from one AWS Region to another.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPlan

Create a new AWS::ARCRegionSwitch::Plan.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::ARCRegionSwitch::CfnPlanProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'arc_region_switch/cfn_plan.rb', line 20

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

Class Method Details

.arn_for_plan(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'arc_region_switch/cfn_plan.rb', line 90

def self.arn_for_plan(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcmNyZWdpb25zd2l0Y2guSVBsYW5SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_arcregionswitch.CfnPlan", "arnForPlan", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'arc_region_switch/cfn_plan.rb', line 197

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

.is_cfn_plan(x) ⇒ Boolean

Checks whether the given object is a CfnPlan.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'arc_region_switch/cfn_plan.rb', line 99

def self.is_cfn_plan(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_arcregionswitch.CfnPlan", "isCfnPlan", [x])
end

.jsii_overridable_methods ⇒ Object 



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
76
77
78
79
80
81
82
83
84
85
86
 
# File 'arc_region_switch/cfn_plan.rb', line 28

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_health_checks_for_plan => { kind: :property, name: "attrHealthChecksForPlan", is_optional: false },
    :attr_owner => { kind: :property, name: "attrOwner", is_optional: false },
    :attr_plan_health_checks => { kind: :property, name: "attrPlanHealthChecks", is_optional: false },
    :attr_route53_health_checks => { kind: :property, name: "attrRoute53HealthChecks", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :plan_ref => { kind: :property, name: "planRef", is_optional: false },
    :execution_role => { kind: :property, name: "executionRole", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :recovery_approach => { kind: :property, name: "recoveryApproach", is_optional: false },
    :regions => { kind: :property, name: "regions", is_optional: false },
    :workflows => { kind: :property, name: "workflows", is_optional: false },
    :associated_alarms => { kind: :property, name: "associatedAlarms", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :primary_region => { kind: :property, name: "primaryRegion", is_optional: true },
    :recovery_time_objective_minutes => { kind: :property, name: "recoveryTimeObjectiveMinutes", is_optional: true },
    :report_configuration => { kind: :property, name: "reportConfiguration", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :triggers => { kind: :property, name: "triggers", 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.



430
431
432
433
 
# File 'arc_region_switch/cfn_plan.rb', line 430

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:



442
443
444
445
 
# File 'arc_region_switch/cfn_plan.rb', line 442

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:



452
453
454
455
 
# File 'arc_region_switch/cfn_plan.rb', line 452

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:



463
464
465
466
467
 
# File 'arc_region_switch/cfn_plan.rb', line 463

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.


520
521
522
523
524
 
# File 'arc_region_switch/cfn_plan.rb', line 520

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.



530
531
532
533
 
# File 'arc_region_switch/cfn_plan.rb', line 530

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.



542
543
544
545
546
 
# File 'arc_region_switch/cfn_plan.rb', line 542

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:



555
556
557
558
 
# File 'arc_region_switch/cfn_plan.rb', line 555

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:



577
578
579
580
581
582
 
# File 'arc_region_switch/cfn_plan.rb', line 577

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

#associated_alarms ⇒ AWSCDK::IResolvable, ...

The associated application health alarms for a plan.

Returns:



314
315
316
 
# File 'arc_region_switch/cfn_plan.rb', line 314

def associated_alarms()
  jsii_get_property("associatedAlarms")
end

#associated_alarms=(value) ⇒ Object 



318
319
320
321
 
# File 'arc_region_switch/cfn_plan.rb', line 318

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

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the plan.

Returns:

  • (String) 


204
205
206
 
# File 'arc_region_switch/cfn_plan.rb', line 204

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_health_checks_for_plan ⇒ AWSCDK::IResolvable

Returns:



209
210
211
 
# File 'arc_region_switch/cfn_plan.rb', line 209

def attr_health_checks_for_plan()
  jsii_get_property("attrHealthChecksForPlan")
end

#attr_owner ⇒ String

The owner of a plan.

Returns:

  • (String) 


216
217
218
 
# File 'arc_region_switch/cfn_plan.rb', line 216

def attr_owner()
  jsii_get_property("attrOwner")
end

#attr_plan_health_checks ⇒ Array<String>

Returns:

  • (Array<String>) 


221
222
223
 
# File 'arc_region_switch/cfn_plan.rb', line 221

def attr_plan_health_checks()
  jsii_get_property("attrPlanHealthChecks")
end

#attr_route53_health_checks ⇒ AWSCDK::IResolvable

Returns:



226
227
228
 
# File 'arc_region_switch/cfn_plan.rb', line 226

def attr_route53_health_checks()
  jsii_get_property("attrRoute53HealthChecks")
end

#attr_version ⇒ String

The version for the plan.

Returns:

  • (String) 


233
234
235
 
# File 'arc_region_switch/cfn_plan.rb', line 233

def attr_version()
  jsii_get_property("attrVersion")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
 
# File 'arc_region_switch/cfn_plan.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



150
151
152
 
# File 'arc_region_switch/cfn_plan.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'arc_region_switch/cfn_plan.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


586
587
588
589
 
# File 'arc_region_switch/cfn_plan.rb', line 586

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


160
161
162
 
# File 'arc_region_switch/cfn_plan.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'arc_region_switch/cfn_plan.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'arc_region_switch/cfn_plan.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description for a plan.

Returns:

  • (String, nil) 


326
327
328
 
# File 'arc_region_switch/cfn_plan.rb', line 326

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



330
331
332
333
 
# File 'arc_region_switch/cfn_plan.rb', line 330

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'arc_region_switch/cfn_plan.rb', line 172

def env()
  jsii_get_property("env")
end

#execution_role ⇒ String

The execution role for a plan.

Returns:

  • (String) 


254
255
256
 
# File 'arc_region_switch/cfn_plan.rb', line 254

def execution_role()
  jsii_get_property("executionRole")
end

#execution_role=(value) ⇒ Object 



258
259
260
261
 
# File 'arc_region_switch/cfn_plan.rb', line 258

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



599
600
601
602
603
 
# File 'arc_region_switch/cfn_plan.rb', line 599

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:



610
611
612
613
 
# File 'arc_region_switch/cfn_plan.rb', line 610

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:



680
681
682
683
 
# File 'arc_region_switch/cfn_plan.rb', line 680

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) 


124
125
126
 
# File 'arc_region_switch/cfn_plan.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name for a plan.

Returns:

  • (String) 


266
267
268
 
# File 'arc_region_switch/cfn_plan.rb', line 266

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



270
271
272
273
 
# File 'arc_region_switch/cfn_plan.rb', line 270

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) 


107
108
109
 
# File 'arc_region_switch/cfn_plan.rb', line 107

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:



621
622
623
 
# File 'arc_region_switch/cfn_plan.rb', line 621

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:



628
629
630
 
# File 'arc_region_switch/cfn_plan.rb', line 628

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.



421
422
423
424
 
# File 'arc_region_switch/cfn_plan.rb', line 421

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

#plan_ref ⇒ AWSCDK::Interfaces::AWSArcregionswitch::PlanReference

A reference to a Plan resource.

Returns:



247
248
249
 
# File 'arc_region_switch/cfn_plan.rb', line 247

def plan_ref()
  jsii_get_property("planRef")
end

#primary_region ⇒ String?

The primary Region for a plan.

Returns:

  • (String, nil) 


338
339
340
 
# File 'arc_region_switch/cfn_plan.rb', line 338

def primary_region()
  jsii_get_property("primaryRegion")
end

#primary_region=(value) ⇒ Object 



342
343
344
345
 
# File 'arc_region_switch/cfn_plan.rb', line 342

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

#recovery_approach ⇒ String

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

Returns:

  • (String) 


278
279
280
 
# File 'arc_region_switch/cfn_plan.rb', line 278

def recovery_approach()
  jsii_get_property("recoveryApproach")
end

#recovery_approach=(value) ⇒ Object 



282
283
284
285
 
# File 'arc_region_switch/cfn_plan.rb', line 282

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

#recovery_time_objective_minutes ⇒ Numeric?

The recovery time objective for a plan.

Returns:

  • (Numeric, nil) 


350
351
352
 
# File 'arc_region_switch/cfn_plan.rb', line 350

def recovery_time_objective_minutes()
  jsii_get_property("recoveryTimeObjectiveMinutes")
end

#recovery_time_objective_minutes=(value) ⇒ Object 



354
355
356
357
 
# File 'arc_region_switch/cfn_plan.rb', line 354

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


143
144
145
 
# File 'arc_region_switch/cfn_plan.rb', line 143

def ref()
  jsii_get_property("ref")
end

#regions ⇒ Array<String>

The AWS Regions for a plan.

Returns:

  • (Array<String>) 


290
291
292
 
# File 'arc_region_switch/cfn_plan.rb', line 290

def regions()
  jsii_get_property("regions")
end

#regions=(value) ⇒ Object 



294
295
296
297
 
# File 'arc_region_switch/cfn_plan.rb', line 294

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



639
640
641
642
 
# File 'arc_region_switch/cfn_plan.rb', line 639

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


646
647
648
649
 
# File 'arc_region_switch/cfn_plan.rb', line 646

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:



656
657
658
659
660
 
# File 'arc_region_switch/cfn_plan.rb', line 656

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

#report_configuration ⇒ AWSCDK::IResolvable, ...

The report configuration for a plan.

Returns:



362
363
364
 
# File 'arc_region_switch/cfn_plan.rb', line 362

def report_configuration()
  jsii_get_property("reportConfiguration")
end

#report_configuration=(value) ⇒ Object 



366
367
368
369
370
 
# File 'arc_region_switch/cfn_plan.rb', line 366

def report_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::ARCRegionSwitch::CfnPlan::ReportConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcmNyZWdpb25zd2l0Y2guQ2ZuUGxhbi5SZXBvcnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "reportConfiguration") unless value.nil?
  jsii_set_property("reportConfiguration", 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.



665
666
667
 
# File 'arc_region_switch/cfn_plan.rb', line 665

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:



133
134
135
 
# File 'arc_region_switch/cfn_plan.rb', line 133

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

Returns:

  • (Hash{String => String}, nil) 


373
374
375
 
# File 'arc_region_switch/cfn_plan.rb', line 373

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



377
378
379
380
 
# File 'arc_region_switch/cfn_plan.rb', line 377

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



397
398
399
 
# File 'arc_region_switch/cfn_plan.rb', line 397

def to_string()
  jsii_call_method("toString", [])
end

#triggers ⇒ AWSCDK::IResolvable, ...

The triggers for a plan.

Returns:



385
386
387
 
# File 'arc_region_switch/cfn_plan.rb', line 385

def triggers()
  jsii_get_property("triggers")
end

#triggers=(value) ⇒ Object 



389
390
391
392
 
# File 'arc_region_switch/cfn_plan.rb', line 389

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


180
181
182
 
# File 'arc_region_switch/cfn_plan.rb', line 180

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


190
191
192
 
# File 'arc_region_switch/cfn_plan.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


671
672
673
674
 
# File 'arc_region_switch/cfn_plan.rb', line 671

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) 


410
411
412
413
414
415
 
# File 'arc_region_switch/cfn_plan.rb', line 410

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

#workflows ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ARCRegionSwitch::CfnPlan::WorkflowProperty>

The workflows for a plan.

Returns:



302
303
304
 
# File 'arc_region_switch/cfn_plan.rb', line 302

def workflows()
  jsii_get_property("workflows")
end

#workflows=(value) ⇒ Object 



306
307
308
309
 
# File 'arc_region_switch/cfn_plan.rb', line 306

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