amazonka-route53-recovery-cluster-2.0: Amazon Route53 Recovery Cluster SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Description

Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.

The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

/You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC./

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.

Synopsis

Creating a Request

data UpdateRoutingControlStates Source #

See: newUpdateRoutingControlStates smart constructor.

Constructors

UpdateRoutingControlStates' 

Fields

Instances

Instances details
ToJSON UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

ToHeaders UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

ToPath UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

ToQuery UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

AWSRequest UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Generic UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Associated Types

type Rep UpdateRoutingControlStates :: Type -> Type #

Read UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Show UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

NFData UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Eq UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Hashable UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

type AWSResponse UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

type Rep UpdateRoutingControlStates Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

type Rep UpdateRoutingControlStates = D1 ('MetaData "UpdateRoutingControlStates" "Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates" "amazonka-route53-recovery-cluster-2.0-DxeQnRCPOPo1FMbWCdEnyv" 'False) (C1 ('MetaCons "UpdateRoutingControlStates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "safetyRulesToOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "updateRoutingControlStateEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [UpdateRoutingControlStateEntry])))

newUpdateRoutingControlStates :: UpdateRoutingControlStates Source #

Create a value of UpdateRoutingControlStates with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:safetyRulesToOverride:UpdateRoutingControlStates', updateRoutingControlStates_safetyRulesToOverride - The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

$sel:updateRoutingControlStateEntries:UpdateRoutingControlStates', updateRoutingControlStates_updateRoutingControlStateEntries - A set of routing control entries that you want to update.

Request Lenses

updateRoutingControlStates_safetyRulesToOverride :: Lens' UpdateRoutingControlStates (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

Destructuring the Response

data UpdateRoutingControlStatesResponse Source #

Constructors

UpdateRoutingControlStatesResponse' 

Fields

Instances

Instances details
Generic UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Associated Types

type Rep UpdateRoutingControlStatesResponse :: Type -> Type #

Read UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Show UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

NFData UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

Eq UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

type Rep UpdateRoutingControlStatesResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates

type Rep UpdateRoutingControlStatesResponse = D1 ('MetaData "UpdateRoutingControlStatesResponse" "Amazonka.Route53RecoveryCluster.UpdateRoutingControlStates" "amazonka-route53-recovery-cluster-2.0-DxeQnRCPOPo1FMbWCdEnyv" 'False) (C1 ('MetaCons "UpdateRoutingControlStatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRoutingControlStatesResponse Source #

Create a value of UpdateRoutingControlStatesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateRoutingControlStatesResponse', updateRoutingControlStatesResponse_httpStatus - The response's http status code.

Response Lenses