Class: AWSCDK::ARCRegionSwitch::CfnPlan::RegionSwitchPlanConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ARCRegionSwitch::CfnPlan::RegionSwitchPlanConfigurationProperty

Defined in:

arc_region_switch/cfn_plan.rb

Overview

Configuration for nested Region switch plans.

This allows one Region switch plan to trigger another plan as part of its execution.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html

Instance Attribute Summary

• #arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the plan configuration.

• #cross_account_role ⇒ String^? readonly

  The cross account role for the configuration.

• #external_id ⇒ String^? readonly

  The external ID (secret key) for the configuration.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(arn:, cross_account_role: nil, external_id: nil) ⇒ RegionSwitchPlanConfigurationProperty constructor

  A new instance of RegionSwitchPlanConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(arn:, cross_account_role: nil, external_id: nil) ⇒ RegionSwitchPlanConfigurationProperty

Returns a new instance of RegionSwitchPlanConfigurationProperty.

Parameters:

• arn (String) —

  The Amazon Resource Name (ARN) of the plan configuration.

• cross_account_role (String, nil) (defaults to: nil) —

  The cross account role for the configuration.

• external_id (String, nil) (defaults to: nil) —

  The external ID (secret key) for the configuration.

# File 'arc_region_switch/cfn_plan.rb', line 2610

def initialize(arn:, cross_account_role: nil, external_id: nil)
  @arn = arn
  Jsii::Type.check_type(@arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  @cross_account_role = cross_account_role
  Jsii::Type.check_type(@cross_account_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "crossAccountRole") unless @cross_account_role.nil?
  @external_id = external_id
  Jsii::Type.check_type(@external_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "externalId") unless @external_id.nil?
end

Instance Attribute Details

#arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the plan configuration.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-arn

# File 'arc_region_switch/cfn_plan.rb', line 2623

def arn
  @arn
end

#cross_account_role ⇒ String^? (readonly)

The cross account role for the configuration.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-crossaccountrole

# File 'arc_region_switch/cfn_plan.rb', line 2628

def cross_account_role
  @cross_account_role
end

#external_id ⇒ String^? (readonly)

The external ID (secret key) for the configuration.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-arcregionswitch-plan-regionswitchplanconfiguration.html#cfn-arcregionswitch-plan-regionswitchplanconfiguration-externalid

# File 'arc_region_switch/cfn_plan.rb', line 2633

def external_id
  @external_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'arc_region_switch/cfn_plan.rb', line 2635

def self.jsii_properties
  {
    :arn => "arn",
    :cross_account_role => "crossAccountRole",
    :external_id => "externalId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'arc_region_switch/cfn_plan.rb', line 2643

def to_jsii
  result = {}
  result.merge!({
    "arn" => @arn,
    "crossAccountRole" => @cross_account_role,
    "externalId" => @external_id,
  })
  result.compact
end