Package software.amazon.awscdk.services.arcregionswitch

Interface CfnPlan.RegionSwitchPlanConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlan.RegionSwitchPlanConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPlan

@Stability(Stable)
public static interface CfnPlan.RegionSwitchPlanConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for nested Region switch plans.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.arcregionswitch.*;
 RegionSwitchPlanConfigurationProperty regionSwitchPlanConfigurationProperty = RegionSwitchPlanConfigurationProperty.builder()
         .arn("arn")
         // the properties below are optional
         .crossAccountRole("crossAccountRole")
         .externalId("externalId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlan.RegionSwitchPlanConfigurationProperty.Builder	A builder for CfnPlan.RegionSwitchPlanConfigurationProperty
static final class	CfnPlan.RegionSwitchPlanConfigurationProperty.Jsii$Proxy	An implementation for CfnPlan.RegionSwitchPlanConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnPlan.RegionSwitchPlanConfigurationProperty.Builder	builder()
String	getArn()	The Amazon Resource Name (ARN) of the plan configuration.
default String	getCrossAccountRole()	The cross account role for the configuration.
default String	getExternalId()	The external ID (secret key) for the configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@NotNull
String getArn()

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

See Also:

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

getCrossAccountRole

@Stability(Stable)
@Nullable
default String getCrossAccountRole()

The cross account role for the configuration.

See Also:

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

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

The external ID (secret key) for the configuration.

See Also:

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

builder

@Stability(Stable)
static CfnPlan.RegionSwitchPlanConfigurationProperty.Builder builder()

Returns:

a CfnPlan.RegionSwitchPlanConfigurationProperty.Builder of CfnPlan.RegionSwitchPlanConfigurationProperty