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

Description

Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.

There are two types of safety rules: assertion rules and gating rules.

Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transaction so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.

Gating rule: A gating rule lets you configure a gating routing control as an overall "on/off" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.

For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.

Synopsis

Creating a Request

data CreateSafetyRule Source #

The request body that you include when you create a safety rule.

See: newCreateSafetyRule smart constructor.

Constructors

CreateSafetyRule' 

Fields

Instances

Instances details
ToJSON CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

ToHeaders CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

ToPath CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

ToQuery CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

AWSRequest CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Associated Types

type AWSResponse CreateSafetyRule #

Generic CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Associated Types

type Rep CreateSafetyRule :: Type -> Type #

Read CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Show CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

NFData CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Methods

rnf :: CreateSafetyRule -> () #

Eq CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Hashable CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

type AWSResponse CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

type Rep CreateSafetyRule Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

type Rep CreateSafetyRule = D1 ('MetaData "CreateSafetyRule" "Amazonka.Route53RecoveryControlConfig.CreateSafetyRule" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "CreateSafetyRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assertionRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NewAssertionRule)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "gatingRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NewGatingRule)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newCreateSafetyRule :: CreateSafetyRule Source #

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

CreateSafetyRule, createSafetyRule_assertionRule - The assertion rule requested.

$sel:clientToken:CreateSafetyRule', createSafetyRule_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.

CreateSafetyRule, createSafetyRule_gatingRule - The gating rule requested.

$sel:tags:CreateSafetyRule', createSafetyRule_tags - The tags associated with the safety rule.

Request Lenses

createSafetyRule_clientToken :: Lens' CreateSafetyRule (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.

createSafetyRule_tags :: Lens' CreateSafetyRule (Maybe (HashMap Text Text)) Source #

The tags associated with the safety rule.

Destructuring the Response

data CreateSafetyRuleResponse Source #

See: newCreateSafetyRuleResponse smart constructor.

Constructors

CreateSafetyRuleResponse' 

Fields

Instances

Instances details
Generic CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Associated Types

type Rep CreateSafetyRuleResponse :: Type -> Type #

Read CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Show CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

NFData CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

Eq CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

type Rep CreateSafetyRuleResponse Source # 
Instance details

Defined in Amazonka.Route53RecoveryControlConfig.CreateSafetyRule

type Rep CreateSafetyRuleResponse = D1 ('MetaData "CreateSafetyRuleResponse" "Amazonka.Route53RecoveryControlConfig.CreateSafetyRule" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "CreateSafetyRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assertionRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssertionRule)) :*: (S1 ('MetaSel ('Just "gatingRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatingRule)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateSafetyRuleResponse Source #

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

CreateSafetyRule, createSafetyRuleResponse_assertionRule - The assertion rule created.

CreateSafetyRule, createSafetyRuleResponse_gatingRule - The gating rule created.

$sel:httpStatus:CreateSafetyRuleResponse', createSafetyRuleResponse_httpStatus - The response's http status code.

Response Lenses