Amazonka.Route53RecoveryCluster.GetRoutingControlState

Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.

/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.

Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:

• Viewing and updating routing control states
• Working with routing controls in Route 53 ARC

Creating a Request

data GetRoutingControlState

See: newGetRoutingControlState smart constructor.

Constructors

GetRoutingControlState'

Fields

• routingControlArn :: Text

  The Amazon Resource Name (ARN) for the routing control that you want to get the state for.

Instances

ToJSON GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

toJSON :: GetRoutingControlState -> Value

toEncoding :: GetRoutingControlState -> Encoding

toJSONList :: [GetRoutingControlState] -> Value

toEncodingList :: [GetRoutingControlState] -> Encoding

ToHeaders GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

toHeaders :: GetRoutingControlState -> [Header]

ToPath GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

toPath :: GetRoutingControlState -> ByteString

ToQuery GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

toQuery :: GetRoutingControlState -> QueryString

AWSRequest GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Associated Types

type AWSResponse GetRoutingControlState

Methods

request :: (Service -> Service) -> GetRoutingControlState -> Request GetRoutingControlState

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRoutingControlState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoutingControlState)))

Generic GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Associated Types

type Rep GetRoutingControlState :: Type -> Type

Methods

from :: GetRoutingControlState -> Rep GetRoutingControlState x

to :: Rep GetRoutingControlState x -> GetRoutingControlState

Read GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

readsPrec :: Int -> ReadS GetRoutingControlState

readList :: ReadS [GetRoutingControlState]

readPrec :: ReadPrec GetRoutingControlState

readListPrec :: ReadPrec [GetRoutingControlState]

Show GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

showsPrec :: Int -> GetRoutingControlState -> ShowS

show :: GetRoutingControlState -> String

showList :: [GetRoutingControlState] -> ShowS

NFData GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

rnf :: GetRoutingControlState -> ()

Eq GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

(==) :: GetRoutingControlState -> GetRoutingControlState -> Bool

(/=) :: GetRoutingControlState -> GetRoutingControlState -> Bool

Hashable GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

hashWithSalt :: Int -> GetRoutingControlState -> Int

hash :: GetRoutingControlState -> Int

type AWSResponse GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

type AWSResponse GetRoutingControlState = GetRoutingControlStateResponse

type Rep GetRoutingControlState

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

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

newGetRoutingControlState

Arguments

:: Text

GetRoutingControlState

-> GetRoutingControlState

Create a value of GetRoutingControlState 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:

GetRoutingControlState, getRoutingControlState_routingControlArn - The Amazon Resource Name (ARN) for the routing control that you want to get the state for.

Request Lenses

getRoutingControlState_routingControlArn :: Lens' GetRoutingControlState Text

The Amazon Resource Name (ARN) for the routing control that you want to get the state for.

Destructuring the Response

data GetRoutingControlStateResponse

See: newGetRoutingControlStateResponse smart constructor.

Constructors

GetRoutingControlStateResponse'

Fields

• routingControlName :: Maybe Text

  The routing control name.

• httpStatus :: Int

  The response's http status code.

• routingControlArn :: Text

  The Amazon Resource Name (ARN) of the response.

• routingControlState :: RoutingControlState

  The state of the routing control.

Instances

Generic GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Associated Types

type Rep GetRoutingControlStateResponse :: Type -> Type

Methods

from :: GetRoutingControlStateResponse -> Rep GetRoutingControlStateResponse x

to :: Rep GetRoutingControlStateResponse x -> GetRoutingControlStateResponse

Read GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

readsPrec :: Int -> ReadS GetRoutingControlStateResponse

readList :: ReadS [GetRoutingControlStateResponse]

readPrec :: ReadPrec GetRoutingControlStateResponse

readListPrec :: ReadPrec [GetRoutingControlStateResponse]

Show GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

showsPrec :: Int -> GetRoutingControlStateResponse -> ShowS

show :: GetRoutingControlStateResponse -> String

showList :: [GetRoutingControlStateResponse] -> ShowS

NFData GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

rnf :: GetRoutingControlStateResponse -> ()

Eq GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

Methods

(==) :: GetRoutingControlStateResponse -> GetRoutingControlStateResponse -> Bool

(/=) :: GetRoutingControlStateResponse -> GetRoutingControlStateResponse -> Bool

type Rep GetRoutingControlStateResponse

Defined in Amazonka.Route53RecoveryCluster.GetRoutingControlState

type Rep GetRoutingControlStateResponse = D1 ('MetaData "GetRoutingControlStateResponse" "Amazonka.Route53RecoveryCluster.GetRoutingControlState" "amazonka-route53-recovery-cluster-2.0-DxeQnRCPOPo1FMbWCdEnyv" 'False) (C1 ('MetaCons "GetRoutingControlStateResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "routingControlName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "routingControlArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routingControlState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoutingControlState))))

newGetRoutingControlStateResponse

Arguments

:: Int

$sel:httpStatus:GetRoutingControlStateResponse'

-> Text

GetRoutingControlState

-> RoutingControlState

GetRoutingControlStateResponse

-> GetRoutingControlStateResponse

Create a value of GetRoutingControlStateResponse 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:

GetRoutingControlStateResponse, getRoutingControlStateResponse_routingControlName - The routing control name.

$sel:httpStatus:GetRoutingControlStateResponse', getRoutingControlStateResponse_httpStatus - The response's http status code.

GetRoutingControlState, getRoutingControlStateResponse_routingControlArn - The Amazon Resource Name (ARN) of the response.

GetRoutingControlStateResponse, getRoutingControlStateResponse_routingControlState - The state of the routing control.

Response Lenses

getRoutingControlStateResponse_routingControlName :: Lens' GetRoutingControlStateResponse (Maybe Text)

The routing control name.

getRoutingControlStateResponse_httpStatus :: Lens' GetRoutingControlStateResponse Int

The response's http status code.

getRoutingControlStateResponse_routingControlArn :: Lens' GetRoutingControlStateResponse Text

The Amazon Resource Name (ARN) of the response.

getRoutingControlStateResponse_routingControlState :: Lens' GetRoutingControlStateResponse RoutingControlState

The state of the routing control.