amazonka-route53-recovery-control-config-2.0: Amazon Route53 Recovery Control Config 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.Route53RecoveryControlConfig.CreateRoutingControl

Description

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Synopsis

Creating a Request

data CreateRoutingControl Source #

The details of the routing control that you're creating.

See: newCreateRoutingControl smart constructor.

Constructors

CreateRoutingControl' 

Fields

  • clientToken :: Maybe Text

    A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

  • controlPanelArn :: Maybe Text

    The Amazon Resource Name (ARN) of the control panel that includes the routing control.

  • clusterArn :: Text

    The Amazon Resource Name (ARN) of the cluster that includes the routing control.

  • routingControlName :: Text

    The name of the routing control.

Instances

Instances details
ToJSON CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

ToHeaders CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

ToPath CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

ToQuery CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

AWSRequest CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Associated Types

type AWSResponse CreateRoutingControl #

Generic CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Associated Types

type Rep CreateRoutingControl :: Type -> Type #

Read CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Show CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

NFData CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Methods

rnf :: CreateRoutingControl -> () #

Eq CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Hashable CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

type AWSResponse CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

type Rep CreateRoutingControl Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

type Rep CreateRoutingControl = D1 ('MetaData "CreateRoutingControl" "Amazonka.Route53RecoveryControlConfig.CreateRoutingControl" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "CreateRoutingControl'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "controlPanelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routingControlName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateRoutingControl Source #

Create a value of CreateRoutingControl 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:clientToken:CreateRoutingControl', createRoutingControl_clientToken - A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

CreateRoutingControl, createRoutingControl_controlPanelArn - The Amazon Resource Name (ARN) of the control panel that includes the routing control.

CreateRoutingControl, createRoutingControl_clusterArn - The Amazon Resource Name (ARN) of the cluster that includes the routing control.

$sel:routingControlName:CreateRoutingControl', createRoutingControl_routingControlName - The name of the routing control.

Request Lenses

createRoutingControl_clientToken :: Lens' CreateRoutingControl (Maybe Text) Source #

A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.

createRoutingControl_controlPanelArn :: Lens' CreateRoutingControl (Maybe Text) Source #

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

createRoutingControl_clusterArn :: Lens' CreateRoutingControl Text Source #

The Amazon Resource Name (ARN) of the cluster that includes the routing control.

Destructuring the Response

data CreateRoutingControlResponse Source #

See: newCreateRoutingControlResponse smart constructor.

Constructors

CreateRoutingControlResponse' 

Fields

Instances

Instances details
Generic CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Associated Types

type Rep CreateRoutingControlResponse :: Type -> Type #

Read CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Show CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

NFData CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

Eq CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

type Rep CreateRoutingControlResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateRoutingControl

type Rep CreateRoutingControlResponse = D1 ('MetaData "CreateRoutingControlResponse" "Amazonka.Route53RecoveryControlConfig.CreateRoutingControl" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "CreateRoutingControlResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "routingControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingControl)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateRoutingControlResponse Source #

Create a value of CreateRoutingControlResponse 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:routingControl:CreateRoutingControlResponse', createRoutingControlResponse_routingControl - The routing control that is created.

$sel:httpStatus:CreateRoutingControlResponse', createRoutingControlResponse_httpStatus - The response's http status code.

Response Lenses