libZSservicesZSamazonka-route53-recovery-control-configZSamazonka-route53-recovery-control-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53RecoveryControlConfig.Lens

Description

 
Synopsis

Operations

DescribeControlPanel

describeControlPanel_controlPanelArn :: Lens' DescribeControlPanel Text Source #

The Amazon Resource Name (ARN) of the control panel that you're getting details for.

CreateRoutingControl

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.

DescribeCluster

describeCluster_clusterArn :: Lens' DescribeCluster Text Source #

The Amazon Resource Name (ARN) of the cluster that you're getting details for.

describeClusterResponse_cluster :: Lens' DescribeClusterResponse (Maybe Cluster) Source #

The cluster for the DescribeCluster request.

DeleteRoutingControl

deleteRoutingControl_routingControlArn :: Lens' DeleteRoutingControl Text Source #

The Amazon Resource Name (ARN) of the routing control that you're deleting.

UpdateRoutingControl

updateRoutingControl_routingControlArn :: Lens' UpdateRoutingControl Text Source #

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

CreateControlPanel

createControlPanel_clusterArn :: Lens' CreateControlPanel Text Source #

The Amazon Resource Name (ARN) of the cluster for the control panel.

UpdateControlPanel

updateControlPanel_controlPanelArn :: Lens' UpdateControlPanel Text Source #

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

DeleteControlPanel

deleteControlPanel_controlPanelArn :: Lens' DeleteControlPanel Text Source #

The Amazon Resource Name (ARN) of the control panel that you're deleting.

DeleteCluster

deleteCluster_clusterArn :: Lens' DeleteCluster Text Source #

The Amazon Resource Name (ARN) of the cluster that you're deleting.

CreateSafetyRule

CreateCluster

createCluster_clientToken :: Lens' CreateCluster (Maybe Text) Source #

Unique client idempotency token.

ListAssociatedRoute53HealthChecks

listAssociatedRoute53HealthChecks_nextToken :: Lens' ListAssociatedRoute53HealthChecks (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listAssociatedRoute53HealthChecks_maxResults :: Lens' ListAssociatedRoute53HealthChecks (Maybe Natural) Source #

The number of objects that you want to return with this call.

listAssociatedRoute53HealthChecks_routingControlArn :: Lens' ListAssociatedRoute53HealthChecks Text Source #

The Amazon Resource Name (ARN) of the routing control that you're getting details for.

listAssociatedRoute53HealthChecksResponse_nextToken :: Lens' ListAssociatedRoute53HealthChecksResponse (Maybe Text) Source #

The token that identifies which batch of results you want to see.

DescribeSafetyRule

describeSafetyRule_safetyRuleArn :: Lens' DescribeSafetyRule Text Source #

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

ListRoutingControls

listRoutingControls_nextToken :: Lens' ListRoutingControls (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listRoutingControls_maxResults :: Lens' ListRoutingControls (Maybe Natural) Source #

The number of objects that you want to return with this call.

listRoutingControls_controlPanelArn :: Lens' ListRoutingControls Text Source #

The Amazon Resource Name (ARN) of the control panel that you're getting routing control details for.

listRoutingControlsResponse_nextToken :: Lens' ListRoutingControlsResponse (Maybe Text) Source #

The token that identifies which batch of results you want to see.

ListControlPanels

listControlPanels_clusterArn :: Lens' ListControlPanels (Maybe Text) Source #

The Amazon Resource Name (ARN) of a cluster.

listControlPanels_nextToken :: Lens' ListControlPanels (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listControlPanels_maxResults :: Lens' ListControlPanels (Maybe Natural) Source #

The number of objects that you want to return with this call.

listControlPanelsResponse_nextToken :: Lens' ListControlPanelsResponse (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listControlPanelsResponse_controlPanels :: Lens' ListControlPanelsResponse (Maybe [ControlPanel]) Source #

The result of a successful ListControlPanel request.

UpdateSafetyRule

DeleteSafetyRule

deleteSafetyRule_safetyRuleArn :: Lens' DeleteSafetyRule Text Source #

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

ListClusters

listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #

The number of objects that you want to return with this call.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [Cluster]) Source #

An array of the clusters in an account.

ListSafetyRules

listSafetyRules_nextToken :: Lens' ListSafetyRules (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listSafetyRules_maxResults :: Lens' ListSafetyRules (Maybe Natural) Source #

The number of objects that you want to return with this call.

listSafetyRules_controlPanelArn :: Lens' ListSafetyRules Text Source #

The Amazon Resource Name (ARN) of the control panel that you're getting details for.

listSafetyRulesResponse_nextToken :: Lens' ListSafetyRulesResponse (Maybe Text) Source #

The token that identifies which batch of results you want to see.

listSafetyRulesResponse_safetyRules :: Lens' ListSafetyRulesResponse (Maybe [Rule]) Source #

The list of safety rules in a control panel.

DescribeRoutingControl

describeRoutingControl_routingControlArn :: Lens' DescribeRoutingControl Text Source #

The Amazon Resource Name (ARN) of the routing control that you're getting details for.

Types

AssertionRule

assertionRule_status :: Lens' AssertionRule Status Source #

The deployment status of an assertion rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

assertionRule_controlPanelArn :: Lens' AssertionRule Text Source #

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

assertionRule_safetyRuleArn :: Lens' AssertionRule Text Source #

The Amazon Resource Name (ARN) of the assertion rule.

assertionRule_assertedControls :: Lens' AssertionRule [Text] Source #

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

assertionRule_ruleConfig :: Lens' AssertionRule RuleConfig Source #

The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.

assertionRule_waitPeriodMs :: Lens' AssertionRule Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

assertionRule_name :: Lens' AssertionRule Text Source #

Name of the assertion rule. You can use any non-white space character in the name.

AssertionRuleUpdate

assertionRuleUpdate_safetyRuleArn :: Lens' AssertionRuleUpdate Text Source #

The Amazon Resource Name (ARN) of the assertion rule.

assertionRuleUpdate_waitPeriodMs :: Lens' AssertionRuleUpdate Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

assertionRuleUpdate_name :: Lens' AssertionRuleUpdate Text Source #

The name of the assertion rule. You can use any non-white space character in the name.

Cluster

cluster_status :: Lens' Cluster (Maybe Status) Source #

Deployment status of a resource. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

cluster_clusterArn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

cluster_name :: Lens' Cluster (Maybe Text) Source #

The name of the cluster.

cluster_clusterEndpoints :: Lens' Cluster (Maybe [ClusterEndpoint]) Source #

Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.

ClusterEndpoint

clusterEndpoint_region :: Lens' ClusterEndpoint (Maybe Text) Source #

The Amazon Web Services Region for a cluster endpoint.

clusterEndpoint_endpoint :: Lens' ClusterEndpoint (Maybe Text) Source #

A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.

To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.

ControlPanel

controlPanel_status :: Lens' ControlPanel (Maybe Status) Source #

The deployment status of control panel. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

controlPanel_controlPanelArn :: Lens' ControlPanel (Maybe Text) Source #

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

controlPanel_clusterArn :: Lens' ControlPanel (Maybe Text) Source #

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

controlPanel_routingControlCount :: Lens' ControlPanel (Maybe Int) Source #

The number of routing controls in the control panel.

controlPanel_name :: Lens' ControlPanel (Maybe Text) Source #

The name of the control panel. You can use any non-white space character in the name.

controlPanel_defaultControlPanel :: Lens' ControlPanel (Maybe Bool) Source #

A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

GatingRule

gatingRule_status :: Lens' GatingRule Status Source #

The deployment status of a gating rule. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

gatingRule_targetControls :: Lens' GatingRule [Text] Source #

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

gatingRule_controlPanelArn :: Lens' GatingRule Text Source #

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

gatingRule_safetyRuleArn :: Lens' GatingRule Text Source #

The Amazon Resource Name (ARN) of the gating rule.

gatingRule_gatingControls :: Lens' GatingRule [Text] Source #

The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

gatingRule_ruleConfig :: Lens' GatingRule RuleConfig Source #

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

gatingRule_waitPeriodMs :: Lens' GatingRule Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

gatingRule_name :: Lens' GatingRule Text Source #

The name for the gating rule.

GatingRuleUpdate

gatingRuleUpdate_safetyRuleArn :: Lens' GatingRuleUpdate Text Source #

The Amazon Resource Name (ARN) of the gating rule.

gatingRuleUpdate_waitPeriodMs :: Lens' GatingRuleUpdate Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

gatingRuleUpdate_name :: Lens' GatingRuleUpdate Text Source #

The name for the gating rule.

NewAssertionRule

newAssertionRule_controlPanelArn :: Lens' NewAssertionRule Text Source #

The Amazon Resource Name (ARN) for the control panel.

newAssertionRule_assertedControls :: Lens' NewAssertionRule [Text] Source #

The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.

newAssertionRule_ruleConfig :: Lens' NewAssertionRule RuleConfig Source #

The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.

newAssertionRule_waitPeriodMs :: Lens' NewAssertionRule Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

newAssertionRule_name :: Lens' NewAssertionRule Text Source #

The name of the assertion rule. You can use any non-white space character in the name.

NewGatingRule

newGatingRule_targetControls :: Lens' NewGatingRule [Text] Source #

Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.

In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.

newGatingRule_controlPanelArn :: Lens' NewGatingRule Text Source #

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

newGatingRule_gatingControls :: Lens' NewGatingRule [Text] Source #

The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.

newGatingRule_ruleConfig :: Lens' NewGatingRule RuleConfig Source #

The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.

newGatingRule_waitPeriodMs :: Lens' NewGatingRule Int Source #

An evaluation period, in milliseconds (ms), during which any request against the target routing controls will fail. This helps prevent "flapping" of state. The wait period is 5000 ms by default, but you can choose a custom value.

newGatingRule_name :: Lens' NewGatingRule Text Source #

The name for the new gating rule.

RoutingControl

routingControl_status :: Lens' RoutingControl (Maybe Status) Source #

The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

routingControl_controlPanelArn :: Lens' RoutingControl (Maybe Text) Source #

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

routingControl_name :: Lens' RoutingControl (Maybe Text) Source #

The name of the routing control.

routingControl_routingControlArn :: Lens' RoutingControl (Maybe Text) Source #

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

Rule

rule_gating :: Lens' Rule (Maybe GatingRule) Source #

A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.

rule_assertion :: Lens' Rule (Maybe AssertionRule) Source #

An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.

RuleConfig

ruleConfig_type :: Lens' RuleConfig RuleType Source #

A rule can be one of the following: ATLEAST, AND, or OR.

ruleConfig_inverted :: Lens' RuleConfig Bool Source #

Logical negation of the rule. If the rule would usually evaluate true, it's evaluated as false, and vice versa.

ruleConfig_threshold :: Lens' RuleConfig Int Source #

The value of N, when you specify an ATLEAST rule type. That is, Threshold is the number of controls that must be set when you specify an ATLEAST type.