Package software.amazon.awscdk.services.arcregionswitch

Interface CfnPlan.ArcRoutingControlConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlan.ArcRoutingControlConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnPlan

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

Configuration for ARC routing controls used in a Region switch plan.

Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.

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.*;
 ArcRoutingControlConfigurationProperty arcRoutingControlConfigurationProperty = ArcRoutingControlConfigurationProperty.builder()
         .regionAndRoutingControls(Map.of(
                 "regionAndRoutingControlsKey", List.of(ArcRoutingControlStateProperty.builder()
                         .routingControlArn("routingControlArn")
                         .state("state")
                         .build())))
         // the properties below are optional
         .crossAccountRole("crossAccountRole")
         .externalId("externalId")
         .timeoutMinutes(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPlan.ArcRoutingControlConfigurationProperty.Builder	builder()
default String	getCrossAccountRole()	The cross account role for the configuration.
default String	getExternalId()	The external ID (secret key) for the configuration.
Object	getRegionAndRoutingControls()	The Region and ARC routing controls for the configuration.
default Number	getTimeoutMinutes()	The timeout value specified for the configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRegionAndRoutingControls

@Stability(Stable)
@NotNull
Object getRegionAndRoutingControls()

The Region and ARC routing controls for the configuration.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.ArcRoutingControlStateProperty>>

See Also:

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

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-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-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-arcroutingcontrolconfiguration.html#cfn-arcregionswitch-plan-arcroutingcontrolconfiguration-externalid

getTimeoutMinutes

@Stability(Stable)
@Nullable
default Number getTimeoutMinutes()

The timeout value specified for the configuration.

Default: - 60

See Also:

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

builder

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

Returns:

a CfnPlan.ArcRoutingControlConfigurationProperty.Builder of CfnPlan.ArcRoutingControlConfigurationProperty