| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Route53RecoveryControlConfig
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateCluster
- CreateControlPanel
- CreateRoutingControl
- CreateSafetyRule
- DeleteCluster
- DeleteControlPanel
- DeleteRoutingControl
- DeleteSafetyRule
- DescribeCluster
- DescribeControlPanel
- DescribeRoutingControl
- DescribeSafetyRule
- ListAssociatedRoute53HealthChecks (Paginated)
- ListClusters (Paginated)
- ListControlPanels (Paginated)
- ListRoutingControls (Paginated)
- ListSafetyRules (Paginated)
- ListTagsForResource
- TagResource
- UntagResource
- UpdateControlPanel
- UpdateRoutingControl
- UpdateSafetyRule
- Types
Description
Derived from API version 2020-11-02 of the AWS service descriptions, licensed under Apache 2.0.
Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newClusterCreated :: Wait DescribeCluster
- newClusterDeleted :: Wait DescribeCluster
- newControlPanelCreated :: Wait DescribeControlPanel
- newControlPanelDeleted :: Wait DescribeControlPanel
- newRoutingControlCreated :: Wait DescribeRoutingControl
- newRoutingControlDeleted :: Wait DescribeRoutingControl
- data CreateCluster = CreateCluster' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateCluster :: Text -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' (Maybe Cluster) Int
- newCreateClusterResponse :: Int -> CreateClusterResponse
- data CreateControlPanel = CreateControlPanel' (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateControlPanel :: Text -> Text -> CreateControlPanel
- data CreateControlPanelResponse = CreateControlPanelResponse' (Maybe ControlPanel) Int
- newCreateControlPanelResponse :: Int -> CreateControlPanelResponse
- data CreateRoutingControl = CreateRoutingControl' (Maybe Text) (Maybe Text) Text Text
- newCreateRoutingControl :: Text -> Text -> CreateRoutingControl
- data CreateRoutingControlResponse = CreateRoutingControlResponse' (Maybe RoutingControl) Int
- newCreateRoutingControlResponse :: Int -> CreateRoutingControlResponse
- data CreateSafetyRule = CreateSafetyRule' (Maybe NewAssertionRule) (Maybe Text) (Maybe NewGatingRule) (Maybe (HashMap Text Text))
- newCreateSafetyRule :: CreateSafetyRule
- data CreateSafetyRuleResponse = CreateSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int
- newCreateSafetyRuleResponse :: Int -> CreateSafetyRuleResponse
- data DeleteCluster = DeleteCluster' Text
- newDeleteCluster :: Text -> DeleteCluster
- data DeleteClusterResponse = DeleteClusterResponse' Int
- newDeleteClusterResponse :: Int -> DeleteClusterResponse
- data DeleteControlPanel = DeleteControlPanel' Text
- newDeleteControlPanel :: Text -> DeleteControlPanel
- data DeleteControlPanelResponse = DeleteControlPanelResponse' Int
- newDeleteControlPanelResponse :: Int -> DeleteControlPanelResponse
- data DeleteRoutingControl = DeleteRoutingControl' Text
- newDeleteRoutingControl :: Text -> DeleteRoutingControl
- data DeleteRoutingControlResponse = DeleteRoutingControlResponse' Int
- newDeleteRoutingControlResponse :: Int -> DeleteRoutingControlResponse
- data DeleteSafetyRule = DeleteSafetyRule' Text
- newDeleteSafetyRule :: Text -> DeleteSafetyRule
- data DeleteSafetyRuleResponse = DeleteSafetyRuleResponse' Int
- newDeleteSafetyRuleResponse :: Int -> DeleteSafetyRuleResponse
- data DescribeCluster = DescribeCluster' Text
- newDescribeCluster :: Text -> DescribeCluster
- data DescribeClusterResponse = DescribeClusterResponse' (Maybe Cluster) Int
- newDescribeClusterResponse :: Int -> DescribeClusterResponse
- data DescribeControlPanel = DescribeControlPanel' Text
- newDescribeControlPanel :: Text -> DescribeControlPanel
- data DescribeControlPanelResponse = DescribeControlPanelResponse' (Maybe ControlPanel) Int
- newDescribeControlPanelResponse :: Int -> DescribeControlPanelResponse
- data DescribeRoutingControl = DescribeRoutingControl' Text
- newDescribeRoutingControl :: Text -> DescribeRoutingControl
- data DescribeRoutingControlResponse = DescribeRoutingControlResponse' (Maybe RoutingControl) Int
- newDescribeRoutingControlResponse :: Int -> DescribeRoutingControlResponse
- data DescribeSafetyRule = DescribeSafetyRule' Text
- newDescribeSafetyRule :: Text -> DescribeSafetyRule
- data DescribeSafetyRuleResponse = DescribeSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int
- newDescribeSafetyRuleResponse :: Int -> DescribeSafetyRuleResponse
- data ListAssociatedRoute53HealthChecks = ListAssociatedRoute53HealthChecks' (Maybe Natural) (Maybe Text) Text
- newListAssociatedRoute53HealthChecks :: Text -> ListAssociatedRoute53HealthChecks
- data ListAssociatedRoute53HealthChecksResponse = ListAssociatedRoute53HealthChecksResponse' (Maybe [Text]) (Maybe Text) Int
- newListAssociatedRoute53HealthChecksResponse :: Int -> ListAssociatedRoute53HealthChecksResponse
- data ListClusters = ListClusters' (Maybe Natural) (Maybe Text)
- newListClusters :: ListClusters
- data ListClustersResponse = ListClustersResponse' (Maybe [Cluster]) (Maybe Text) Int
- newListClustersResponse :: Int -> ListClustersResponse
- data ListControlPanels = ListControlPanels' (Maybe Text) (Maybe Natural) (Maybe Text)
- newListControlPanels :: ListControlPanels
- data ListControlPanelsResponse = ListControlPanelsResponse' (Maybe [ControlPanel]) (Maybe Text) Int
- newListControlPanelsResponse :: Int -> ListControlPanelsResponse
- data ListRoutingControls = ListRoutingControls' (Maybe Natural) (Maybe Text) Text
- newListRoutingControls :: Text -> ListRoutingControls
- data ListRoutingControlsResponse = ListRoutingControlsResponse' (Maybe Text) (Maybe [RoutingControl]) Int
- newListRoutingControlsResponse :: Int -> ListRoutingControlsResponse
- data ListSafetyRules = ListSafetyRules' (Maybe Natural) (Maybe Text) Text
- newListSafetyRules :: Text -> ListSafetyRules
- data ListSafetyRulesResponse = ListSafetyRulesResponse' (Maybe Text) (Maybe [Rule]) Int
- newListSafetyRulesResponse :: Int -> ListSafetyRulesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateControlPanel = UpdateControlPanel' Text Text
- newUpdateControlPanel :: Text -> Text -> UpdateControlPanel
- data UpdateControlPanelResponse = UpdateControlPanelResponse' (Maybe ControlPanel) Int
- newUpdateControlPanelResponse :: Int -> UpdateControlPanelResponse
- data UpdateRoutingControl = UpdateRoutingControl' Text Text
- newUpdateRoutingControl :: Text -> Text -> UpdateRoutingControl
- data UpdateRoutingControlResponse = UpdateRoutingControlResponse' (Maybe RoutingControl) Int
- newUpdateRoutingControlResponse :: Int -> UpdateRoutingControlResponse
- data UpdateSafetyRule = UpdateSafetyRule' (Maybe AssertionRuleUpdate) (Maybe GatingRuleUpdate)
- newUpdateSafetyRule :: UpdateSafetyRule
- data UpdateSafetyRuleResponse = UpdateSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int
- newUpdateSafetyRuleResponse :: Int -> UpdateSafetyRuleResponse
- newtype RuleType where
- RuleType' {
- fromRuleType :: Text
- pattern RuleType_AND :: RuleType
- pattern RuleType_ATLEAST :: RuleType
- pattern RuleType_OR :: RuleType
- RuleType' {
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_DEPLOYED :: Status
- pattern Status_PENDING :: Status
- pattern Status_PENDING_DELETION :: Status
- Status' {
- data AssertionRule = AssertionRule' Status Text Text [Text] RuleConfig Int Text
- newAssertionRule :: Status -> Text -> Text -> RuleConfig -> Int -> Text -> AssertionRule
- data AssertionRuleUpdate = AssertionRuleUpdate' Text Int Text
- newAssertionRuleUpdate :: Text -> Int -> Text -> AssertionRuleUpdate
- data Cluster = Cluster' (Maybe Text) (Maybe [ClusterEndpoint]) (Maybe Text) (Maybe Status)
- newCluster :: Cluster
- data ClusterEndpoint = ClusterEndpoint' (Maybe Text) (Maybe Text)
- newClusterEndpoint :: ClusterEndpoint
- data ControlPanel = ControlPanel' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Status)
- newControlPanel :: ControlPanel
- data GatingRule = GatingRule' Status [Text] Text Text [Text] RuleConfig Int Text
- newGatingRule :: Status -> Text -> Text -> RuleConfig -> Int -> Text -> GatingRule
- data GatingRuleUpdate = GatingRuleUpdate' Text Int Text
- newGatingRuleUpdate :: Text -> Int -> Text -> GatingRuleUpdate
- data NewAssertionRule = NewAssertionRule' Text [Text] RuleConfig Int Text
- newNewAssertionRule :: Text -> RuleConfig -> Int -> Text -> NewAssertionRule
- data NewGatingRule = NewGatingRule' [Text] Text [Text] RuleConfig Int Text
- newNewGatingRule :: Text -> RuleConfig -> Int -> Text -> NewGatingRule
- data RoutingControl = RoutingControl' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Status)
- newRoutingControl :: RoutingControl
- data Rule = Rule' (Maybe AssertionRule) (Maybe GatingRule)
- newRule :: Rule
- data RuleConfig = RuleConfig' RuleType Bool Int
- newRuleConfig :: RuleType -> Bool -> Int -> RuleConfig
Service Configuration
defaultService :: Service Source #
API version 2020-11-02 of the Amazon Route53 Recovery Control Config SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Route53RecoveryControlConfig.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
403 response - You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
409 response - ConflictException. You might be using a predefined variable.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
500 response - InternalServiceError. Temporary service error. Retry the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
404 response - MalformedQueryString. The query string contains a syntax error or resource not found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
402 response - You attempted to create more resources than the service allows based on service quotas.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
429 response - LimitExceededException or TooManyRequestsException.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
ClusterCreated
newClusterCreated :: Wait DescribeCluster Source #
Polls DescribeCluster every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
ClusterDeleted
newClusterDeleted :: Wait DescribeCluster Source #
Polls DescribeCluster every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
ControlPanelCreated
newControlPanelCreated :: Wait DescribeControlPanel Source #
Polls DescribeControlPanel every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
ControlPanelDeleted
newControlPanelDeleted :: Wait DescribeControlPanel Source #
Polls DescribeControlPanel every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
RoutingControlCreated
newRoutingControlCreated :: Wait DescribeRoutingControl Source #
Polls DescribeRoutingControl every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
RoutingControlDeleted
newRoutingControlDeleted :: Wait DescribeRoutingControl Source #
Polls DescribeRoutingControl every 5 seconds until a successful state is reached. An error is returned after 26 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCluster
data CreateCluster Source #
Creates a cluster.
See: newCreateCluster smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateCluster |
Create a value of CreateCluster 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:CreateCluster', createCluster_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.
$sel:tags:CreateCluster', createCluster_tags - The tags associated with the cluster.
$sel:clusterName:CreateCluster', createCluster_clusterName - The name of the cluster.
data CreateClusterResponse Source #
See: newCreateClusterResponse smart constructor.
Constructors
| CreateClusterResponse' (Maybe Cluster) Int |
Instances
newCreateClusterResponse Source #
Create a value of CreateClusterResponse 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:cluster:CreateClusterResponse', createClusterResponse_cluster - The cluster that was created.
$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.
CreateControlPanel
data CreateControlPanel Source #
The details of the control panel that you're creating.
See: newCreateControlPanel smart constructor.
Instances
newCreateControlPanel Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateControlPanel |
Create a value of CreateControlPanel 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:CreateControlPanel', createControlPanel_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.
$sel:tags:CreateControlPanel', createControlPanel_tags - The tags associated with the control panel.
CreateControlPanel, createControlPanel_clusterArn - The Amazon Resource Name (ARN) of the cluster for the control panel.
$sel:controlPanelName:CreateControlPanel', createControlPanel_controlPanelName - The name of the control panel.
data CreateControlPanelResponse Source #
See: newCreateControlPanelResponse smart constructor.
Constructors
| CreateControlPanelResponse' (Maybe ControlPanel) Int |
Instances
newCreateControlPanelResponse Source #
Create a value of CreateControlPanelResponse 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:controlPanel:CreateControlPanelResponse', createControlPanelResponse_controlPanel - Information about a control panel.
$sel:httpStatus:CreateControlPanelResponse', createControlPanelResponse_httpStatus - The response's http status code.
CreateRoutingControl
data CreateRoutingControl Source #
The details of the routing control that you're creating.
See: newCreateRoutingControl smart constructor.
Instances
newCreateRoutingControl Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateRoutingControl |
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.
data CreateRoutingControlResponse Source #
See: newCreateRoutingControlResponse smart constructor.
Constructors
| CreateRoutingControlResponse' (Maybe RoutingControl) Int |
Instances
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.
CreateSafetyRule
data CreateSafetyRule Source #
The request body that you include when you create a safety rule.
See: newCreateSafetyRule smart constructor.
Constructors
| CreateSafetyRule' (Maybe NewAssertionRule) (Maybe Text) (Maybe NewGatingRule) (Maybe (HashMap Text Text)) |
Instances
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.
data CreateSafetyRuleResponse Source #
See: newCreateSafetyRuleResponse smart constructor.
Constructors
| CreateSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int |
Instances
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.
DeleteCluster
data DeleteCluster Source #
See: newDeleteCluster smart constructor.
Constructors
| DeleteCluster' Text |
Instances
Arguments
| :: Text | |
| -> DeleteCluster |
Create a value of DeleteCluster 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:
DeleteCluster, deleteCluster_clusterArn - The Amazon Resource Name (ARN) of the cluster that you're deleting.
data DeleteClusterResponse Source #
See: newDeleteClusterResponse smart constructor.
Constructors
| DeleteClusterResponse' Int |
Instances
newDeleteClusterResponse Source #
Create a value of DeleteClusterResponse 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:DeleteClusterResponse', deleteClusterResponse_httpStatus - The response's http status code.
DeleteControlPanel
data DeleteControlPanel Source #
See: newDeleteControlPanel smart constructor.
Constructors
| DeleteControlPanel' Text |
Instances
newDeleteControlPanel Source #
Arguments
| :: Text | |
| -> DeleteControlPanel |
Create a value of DeleteControlPanel 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:
DeleteControlPanel, deleteControlPanel_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
data DeleteControlPanelResponse Source #
See: newDeleteControlPanelResponse smart constructor.
Constructors
| DeleteControlPanelResponse' Int |
Instances
newDeleteControlPanelResponse Source #
Create a value of DeleteControlPanelResponse 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:DeleteControlPanelResponse', deleteControlPanelResponse_httpStatus - The response's http status code.
DeleteRoutingControl
data DeleteRoutingControl Source #
See: newDeleteRoutingControl smart constructor.
Constructors
| DeleteRoutingControl' Text |
Instances
newDeleteRoutingControl Source #
Arguments
| :: Text | |
| -> DeleteRoutingControl |
Create a value of DeleteRoutingControl 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:
DeleteRoutingControl, deleteRoutingControl_routingControlArn - The Amazon Resource Name (ARN) of the routing control that you're
deleting.
data DeleteRoutingControlResponse Source #
See: newDeleteRoutingControlResponse smart constructor.
Constructors
| DeleteRoutingControlResponse' Int |
Instances
newDeleteRoutingControlResponse Source #
Create a value of DeleteRoutingControlResponse 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:DeleteRoutingControlResponse', deleteRoutingControlResponse_httpStatus - The response's http status code.
DeleteSafetyRule
data DeleteSafetyRule Source #
See: newDeleteSafetyRule smart constructor.
Constructors
| DeleteSafetyRule' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSafetyRule |
Create a value of DeleteSafetyRule 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:
DeleteSafetyRule, deleteSafetyRule_safetyRuleArn - The ARN of the safety rule.
data DeleteSafetyRuleResponse Source #
See: newDeleteSafetyRuleResponse smart constructor.
Constructors
| DeleteSafetyRuleResponse' Int |
Instances
newDeleteSafetyRuleResponse Source #
Create a value of DeleteSafetyRuleResponse 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:DeleteSafetyRuleResponse', deleteSafetyRuleResponse_httpStatus - The response's http status code.
DescribeCluster
data DescribeCluster Source #
See: newDescribeCluster smart constructor.
Constructors
| DescribeCluster' Text |
Instances
Arguments
| :: Text | |
| -> DescribeCluster |
Create a value of DescribeCluster 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:
DescribeCluster, describeCluster_clusterArn - The Amazon Resource Name (ARN) of the cluster.
data DescribeClusterResponse Source #
See: newDescribeClusterResponse smart constructor.
Constructors
| DescribeClusterResponse' (Maybe Cluster) Int |
Instances
newDescribeClusterResponse Source #
Create a value of DescribeClusterResponse 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:cluster:DescribeClusterResponse', describeClusterResponse_cluster - The cluster for the DescribeCluster request.
$sel:httpStatus:DescribeClusterResponse', describeClusterResponse_httpStatus - The response's http status code.
DescribeControlPanel
data DescribeControlPanel Source #
See: newDescribeControlPanel smart constructor.
Constructors
| DescribeControlPanel' Text |
Instances
newDescribeControlPanel Source #
Arguments
| :: Text | |
| -> DescribeControlPanel |
Create a value of DescribeControlPanel 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:
DescribeControlPanel, describeControlPanel_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
data DescribeControlPanelResponse Source #
See: newDescribeControlPanelResponse smart constructor.
Constructors
| DescribeControlPanelResponse' (Maybe ControlPanel) Int |
Instances
newDescribeControlPanelResponse Source #
Create a value of DescribeControlPanelResponse 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:controlPanel:DescribeControlPanelResponse', describeControlPanelResponse_controlPanel - Information about the control panel.
$sel:httpStatus:DescribeControlPanelResponse', describeControlPanelResponse_httpStatus - The response's http status code.
DescribeRoutingControl
data DescribeRoutingControl Source #
See: newDescribeRoutingControl smart constructor.
Constructors
| DescribeRoutingControl' Text |
Instances
newDescribeRoutingControl Source #
Arguments
| :: Text | |
| -> DescribeRoutingControl |
Create a value of DescribeRoutingControl 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:
DescribeRoutingControl, describeRoutingControl_routingControlArn - The Amazon Resource Name (ARN) of the routing control.
data DescribeRoutingControlResponse Source #
See: newDescribeRoutingControlResponse smart constructor.
Constructors
| DescribeRoutingControlResponse' (Maybe RoutingControl) Int |
Instances
newDescribeRoutingControlResponse Source #
Create a value of DescribeRoutingControlResponse 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:DescribeRoutingControlResponse', describeRoutingControlResponse_routingControl - Information about the routing control.
$sel:httpStatus:DescribeRoutingControlResponse', describeRoutingControlResponse_httpStatus - The response's http status code.
DescribeSafetyRule
data DescribeSafetyRule Source #
See: newDescribeSafetyRule smart constructor.
Constructors
| DescribeSafetyRule' Text |
Instances
newDescribeSafetyRule Source #
Arguments
| :: Text | |
| -> DescribeSafetyRule |
Create a value of DescribeSafetyRule 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:
DescribeSafetyRule, describeSafetyRule_safetyRuleArn - The ARN of the safety rule.
data DescribeSafetyRuleResponse Source #
See: newDescribeSafetyRuleResponse smart constructor.
Constructors
| DescribeSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int |
Instances
newDescribeSafetyRuleResponse Source #
Create a value of DescribeSafetyRuleResponse 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:assertionRule:DescribeSafetyRuleResponse', describeSafetyRuleResponse_assertionRule - The assertion rule in the response.
$sel:gatingRule:DescribeSafetyRuleResponse', describeSafetyRuleResponse_gatingRule - The gating rule in the response.
$sel:httpStatus:DescribeSafetyRuleResponse', describeSafetyRuleResponse_httpStatus - The response's http status code.
ListAssociatedRoute53HealthChecks (Paginated)
data ListAssociatedRoute53HealthChecks Source #
See: newListAssociatedRoute53HealthChecks smart constructor.
Instances
newListAssociatedRoute53HealthChecks Source #
Create a value of ListAssociatedRoute53HealthChecks 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:maxResults:ListAssociatedRoute53HealthChecks', listAssociatedRoute53HealthChecks_maxResults - The number of objects that you want to return with this call.
ListAssociatedRoute53HealthChecks, listAssociatedRoute53HealthChecks_nextToken - The token that identifies which batch of results you want to see.
ListAssociatedRoute53HealthChecks, listAssociatedRoute53HealthChecks_routingControlArn - The Amazon Resource Name (ARN) of the routing control.
data ListAssociatedRoute53HealthChecksResponse Source #
See: newListAssociatedRoute53HealthChecksResponse smart constructor.
Instances
newListAssociatedRoute53HealthChecksResponse Source #
Arguments
| :: Int | |
| -> ListAssociatedRoute53HealthChecksResponse |
Create a value of ListAssociatedRoute53HealthChecksResponse 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:healthCheckIds:ListAssociatedRoute53HealthChecksResponse', listAssociatedRoute53HealthChecksResponse_healthCheckIds - Identifiers for the health checks.
ListAssociatedRoute53HealthChecks, listAssociatedRoute53HealthChecksResponse_nextToken - Next token for listing health checks.
$sel:httpStatus:ListAssociatedRoute53HealthChecksResponse', listAssociatedRoute53HealthChecksResponse_httpStatus - The response's http status code.
ListClusters (Paginated)
data ListClusters Source #
See: newListClusters smart constructor.
Constructors
| ListClusters' (Maybe Natural) (Maybe Text) |
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters 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:maxResults:ListClusters', listClusters_maxResults - The number of objects that you want to return with this call.
ListClusters, listClusters_nextToken - The token that identifies which batch of results you want to see.
data ListClustersResponse Source #
See: newListClustersResponse smart constructor.
Instances
newListClustersResponse Source #
Arguments
| :: Int | |
| -> ListClustersResponse |
Create a value of ListClustersResponse 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:clusters:ListClustersResponse', listClustersResponse_clusters - An array of the clusters in an account.
ListClusters, listClustersResponse_nextToken - The token that identifies which batch of results you want to see.
$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.
ListControlPanels (Paginated)
data ListControlPanels Source #
See: newListControlPanels smart constructor.
Instances
newListControlPanels :: ListControlPanels Source #
Create a value of ListControlPanels 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:
ListControlPanels, listControlPanels_clusterArn - The Amazon Resource Name (ARN) of a cluster.
$sel:maxResults:ListControlPanels', listControlPanels_maxResults - The number of objects that you want to return with this call.
ListControlPanels, listControlPanels_nextToken - The token that identifies which batch of results you want to see.
data ListControlPanelsResponse Source #
See: newListControlPanelsResponse smart constructor.
Constructors
| ListControlPanelsResponse' (Maybe [ControlPanel]) (Maybe Text) Int |
Instances
newListControlPanelsResponse Source #
Create a value of ListControlPanelsResponse 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:controlPanels:ListControlPanelsResponse', listControlPanelsResponse_controlPanels - The result of a successful ListControlPanel request.
ListControlPanels, listControlPanelsResponse_nextToken - The token that identifies which batch of results you want to see.
$sel:httpStatus:ListControlPanelsResponse', listControlPanelsResponse_httpStatus - The response's http status code.
ListRoutingControls (Paginated)
data ListRoutingControls Source #
See: newListRoutingControls smart constructor.
Instances
newListRoutingControls Source #
Arguments
| :: Text | |
| -> ListRoutingControls |
Create a value of ListRoutingControls 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:maxResults:ListRoutingControls', listRoutingControls_maxResults - The number of objects that you want to return with this call.
ListRoutingControls, listRoutingControls_nextToken - The token that identifies which batch of results you want to see.
ListRoutingControls, listRoutingControls_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
data ListRoutingControlsResponse Source #
See: newListRoutingControlsResponse smart constructor.
Constructors
| ListRoutingControlsResponse' (Maybe Text) (Maybe [RoutingControl]) Int |
Instances
newListRoutingControlsResponse Source #
Create a value of ListRoutingControlsResponse 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:
ListRoutingControls, listRoutingControlsResponse_nextToken - The token that identifies which batch of results you want to see.
$sel:routingControls:ListRoutingControlsResponse', listRoutingControlsResponse_routingControls - An array of routing controls.
$sel:httpStatus:ListRoutingControlsResponse', listRoutingControlsResponse_httpStatus - The response's http status code.
ListSafetyRules (Paginated)
data ListSafetyRules Source #
See: newListSafetyRules smart constructor.
Instances
Arguments
| :: Text | |
| -> ListSafetyRules |
Create a value of ListSafetyRules 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:maxResults:ListSafetyRules', listSafetyRules_maxResults - The number of objects that you want to return with this call.
ListSafetyRules, listSafetyRules_nextToken - The token that identifies which batch of results you want to see.
ListSafetyRules, listSafetyRules_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
data ListSafetyRulesResponse Source #
See: newListSafetyRulesResponse smart constructor.
Instances
newListSafetyRulesResponse Source #
Create a value of ListSafetyRulesResponse 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:
ListSafetyRules, listSafetyRulesResponse_nextToken - The token that identifies which batch of results you want to see.
$sel:safetyRules:ListSafetyRulesResponse', listSafetyRulesResponse_safetyRules - The list of safety rules in a control panel.
$sel:httpStatus:ListSafetyRulesResponse', listSafetyRulesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) for the resource that's tagged.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags associated with the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
Request of adding tag to the resource
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) for the resource that's tagged.
$sel:tags:TagResource', tagResource_tags - The tags associated with the resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) for the resource that's tagged.
$sel:tagKeys:UntagResource', untagResource_tagKeys - Keys for the tags to be removed.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateControlPanel
data UpdateControlPanel Source #
The details of the control panel that you're updating.
See: newUpdateControlPanel smart constructor.
Constructors
| UpdateControlPanel' Text Text |
Instances
newUpdateControlPanel Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateControlPanel |
Create a value of UpdateControlPanel 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:
UpdateControlPanel, updateControlPanel_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
$sel:controlPanelName:UpdateControlPanel', updateControlPanel_controlPanelName - The name of the control panel.
data UpdateControlPanelResponse Source #
See: newUpdateControlPanelResponse smart constructor.
Constructors
| UpdateControlPanelResponse' (Maybe ControlPanel) Int |
Instances
newUpdateControlPanelResponse Source #
Create a value of UpdateControlPanelResponse 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:controlPanel:UpdateControlPanelResponse', updateControlPanelResponse_controlPanel - The control panel to update.
$sel:httpStatus:UpdateControlPanelResponse', updateControlPanelResponse_httpStatus - The response's http status code.
UpdateRoutingControl
data UpdateRoutingControl Source #
The details of the routing control that you're updating.
See: newUpdateRoutingControl smart constructor.
Constructors
| UpdateRoutingControl' Text Text |
Instances
newUpdateRoutingControl Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateRoutingControl |
Create a value of UpdateRoutingControl 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:routingControlName:UpdateRoutingControl', updateRoutingControl_routingControlName - The name of the routing control.
UpdateRoutingControl, updateRoutingControl_routingControlArn - The Amazon Resource Name (ARN) of the routing control.
data UpdateRoutingControlResponse Source #
See: newUpdateRoutingControlResponse smart constructor.
Constructors
| UpdateRoutingControlResponse' (Maybe RoutingControl) Int |
Instances
newUpdateRoutingControlResponse Source #
Create a value of UpdateRoutingControlResponse 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:UpdateRoutingControlResponse', updateRoutingControlResponse_routingControl - The routing control that was updated.
$sel:httpStatus:UpdateRoutingControlResponse', updateRoutingControlResponse_httpStatus - The response's http status code.
UpdateSafetyRule
data UpdateSafetyRule Source #
A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.
See: newUpdateSafetyRule smart constructor.
Constructors
| UpdateSafetyRule' (Maybe AssertionRuleUpdate) (Maybe GatingRuleUpdate) |
Instances
newUpdateSafetyRule :: UpdateSafetyRule Source #
Create a value of UpdateSafetyRule 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:assertionRuleUpdate:UpdateSafetyRule', updateSafetyRule_assertionRuleUpdate - The assertion rule to update.
$sel:gatingRuleUpdate:UpdateSafetyRule', updateSafetyRule_gatingRuleUpdate - The gating rule to update.
data UpdateSafetyRuleResponse Source #
See: newUpdateSafetyRuleResponse smart constructor.
Constructors
| UpdateSafetyRuleResponse' (Maybe AssertionRule) (Maybe GatingRule) Int |
Instances
newUpdateSafetyRuleResponse Source #
Create a value of UpdateSafetyRuleResponse 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:assertionRule:UpdateSafetyRuleResponse', updateSafetyRuleResponse_assertionRule - The assertion rule updated.
$sel:gatingRule:UpdateSafetyRuleResponse', updateSafetyRuleResponse_gatingRule - The gating rule updated.
$sel:httpStatus:UpdateSafetyRuleResponse', updateSafetyRuleResponse_httpStatus - The response's http status code.
Types
RuleType
An enumerated type that determines how the evaluated rules are processed. RuleType can be one of the following:
ATLEAST - At least N routing controls must be set. You specify N as the Threshold in the rule configuration.
AND - All routing controls must be set. This is a shortcut for "At least N," where N is the total number of controls in the rule.
OR - Any control must be set. This is a shortcut for "At least N," where N is 1.
Constructors
| RuleType' | |
Fields
| |
Bundled Patterns
| pattern RuleType_AND :: RuleType | |
| pattern RuleType_ATLEAST :: RuleType | |
| pattern RuleType_OR :: RuleType |
Instances
Status
The deployment status of a resource. Status can be one of the following:
PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.
DEPLOYED: The resource is deployed and ready to use.
PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_DEPLOYED :: Status | |
| pattern Status_PENDING :: Status | |
| pattern Status_PENDING_DELETION :: Status |
Instances
AssertionRule
data AssertionRule Source #
An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control is not accepted. 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.
See: newAssertionRule smart constructor.
Constructors
| AssertionRule' Status Text Text [Text] RuleConfig Int Text |
Instances
Arguments
| :: Status | |
| -> Text | |
| -> Text | |
| -> RuleConfig | |
| -> Int | |
| -> Text | |
| -> AssertionRule |
Create a value of AssertionRule 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:status:AssertionRule', assertionRule_status - The deployment status of an assertion rule. Status can be one of the
following: PENDING, DEPLOYED, PENDING_DELETION.
$sel:controlPanelArn:AssertionRule', assertionRule_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
$sel:safetyRuleArn:AssertionRule', assertionRule_safetyRuleArn - The Amazon Resource Name (ARN) of the assertion rule.
$sel:assertedControls:AssertionRule', assertionRule_assertedControls - 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.
$sel:ruleConfig:AssertionRule', assertionRule_ruleConfig - The criteria that you set for specific assertion routing controls
(AssertedControls) that designate how many routing control states must
be ON as the result of a transaction. For example, if you have three
assertion routing controls, you might specify ATLEAST 2 for your rule
configuration. This means that at least two assertion routing control
states must be ON, so that at least two Amazon Web Services Regions have
traffic flowing to them.
$sel:waitPeriodMs:AssertionRule', assertionRule_waitPeriodMs - 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.
$sel:name:AssertionRule', assertionRule_name - Name of the assertion rule. You can use any non-white space character in
the name.
AssertionRuleUpdate
data AssertionRuleUpdate Source #
An update to an assertion rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
See: newAssertionRuleUpdate smart constructor.
Constructors
| AssertionRuleUpdate' Text Int Text |
Instances
newAssertionRuleUpdate Source #
Arguments
| :: Text | |
| -> Int | |
| -> Text | |
| -> AssertionRuleUpdate |
Create a value of AssertionRuleUpdate 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:safetyRuleArn:AssertionRuleUpdate', assertionRuleUpdate_safetyRuleArn - The Amazon Resource Name (ARN) of the assertion rule.
$sel:waitPeriodMs:AssertionRuleUpdate', assertionRuleUpdate_waitPeriodMs - 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.
$sel:name:AssertionRuleUpdate', assertionRuleUpdate_name - The name of the assertion rule. You can use any non-white space
character in the name.
Cluster
A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.
See: newCluster smart constructor.
Instances
| FromJSON Cluster Source # | |
| Generic Cluster Source # | |
| Read Cluster Source # | |
| Show Cluster Source # | |
| NFData Cluster Source # | |
| Eq Cluster Source # | |
| Hashable Cluster Source # | |
| type Rep Cluster Source # | |
Defined in Amazonka.Route53RecoveryControlConfig.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.Route53RecoveryControlConfig.Types.Cluster" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clusterEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterEndpoint]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status))))) | |
newCluster :: Cluster Source #
Create a value of Cluster 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:clusterArn:Cluster', cluster_clusterArn - The Amazon Resource Name (ARN) of the cluster.
$sel:clusterEndpoints:Cluster', cluster_clusterEndpoints - 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 Routing Control Actions.
$sel:name:Cluster', cluster_name - The name of the cluster.
$sel:status:Cluster', cluster_status - Deployment status of a resource. Status can be one of the following:
PENDING, DEPLOYED, PENDING_DELETION.
ClusterEndpoint
data ClusterEndpoint Source #
A cluster endpoint. Specify an endpoint when you want to set or retrieve a routing control state in the cluster.
See: newClusterEndpoint smart constructor.
Constructors
| ClusterEndpoint' (Maybe Text) (Maybe Text) |
Instances
newClusterEndpoint :: ClusterEndpoint Source #
Create a value of ClusterEndpoint 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:endpoint:ClusterEndpoint', clusterEndpoint_endpoint - 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 Routing Control Actions.
$sel:region:ClusterEndpoint', clusterEndpoint_region - The Amazon Web Services Region for a cluster endpoint.
ControlPanel
data ControlPanel Source #
A control panel represents a group of routing controls that can be changed together in a single transaction.
See: newControlPanel smart constructor.
Constructors
| ControlPanel' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Status) |
Instances
newControlPanel :: ControlPanel Source #
Create a value of ControlPanel 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:clusterArn:ControlPanel', controlPanel_clusterArn - The Amazon Resource Name (ARN) of the cluster that includes the control
panel.
$sel:controlPanelArn:ControlPanel', controlPanel_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
$sel:defaultControlPanel:ControlPanel', controlPanel_defaultControlPanel - 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.
$sel:name:ControlPanel', controlPanel_name - The name of the control panel. You can use any non-white space character
in the name.
$sel:routingControlCount:ControlPanel', controlPanel_routingControlCount - The number of routing controls in the control panel.
$sel:status:ControlPanel', controlPanel_status - The deployment status of control panel. Status can be one of the
following: PENDING, DEPLOYED, PENDING_DELETION.
GatingRule
data GatingRule Source #
A gating rule verifies that a gating routing control or set of gating routing controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
See: newGatingRule smart constructor.
Constructors
| GatingRule' Status [Text] Text Text [Text] RuleConfig Int Text |
Instances
Arguments
| :: Status | |
| -> Text | |
| -> Text | |
| -> RuleConfig | |
| -> Int | |
| -> Text | |
| -> GatingRule |
Create a value of GatingRule 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:status:GatingRule', gatingRule_status - The deployment status of a gating rule. Status can be one of the
following: PENDING, DEPLOYED, PENDING_DELETION.
$sel:targetControls:GatingRule', gatingRule_targetControls - An array of target routing control Amazon Resource Names (ARNs) for
which the states can only be updated if the rule configuration that you
specify evaluates to true for the gating routing control. As a simple
example, if you have a single gating control, it acts as an overall
"on/off" switch for a set of target routing controls. You can use
this to manually override automated failover, for example.
$sel:controlPanelArn:GatingRule', gatingRule_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
$sel:safetyRuleArn:GatingRule', gatingRule_safetyRuleArn - The Amazon Resource Name (ARN) of the gating rule.
$sel:gatingControls:GatingRule', gatingRule_gatingControls - An array of gating routing control Amazon Resource Names (ARNs). For a
simple "on/off" switch, specify the ARN for one routing control. The
gating routing controls are evaluated by the rule configuration that you
specify to determine if the target routing control states can be
changed.
$sel:ruleConfig:GatingRule', gatingRule_ruleConfig - The criteria that you set for gating routing controls that designate how
many of the routing control states must be ON to allow you to update
target routing control states.
$sel:waitPeriodMs:GatingRule', gatingRule_waitPeriodMs - 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.
$sel:name:GatingRule', gatingRule_name - The name for the gating rule. You can use any non-white space character
in the name.
GatingRuleUpdate
data GatingRuleUpdate Source #
Update to a gating rule. You can update the name or the evaluation period (wait period). If you don't specify one of the items to update, the item is unchanged.
See: newGatingRuleUpdate smart constructor.
Constructors
| GatingRuleUpdate' Text Int Text |
Instances
Arguments
| :: Text | |
| -> Int | |
| -> Text | |
| -> GatingRuleUpdate |
Create a value of GatingRuleUpdate 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:safetyRuleArn:GatingRuleUpdate', gatingRuleUpdate_safetyRuleArn - The Amazon Resource Name (ARN) of the gating rule.
$sel:waitPeriodMs:GatingRuleUpdate', gatingRuleUpdate_waitPeriodMs - 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.
$sel:name:GatingRuleUpdate', gatingRuleUpdate_name - The name for the gating rule. You can use any non-white space character
in the name.
NewAssertionRule
data NewAssertionRule Source #
A new assertion rule for a control panel.
See: newNewAssertionRule smart constructor.
Constructors
| NewAssertionRule' Text [Text] RuleConfig Int Text |
Instances
Arguments
| :: Text | |
| -> RuleConfig | |
| -> Int | |
| -> Text | |
| -> NewAssertionRule |
Create a value of NewAssertionRule 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:controlPanelArn:NewAssertionRule', newAssertionRule_controlPanelArn - The Amazon Resource Name (ARN) for the control panel.
$sel:assertedControls:NewAssertionRule', newAssertionRule_assertedControls - 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.
$sel:ruleConfig:NewAssertionRule', newAssertionRule_ruleConfig - The criteria that you set for specific assertion controls (routing
controls) that designate how many control states must be ON 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 ON, so that at least
two Amazon Web Services Regions have traffic flowing to them.
$sel:waitPeriodMs:NewAssertionRule', newAssertionRule_waitPeriodMs - 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.
$sel:name:NewAssertionRule', newAssertionRule_name - The name of the assertion rule. You can use any non-white space
character in the name.
NewGatingRule
data NewGatingRule Source #
A new gating rule for a control panel.
See: newNewGatingRule smart constructor.
Constructors
| NewGatingRule' [Text] Text [Text] RuleConfig Int Text |
Instances
Arguments
| :: Text | |
| -> RuleConfig | |
| -> Int | |
| -> Text | |
| -> NewGatingRule |
Create a value of NewGatingRule 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:targetControls:NewGatingRule', newGatingRule_targetControls - 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.
$sel:controlPanelArn:NewGatingRule', newGatingRule_controlPanelArn - The Amazon Resource Name (ARN) of the control panel.
$sel:gatingControls:NewGatingRule', newGatingRule_gatingControls - The gating controls for the new gating rule. That is, routing controls
that are evaluated by the rule configuration that you specify.
$sel:ruleConfig:NewGatingRule', newGatingRule_ruleConfig - The criteria that you set for specific gating controls (routing
controls) that designate how many control states must be ON to allow you
to change (set or unset) the target control states.
$sel:waitPeriodMs:NewGatingRule', newGatingRule_waitPeriodMs - 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.
$sel:name:NewGatingRule', newGatingRule_name - The name for the new gating rule.
RoutingControl
data RoutingControl Source #
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.
See: newRoutingControl smart constructor.
Instances
newRoutingControl :: RoutingControl Source #
Create a value of RoutingControl 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:controlPanelArn:RoutingControl', routingControl_controlPanelArn - The Amazon Resource Name (ARN) of the control panel that includes the
routing control.
$sel:name:RoutingControl', routingControl_name - The name of the routing control.
$sel:routingControlArn:RoutingControl', routingControl_routingControlArn - The Amazon Resource Name (ARN) of the routing control.
$sel:status:RoutingControl', routingControl_status - The deployment status of a routing control. Status can be one of the
following: PENDING, DEPLOYED, PENDING_DELETION.
Rule
A safety rule. A safety rule can be an assertion rule or a gating rule.
See: newRule smart constructor.
Constructors
| Rule' (Maybe AssertionRule) (Maybe GatingRule) |
Instances
| FromJSON Rule Source # | |
| Generic Rule Source # | |
| Read Rule Source # | |
| Show Rule Source # | |
| NFData Rule Source # | |
| Eq Rule Source # | |
| Hashable Rule Source # | |
| type Rep Rule Source # | |
Defined in Amazonka.Route53RecoveryControlConfig.Types.Rule type Rep Rule = D1 ('MetaData "Rule" "Amazonka.Route53RecoveryControlConfig.Types.Rule" "amazonka-route53-recovery-control-config-2.0-EdxrPdjlafWED9VxY6nLf4" 'False) (C1 ('MetaCons "Rule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assertion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssertionRule)) :*: S1 ('MetaSel ('Just "gating") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatingRule)))) | |
Create a value of Rule 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:assertion:Rule', rule_assertion - 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 state is not accepted. 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.
$sel:gating:Rule', rule_gating - A gating rule verifies that a gating routing control or set of gating
routing controls, evaluates as true, based on a rule configuration that
you specify, which allows a set of routing control state changes to
complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control "switch" to be "On". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
RuleConfig
data RuleConfig Source #
The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many control states must be ON after a transaction completes.
See: newRuleConfig smart constructor.
Constructors
| RuleConfig' RuleType Bool Int |
Instances
Arguments
| :: RuleType | |
| -> Bool | |
| -> Int | |
| -> RuleConfig |
Create a value of RuleConfig 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:type':RuleConfig', ruleConfig_type - A rule can be one of the following: ATLEAST, AND, or OR.
$sel:inverted:RuleConfig', ruleConfig_inverted - Logical negation of the rule. If the rule would usually evaluate true,
it's evaluated as false, and vice versa.
$sel:threshold:RuleConfig', ruleConfig_threshold - 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.