amazonka-route53-recovery-readiness-2.0: Amazon Route53 Recovery Readiness 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.Route53RecoveryReadiness.Lens

Description

 
Synopsis

Operations

CreateCell

createCell_cells :: Lens' CreateCell (Maybe [Text]) Source #

A list of cell Amazon Resource Names (ARNs) contained within this cell, for use in nested cells. For example, Availability Zones within specific Amazon Web Services Regions.

createCell_cellName :: Lens' CreateCell Text Source #

The name of the cell to create.

createCellResponse_cellArn :: Lens' CreateCellResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cell.

createCellResponse_parentReadinessScopes :: Lens' CreateCellResponse (Maybe [Text]) Source #

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

CreateCrossAccountAuthorization

CreateReadinessCheck

createReadinessCheck_readinessCheckName :: Lens' CreateReadinessCheck Text Source #

The name of the readiness check to create.

createReadinessCheckResponse_readinessCheckArn :: Lens' CreateReadinessCheckResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with a readiness check.

CreateRecoveryGroup

createRecoveryGroup_cells :: Lens' CreateRecoveryGroup (Maybe [Text]) Source #

A list of the cell Amazon Resource Names (ARNs) in the recovery group.

createRecoveryGroup_recoveryGroupName :: Lens' CreateRecoveryGroup Text Source #

The name of the recovery group to create.

createRecoveryGroupResponse_cells :: Lens' CreateRecoveryGroupResponse (Maybe [Text]) Source #

A list of a cell's Amazon Resource Names (ARNs).

createRecoveryGroupResponse_recoveryGroupArn :: Lens' CreateRecoveryGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the recovery group.

CreateResourceSet

createResourceSet_tags :: Lens' CreateResourceSet (Maybe (HashMap Text Text)) Source #

A tag to associate with the parameters for a resource set.

createResourceSet_resourceSetType :: Lens' CreateResourceSet Text Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

createResourceSet_resourceSetName :: Lens' CreateResourceSet Text Source #

The name of the resource set to create.

createResourceSet_resources :: Lens' CreateResourceSet [Resource] Source #

A list of resource objects in the resource set.

createResourceSetResponse_resourceSetArn :: Lens' CreateResourceSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the resource set.

createResourceSetResponse_resourceSetType :: Lens' CreateResourceSetResponse (Maybe Text) Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

DeleteCell

DeleteCrossAccountAuthorization

DeleteReadinessCheck

DeleteRecoveryGroup

DeleteResourceSet

GetArchitectureRecommendations

getArchitectureRecommendations_maxResults :: Lens' GetArchitectureRecommendations (Maybe Natural) Source #

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

getArchitectureRecommendations_nextToken :: Lens' GetArchitectureRecommendations (Maybe Text) Source #

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

getArchitectureRecommendationsResponse_lastAuditTimestamp :: Lens' GetArchitectureRecommendationsResponse (Maybe UTCTime) Source #

The time that a recovery group was last assessed for recommendations, in UTC ISO-8601 format.

getArchitectureRecommendationsResponse_nextToken :: Lens' GetArchitectureRecommendationsResponse (Maybe Text) Source #

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

GetCell

getCell_cellName :: Lens' GetCell Text Source #

The name of the cell.

getCellResponse_cellArn :: Lens' GetCellResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cell.

getCellResponse_parentReadinessScopes :: Lens' GetCellResponse (Maybe [Text]) Source #

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

getCellResponse_httpStatus :: Lens' GetCellResponse Int Source #

The response's http status code.

GetCellReadinessSummary

getCellReadinessSummary_maxResults :: Lens' GetCellReadinessSummary (Maybe Natural) Source #

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

getCellReadinessSummary_nextToken :: Lens' GetCellReadinessSummary (Maybe Text) Source #

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

getCellReadinessSummaryResponse_nextToken :: Lens' GetCellReadinessSummaryResponse (Maybe Text) Source #

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

GetReadinessCheck

getReadinessCheckResponse_readinessCheckArn :: Lens' GetReadinessCheckResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with a readiness check.

GetReadinessCheckResourceStatus

getReadinessCheckResourceStatus_maxResults :: Lens' GetReadinessCheckResourceStatus (Maybe Natural) Source #

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

getReadinessCheckResourceStatus_nextToken :: Lens' GetReadinessCheckResourceStatus (Maybe Text) Source #

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

getReadinessCheckResourceStatus_resourceIdentifier :: Lens' GetReadinessCheckResourceStatus Text Source #

The resource identifier, which is the Amazon Resource Name (ARN) or the identifier generated for the resource by Application Recovery Controller (for example, for a DNS target resource).

getReadinessCheckResourceStatusResponse_nextToken :: Lens' GetReadinessCheckResourceStatusResponse (Maybe Text) Source #

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

GetReadinessCheckStatus

getReadinessCheckStatus_maxResults :: Lens' GetReadinessCheckStatus (Maybe Natural) Source #

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

getReadinessCheckStatus_nextToken :: Lens' GetReadinessCheckStatus (Maybe Text) Source #

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

getReadinessCheckStatusResponse_nextToken :: Lens' GetReadinessCheckStatusResponse (Maybe Text) Source #

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

GetRecoveryGroup

getRecoveryGroupResponse_cells :: Lens' GetRecoveryGroupResponse (Maybe [Text]) Source #

A list of a cell's Amazon Resource Names (ARNs).

getRecoveryGroupResponse_recoveryGroupArn :: Lens' GetRecoveryGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the recovery group.

getRecoveryGroupResponse_tags :: Lens' GetRecoveryGroupResponse (Maybe (HashMap Text Text)) Source #

The tags associated with the recovery group.

GetRecoveryGroupReadinessSummary

getRecoveryGroupReadinessSummary_maxResults :: Lens' GetRecoveryGroupReadinessSummary (Maybe Natural) Source #

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

getRecoveryGroupReadinessSummary_nextToken :: Lens' GetRecoveryGroupReadinessSummary (Maybe Text) Source #

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

getRecoveryGroupReadinessSummaryResponse_nextToken :: Lens' GetRecoveryGroupReadinessSummaryResponse (Maybe Text) Source #

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

GetResourceSet

getResourceSetResponse_resourceSetArn :: Lens' GetResourceSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the resource set.

getResourceSetResponse_resourceSetType :: Lens' GetResourceSetResponse (Maybe Text) Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

ListCells

listCells_maxResults :: Lens' ListCells (Maybe Natural) Source #

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

listCells_nextToken :: Lens' ListCells (Maybe Text) Source #

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

listCellsResponse_nextToken :: Lens' ListCellsResponse (Maybe Text) Source #

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

listCellsResponse_httpStatus :: Lens' ListCellsResponse Int Source #

The response's http status code.

ListCrossAccountAuthorizations

listCrossAccountAuthorizations_maxResults :: Lens' ListCrossAccountAuthorizations (Maybe Natural) Source #

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

listCrossAccountAuthorizations_nextToken :: Lens' ListCrossAccountAuthorizations (Maybe Text) Source #

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

listCrossAccountAuthorizationsResponse_nextToken :: Lens' ListCrossAccountAuthorizationsResponse (Maybe Text) Source #

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

ListReadinessChecks

listReadinessChecks_maxResults :: Lens' ListReadinessChecks (Maybe Natural) Source #

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

listReadinessChecks_nextToken :: Lens' ListReadinessChecks (Maybe Text) Source #

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

listReadinessChecksResponse_nextToken :: Lens' ListReadinessChecksResponse (Maybe Text) Source #

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

ListRecoveryGroups

listRecoveryGroups_maxResults :: Lens' ListRecoveryGroups (Maybe Natural) Source #

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

listRecoveryGroups_nextToken :: Lens' ListRecoveryGroups (Maybe Text) Source #

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

listRecoveryGroupsResponse_nextToken :: Lens' ListRecoveryGroupsResponse (Maybe Text) Source #

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

ListResourceSets

listResourceSets_maxResults :: Lens' ListResourceSets (Maybe Natural) Source #

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

listResourceSets_nextToken :: Lens' ListResourceSets (Maybe Text) Source #

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

listResourceSetsResponse_nextToken :: Lens' ListResourceSetsResponse (Maybe Text) Source #

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

listResourceSetsResponse_resourceSets :: Lens' ListResourceSetsResponse (Maybe [ResourceSetOutput]) Source #

A list of resource sets associated with the account.

ListRules

listRules_maxResults :: Lens' ListRules (Maybe Natural) Source #

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

listRules_nextToken :: Lens' ListRules (Maybe Text) Source #

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

listRules_resourceType :: Lens' ListRules (Maybe Text) Source #

The resource type that a readiness rule applies to.

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text) Source #

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

listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [ListRulesOutput]) Source #

A list of readiness rules for a specific resource type.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.

ListTagsForResources

listTagsForResources_resourceArn :: Lens' ListTagsForResources Text Source #

The Amazon Resource Name (ARN) for a resource.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for a resource.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The keys for tags you add to resources.

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for a resource.

UpdateCell

updateCell_cells :: Lens' UpdateCell [Text] Source #

A list of cell Amazon Resource Names (ARNs), which completely replaces the previous list.

updateCellResponse_cellArn :: Lens' UpdateCellResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the cell.

updateCellResponse_parentReadinessScopes :: Lens' UpdateCellResponse (Maybe [Text]) Source #

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

UpdateReadinessCheck

updateReadinessCheck_resourceSetName :: Lens' UpdateReadinessCheck Text Source #

The name of the resource set to be checked.

updateReadinessCheckResponse_readinessCheckArn :: Lens' UpdateReadinessCheckResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) associated with a readiness check.

UpdateRecoveryGroup

updateRecoveryGroup_cells :: Lens' UpdateRecoveryGroup [Text] Source #

A list of cell Amazon Resource Names (ARNs). This list completely replaces the previous list.

updateRecoveryGroupResponse_cells :: Lens' UpdateRecoveryGroupResponse (Maybe [Text]) Source #

A list of a cell's Amazon Resource Names (ARNs).

updateRecoveryGroupResponse_recoveryGroupArn :: Lens' UpdateRecoveryGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the recovery group.

UpdateResourceSet

updateResourceSet_resourceSetType :: Lens' UpdateResourceSet Text Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

updateResourceSetResponse_resourceSetArn :: Lens' UpdateResourceSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the resource set.

updateResourceSetResponse_resourceSetType :: Lens' UpdateResourceSetResponse (Maybe Text) Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

Types

CellOutput

cellOutput_parentReadinessScopes :: Lens' CellOutput [Text] Source #

The readiness scope for the cell, which can be a cell Amazon Resource Name (ARN) or a recovery group ARN. This is a list but currently can have only one element.

cellOutput_cellArn :: Lens' CellOutput Text Source #

The Amazon Resource Name (ARN) for the cell.

cellOutput_cells :: Lens' CellOutput [Text] Source #

A list of cell ARNs.

DNSTargetResource

dNSTargetResource_domainName :: Lens' DNSTargetResource (Maybe Text) Source #

The domain name that acts as an ingress point to a portion of the customer application.

dNSTargetResource_hostedZoneArn :: Lens' DNSTargetResource (Maybe Text) Source #

The hosted zone Amazon Resource Name (ARN) that contains the DNS record with the provided name of the target resource.

dNSTargetResource_recordSetId :: Lens' DNSTargetResource (Maybe Text) Source #

The Route 53 record set ID that uniquely identifies a DNS record, given a name and a type.

dNSTargetResource_recordType :: Lens' DNSTargetResource (Maybe Text) Source #

The type of DNS record of the target resource.

dNSTargetResource_targetResource :: Lens' DNSTargetResource (Maybe TargetResource) Source #

The target resource of the DNS target resource.

ListRulesOutput

listRulesOutput_ruleDescription :: Lens' ListRulesOutput Text Source #

The description of a readiness rule.

listRulesOutput_ruleId :: Lens' ListRulesOutput Text Source #

The ID for the readiness rule.

listRulesOutput_resourceType :: Lens' ListRulesOutput Text Source #

The resource type that the readiness rule applies to.

Message

message_messageText :: Lens' Message (Maybe Text) Source #

The text of a readiness check message.

NLBResource

nLBResource_arn :: Lens' NLBResource (Maybe Text) Source #

The Network Load Balancer resource Amazon Resource Name (ARN).

R53ResourceRecord

r53ResourceRecord_recordSetId :: Lens' R53ResourceRecord (Maybe Text) Source #

The Route 53 Resource Record Set ID.

ReadinessCheckOutput

readinessCheckOutput_readinessCheckArn :: Lens' ReadinessCheckOutput Text Source #

The Amazon Resource Name (ARN) associated with a readiness check.

readinessCheckOutput_resourceSet :: Lens' ReadinessCheckOutput Text Source #

Name of the resource set to be checked.

ReadinessCheckSummary

readinessCheckSummary_readiness :: Lens' ReadinessCheckSummary (Maybe Readiness) Source #

The readiness status of this readiness check.

Recommendation

recommendation_recommendationText :: Lens' Recommendation Text Source #

Text of the recommendations that are provided to make an application more recovery resilient.

RecoveryGroupOutput

recoveryGroupOutput_tags :: Lens' RecoveryGroupOutput (Maybe (HashMap Text Text)) Source #

The tags associated with the recovery group.

recoveryGroupOutput_recoveryGroupArn :: Lens' RecoveryGroupOutput Text Source #

The Amazon Resource Name (ARN) for the recovery group.

recoveryGroupOutput_cells :: Lens' RecoveryGroupOutput [Text] Source #

A list of a cell's Amazon Resource Names (ARNs).

Resource

resource_componentId :: Lens' Resource (Maybe Text) Source #

The component identifier of the resource, generated when DNS target resource is used.

resource_readinessScopes :: Lens' Resource (Maybe [Text]) Source #

A list of recovery group Amazon Resource Names (ARNs) and cell ARNs that this resource is contained within.

resource_resourceArn :: Lens' Resource (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services resource.

ResourceResult

resourceResult_componentId :: Lens' ResourceResult (Maybe Text) Source #

The component id of the resource.

resourceResult_resourceArn :: Lens' ResourceResult (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

resourceResult_lastCheckedTimestamp :: Lens' ResourceResult UTCTime Source #

The time (UTC) that the resource was last checked for readiness, in ISO-8601 format.

ResourceSetOutput

resourceSetOutput_resourceSetType :: Lens' ResourceSetOutput Text Source #

The resource type of the resources in the resource set. Enter one of the following values for resource type:

AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage, AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm, AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume, AWS::ElasticLoadBalancing::LoadBalancer, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function, AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck, AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC, AWS::EC2::VPNConnection, AWS::EC2::VPNGateway, AWS::Route53RecoveryReadiness::DNSTargetResource

resourceSetOutput_resourceSetArn :: Lens' ResourceSetOutput Text Source #

The Amazon Resource Name (ARN) for the resource set.

RuleResult

ruleResult_messages :: Lens' RuleResult [Message] Source #

Details about the resource's readiness.

ruleResult_readiness :: Lens' RuleResult Readiness Source #

The readiness at rule level.

ruleResult_ruleId :: Lens' RuleResult Text Source #

The identifier of the rule.

ruleResult_lastCheckedTimestamp :: Lens' RuleResult UTCTime Source #

The time the resource was last checked for readiness, in ISO-8601 format, UTC.

TargetResource

targetResource_nLBResource :: Lens' TargetResource (Maybe NLBResource) Source #

The Network Load Balancer Resource.