Package software.amazon.awssdk.services.route53recoverycontrolconfig

Interface Route53RecoveryControlConfigClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface Route53RecoveryControlConfigClient
extends AwsClient

Service client for accessing AWS Route53 Recovery Control Config. This can be created using the static builder() method.

Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static Route53RecoveryControlConfigClientBuilder	builder()	Create a builder that can be used to configure and create a Route53RecoveryControlConfigClient.
static Route53RecoveryControlConfigClient	create()	Create a Route53RecoveryControlConfigClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Create a new cluster.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Create a new cluster.
default CreateControlPanelResponse	createControlPanel(Consumer<CreateControlPanelRequest.Builder> createControlPanelRequest)	Creates a new control panel.
default CreateControlPanelResponse	createControlPanel(CreateControlPanelRequest createControlPanelRequest)	Creates a new control panel.
default CreateRoutingControlResponse	createRoutingControl(Consumer<CreateRoutingControlRequest.Builder> createRoutingControlRequest)	Creates a new routing control.
default CreateRoutingControlResponse	createRoutingControl(CreateRoutingControlRequest createRoutingControlRequest)	Creates a new routing control.
default CreateSafetyRuleResponse	createSafetyRule(Consumer<CreateSafetyRuleRequest.Builder> createSafetyRuleRequest)	Creates a safety rule in a control panel.
default CreateSafetyRuleResponse	createSafetyRule(CreateSafetyRuleRequest createSafetyRuleRequest)	Creates a safety rule in a control panel.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Delete a cluster.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Delete a cluster.
default DeleteControlPanelResponse	deleteControlPanel(Consumer<DeleteControlPanelRequest.Builder> deleteControlPanelRequest)	Deletes a control panel.
default DeleteControlPanelResponse	deleteControlPanel(DeleteControlPanelRequest deleteControlPanelRequest)	Deletes a control panel.
default DeleteRoutingControlResponse	deleteRoutingControl(Consumer<DeleteRoutingControlRequest.Builder> deleteRoutingControlRequest)	Deletes a routing control.
default DeleteRoutingControlResponse	deleteRoutingControl(DeleteRoutingControlRequest deleteRoutingControlRequest)	Deletes a routing control.
default DeleteSafetyRuleResponse	deleteSafetyRule(Consumer<DeleteSafetyRuleRequest.Builder> deleteSafetyRuleRequest)	Deletes a safety rule.
default DeleteSafetyRuleResponse	deleteSafetyRule(DeleteSafetyRuleRequest deleteSafetyRuleRequest)	Deletes a safety rule.
default DescribeClusterResponse	describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Display the details about a cluster.
default DescribeClusterResponse	describeCluster(DescribeClusterRequest describeClusterRequest)	Display the details about a cluster.
default DescribeControlPanelResponse	describeControlPanel(Consumer<DescribeControlPanelRequest.Builder> describeControlPanelRequest)	Displays details about a control panel.
default DescribeControlPanelResponse	describeControlPanel(DescribeControlPanelRequest describeControlPanelRequest)	Displays details about a control panel.
default DescribeRoutingControlResponse	describeRoutingControl(Consumer<DescribeRoutingControlRequest.Builder> describeRoutingControlRequest)	Displays details about a routing control.
default DescribeRoutingControlResponse	describeRoutingControl(DescribeRoutingControlRequest describeRoutingControlRequest)	Displays details about a routing control.
default DescribeSafetyRuleResponse	describeSafetyRule(Consumer<DescribeSafetyRuleRequest.Builder> describeSafetyRuleRequest)	Returns information about a safety rule.
default DescribeSafetyRuleResponse	describeSafetyRule(DescribeSafetyRuleRequest describeSafetyRuleRequest)	Returns information about a safety rule.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Get information about the resource policy for a cluster.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Get information about the resource policy for a cluster.
default ListAssociatedRoute53HealthChecksResponse	listAssociatedRoute53HealthChecks(Consumer<ListAssociatedRoute53HealthChecksRequest.Builder> listAssociatedRoute53HealthChecksRequest)	Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
default ListAssociatedRoute53HealthChecksResponse	listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)	Returns an array of all Amazon Route 53 health checks associated with a specific routing control.
default ListAssociatedRoute53HealthChecksIterable	listAssociatedRoute53HealthChecksPaginator(Consumer<ListAssociatedRoute53HealthChecksRequest.Builder> listAssociatedRoute53HealthChecksRequest)	This is a variant of listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation.
default ListAssociatedRoute53HealthChecksIterable	listAssociatedRoute53HealthChecksPaginator(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)	This is a variant of listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Returns an array of all the clusters in an account.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Returns an array of all the clusters in an account.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation.
default ListControlPanelsResponse	listControlPanels(Consumer<ListControlPanelsRequest.Builder> listControlPanelsRequest)	Returns an array of control panels in an account or in a cluster.
default ListControlPanelsResponse	listControlPanels(ListControlPanelsRequest listControlPanelsRequest)	Returns an array of control panels in an account or in a cluster.
default ListControlPanelsIterable	listControlPanelsPaginator(Consumer<ListControlPanelsRequest.Builder> listControlPanelsRequest)	This is a variant of listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation.
default ListControlPanelsIterable	listControlPanelsPaginator(ListControlPanelsRequest listControlPanelsRequest)	This is a variant of listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation.
default ListRoutingControlsResponse	listRoutingControls(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)	Returns an array of routing controls for a control panel.
default ListRoutingControlsResponse	listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest)	Returns an array of routing controls for a control panel.
default ListRoutingControlsIterable	listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)	This is a variant of listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation.
default ListRoutingControlsIterable	listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest)	This is a variant of listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation.
default ListSafetyRulesResponse	listSafetyRules(Consumer<ListSafetyRulesRequest.Builder> listSafetyRulesRequest)	List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
default ListSafetyRulesResponse	listSafetyRules(ListSafetyRulesRequest listSafetyRulesRequest)	List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.
default ListSafetyRulesIterable	listSafetyRulesPaginator(Consumer<ListSafetyRulesRequest.Builder> listSafetyRulesRequest)	This is a variant of listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation.
default ListSafetyRulesIterable	listSafetyRulesPaginator(ListSafetyRulesRequest listSafetyRulesRequest)	This is a variant of listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags for a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for a resource.
default Route53RecoveryControlConfigServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds a tag to a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds a tag to a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes a tag from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes a tag from a resource.
default UpdateControlPanelResponse	updateControlPanel(Consumer<UpdateControlPanelRequest.Builder> updateControlPanelRequest)	Updates a control panel.
default UpdateControlPanelResponse	updateControlPanel(UpdateControlPanelRequest updateControlPanelRequest)	Updates a control panel.
default UpdateRoutingControlResponse	updateRoutingControl(Consumer<UpdateRoutingControlRequest.Builder> updateRoutingControlRequest)	Updates a routing control.
default UpdateRoutingControlResponse	updateRoutingControl(UpdateRoutingControlRequest updateRoutingControlRequest)	Updates a routing control.
default UpdateSafetyRuleResponse	updateSafetyRule(Consumer<UpdateSafetyRuleRequest.Builder> updateSafetyRuleRequest)	Update a safety rule (an assertion rule or gating rule).
default UpdateSafetyRuleResponse	updateSafetyRule(UpdateSafetyRuleRequest updateSafetyRuleRequest)	Update a safety rule (an assertion rule or gating rule).
default Route53RecoveryControlConfigWaiter	waiter()	Create an instance of Route53RecoveryControlConfigWaiter using this client.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

Parameters:

createClusterRequest - Creates a cluster.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.

This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request. Creates a cluster.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createControlPanel

default CreateControlPanelResponse createControlPanel(CreateControlPanelRequest createControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

Parameters:

createControlPanelRequest - The details of the control panel that you're creating.

Returns:

Result of the CreateControlPanel operation returned by the service.

See Also:

• AWS API Documentation

createControlPanel

default CreateControlPanelResponse createControlPanel(Consumer<CreateControlPanelRequest.Builder> createControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.

This is a convenience which creates an instance of the CreateControlPanelRequest.Builder avoiding the need to create one manually via CreateControlPanelRequest.builder()

Parameters:

createControlPanelRequest - A Consumer that will call methods on CreateControlPanelRequest.Builder to create a request. The details of the control panel that you're creating.

Returns:

Result of the CreateControlPanel operation returned by the service.

See Also:

• AWS API Documentation

createRoutingControl

default CreateRoutingControlResponse createRoutingControl(CreateRoutingControlRequest createRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Creates a new routing control.

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

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

Parameters:

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

Returns:

Result of the CreateRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

createRoutingControl

default CreateRoutingControlResponse createRoutingControl(Consumer<CreateRoutingControlRequest.Builder> createRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
ServiceQuotaExceededException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Creates a new routing control.

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

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

This is a convenience which creates an instance of the CreateRoutingControlRequest.Builder avoiding the need to create one manually via CreateRoutingControlRequest.builder()

Parameters:

createRoutingControlRequest - A Consumer that will call methods on CreateRoutingControlRequest.Builder to create a request. The details of the routing control that you're creating.

Returns:

Result of the CreateRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

createSafetyRule

default CreateSafetyRuleResponse createSafetyRule(CreateSafetyRuleRequest createSafetyRuleRequest)
                                           throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

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

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

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

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

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

Parameters:

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

Returns:

Result of the CreateSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

createSafetyRule

default CreateSafetyRuleResponse createSafetyRule(Consumer<CreateSafetyRuleRequest.Builder> createSafetyRuleRequest)
                                           throws ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

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

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

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

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

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

This is a convenience which creates an instance of the CreateSafetyRuleRequest.Builder avoiding the need to create one manually via CreateSafetyRuleRequest.builder()

Parameters:

createSafetyRuleRequest - A Consumer that will call methods on CreateSafetyRuleRequest.Builder to create a request. The request body that you include when you create a safety rule.

Returns:

Result of the CreateSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Delete a cluster.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Delete a cluster.

This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteControlPanel

default DeleteControlPanelResponse deleteControlPanel(DeleteControlPanelRequest deleteControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a control panel.

Parameters:

deleteControlPanelRequest -

Returns:

Result of the DeleteControlPanel operation returned by the service.

See Also:

• AWS API Documentation

deleteControlPanel

default DeleteControlPanelResponse deleteControlPanel(Consumer<DeleteControlPanelRequest.Builder> deleteControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a control panel.

This is a convenience which creates an instance of the DeleteControlPanelRequest.Builder avoiding the need to create one manually via DeleteControlPanelRequest.builder()

Parameters:

deleteControlPanelRequest - A Consumer that will call methods on DeleteControlPanelRequest.Builder to create a request.

Returns:

Result of the DeleteControlPanel operation returned by the service.

See Also:

• AWS API Documentation

deleteRoutingControl

default DeleteRoutingControlResponse deleteRoutingControl(DeleteRoutingControlRequest deleteRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a routing control.

Parameters:

deleteRoutingControlRequest -

Returns:

Result of the DeleteRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

deleteRoutingControl

default DeleteRoutingControlResponse deleteRoutingControl(Consumer<DeleteRoutingControlRequest.Builder> deleteRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a routing control.

This is a convenience which creates an instance of the DeleteRoutingControlRequest.Builder avoiding the need to create one manually via DeleteRoutingControlRequest.builder()

Parameters:

deleteRoutingControlRequest - A Consumer that will call methods on DeleteRoutingControlRequest.Builder to create a request.

Returns:

Result of the DeleteRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

deleteSafetyRule

default DeleteSafetyRuleResponse deleteSafetyRule(DeleteSafetyRuleRequest deleteSafetyRuleRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a safety rule.

/>

Parameters:

deleteSafetyRuleRequest -

Returns:

Result of the DeleteSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

deleteSafetyRule

default DeleteSafetyRuleResponse deleteSafetyRule(Consumer<DeleteSafetyRuleRequest.Builder> deleteSafetyRuleRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Deletes a safety rule.

/>

This is a convenience which creates an instance of the DeleteSafetyRuleRequest.Builder avoiding the need to create one manually via DeleteSafetyRuleRequest.builder()

Parameters:

deleteSafetyRuleRequest - A Consumer that will call methods on DeleteSafetyRuleRequest.Builder to create a request.

Returns:

Result of the DeleteSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(DescribeClusterRequest describeClusterRequest)
                                         throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

Parameters:

describeClusterRequest -

Returns:

Result of the DescribeCluster operation returned by the service.

See Also:

• AWS API Documentation

describeCluster

default DescribeClusterResponse describeCluster(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)
                                         throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Display the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name (ARN).

This is a convenience which creates an instance of the DescribeClusterRequest.Builder avoiding the need to create one manually via DescribeClusterRequest.builder()

Parameters:

describeClusterRequest - A Consumer that will call methods on DescribeClusterRequest.Builder to create a request.

Returns:

Result of the DescribeCluster operation returned by the service.

See Also:

• AWS API Documentation

describeControlPanel

default DescribeControlPanelResponse describeControlPanel(DescribeControlPanelRequest describeControlPanelRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Displays details about a control panel.

Parameters:

describeControlPanelRequest -

Returns:

Result of the DescribeControlPanel operation returned by the service.

See Also:

• AWS API Documentation

describeControlPanel

default DescribeControlPanelResponse describeControlPanel(Consumer<DescribeControlPanelRequest.Builder> describeControlPanelRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Displays details about a control panel.

This is a convenience which creates an instance of the DescribeControlPanelRequest.Builder avoiding the need to create one manually via DescribeControlPanelRequest.builder()

Parameters:

describeControlPanelRequest - A Consumer that will call methods on DescribeControlPanelRequest.Builder to create a request.

Returns:

Result of the DescribeControlPanel operation returned by the service.

See Also:

• AWS API Documentation

describeRoutingControl

default DescribeRoutingControlResponse describeRoutingControl(DescribeRoutingControlRequest describeRoutingControlRequest)
                                                       throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

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

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

Parameters:

describeRoutingControlRequest -

Returns:

Result of the DescribeRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

describeRoutingControl

default DescribeRoutingControlResponse describeRoutingControl(Consumer<DescribeRoutingControlRequest.Builder> describeRoutingControlRequest)
                                                       throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

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

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

This is a convenience which creates an instance of the DescribeRoutingControlRequest.Builder avoiding the need to create one manually via DescribeRoutingControlRequest.builder()

Parameters:

describeRoutingControlRequest - A Consumer that will call methods on DescribeRoutingControlRequest.Builder to create a request.

Returns:

Result of the DescribeRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

describeSafetyRule

default DescribeSafetyRuleResponse describeSafetyRule(DescribeSafetyRuleRequest describeSafetyRuleRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns information about a safety rule.

Parameters:

describeSafetyRuleRequest -

Returns:

Result of the DescribeSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

describeSafetyRule

default DescribeSafetyRuleResponse describeSafetyRule(Consumer<DescribeSafetyRuleRequest.Builder> describeSafetyRuleRequest)
                                               throws ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns information about a safety rule.

This is a convenience which creates an instance of the DescribeSafetyRuleRequest.Builder avoiding the need to create one manually via DescribeSafetyRuleRequest.builder()

Parameters:

describeSafetyRuleRequest - A Consumer that will call methods on DescribeSafetyRuleRequest.Builder to create a request.

Returns:

Result of the DescribeSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Get information about the resource policy for a cluster.

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Get information about the resource policy for a cluster.

This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

Parameters:

getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedRoute53HealthChecks

default ListAssociatedRoute53HealthChecksResponse listAssociatedRoute53HealthChecks(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)
                                                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

Parameters:

listAssociatedRoute53HealthChecksRequest -

Returns:

Result of the ListAssociatedRoute53HealthChecks operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedRoute53HealthChecks

default ListAssociatedRoute53HealthChecksResponse listAssociatedRoute53HealthChecks(Consumer<ListAssociatedRoute53HealthChecksRequest.Builder> listAssociatedRoute53HealthChecksRequest)
                                                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of all Amazon Route 53 health checks associated with a specific routing control.

This is a convenience which creates an instance of the ListAssociatedRoute53HealthChecksRequest.Builder avoiding the need to create one manually via ListAssociatedRoute53HealthChecksRequest.builder()

Parameters:

listAssociatedRoute53HealthChecksRequest - A Consumer that will call methods on ListAssociatedRoute53HealthChecksRequest.Builder to create a request.

Returns:

Result of the ListAssociatedRoute53HealthChecks operation returned by the service.

See Also:

• AWS API Documentation

listAssociatedRoute53HealthChecksPaginator

default ListAssociatedRoute53HealthChecksIterable listAssociatedRoute53HealthChecksPaginator(ListAssociatedRoute53HealthChecksRequest listAssociatedRoute53HealthChecksRequest)
                                                                                      throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client.listAssociatedRoute53HealthChecksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client
             .listAssociatedRoute53HealthChecksPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client.listAssociatedRoute53HealthChecksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation.

Parameters:

listAssociatedRoute53HealthChecksRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAssociatedRoute53HealthChecksPaginator

default ListAssociatedRoute53HealthChecksIterable listAssociatedRoute53HealthChecksPaginator(Consumer<ListAssociatedRoute53HealthChecksRequest.Builder> listAssociatedRoute53HealthChecksRequest)
                                                                                      throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client.listAssociatedRoute53HealthChecksPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client
             .listAssociatedRoute53HealthChecksPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListAssociatedRoute53HealthChecksIterable responses = client.listAssociatedRoute53HealthChecksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAssociatedRoute53HealthChecks(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListAssociatedRoute53HealthChecksRequest) operation.

This is a convenience which creates an instance of the ListAssociatedRoute53HealthChecksRequest.Builder avoiding the need to create one manually via ListAssociatedRoute53HealthChecksRequest.builder()

Parameters:

listAssociatedRoute53HealthChecksRequest - A Consumer that will call methods on ListAssociatedRoute53HealthChecksRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of all the clusters in an account.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of all the clusters in an account.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client
             .listClustersPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client
             .listClustersPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListClustersRequest) operation.

This is a convenience which creates an instance of the ListClustersRequest.Builder avoiding the need to create one manually via ListClustersRequest.builder()

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listControlPanels

default ListControlPanelsResponse listControlPanels(ListControlPanelsRequest listControlPanelsRequest)
                                             throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of control panels in an account or in a cluster.

Parameters:

listControlPanelsRequest -

Returns:

Result of the ListControlPanels operation returned by the service.

See Also:

• AWS API Documentation

listControlPanels

default ListControlPanelsResponse listControlPanels(Consumer<ListControlPanelsRequest.Builder> listControlPanelsRequest)
                                             throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of control panels in an account or in a cluster.

This is a convenience which creates an instance of the ListControlPanelsRequest.Builder avoiding the need to create one manually via ListControlPanelsRequest.builder()

Parameters:

listControlPanelsRequest - A Consumer that will call methods on ListControlPanelsRequest.Builder to create a request.

Returns:

Result of the ListControlPanels operation returned by the service.

See Also:

• AWS API Documentation

listControlPanelsPaginator

default ListControlPanelsIterable listControlPanelsPaginator(ListControlPanelsRequest listControlPanelsRequest)
                                                      throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client.listControlPanelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client
             .listControlPanelsPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client.listControlPanelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation.

Parameters:

listControlPanelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listControlPanelsPaginator

default ListControlPanelsIterable listControlPanelsPaginator(Consumer<ListControlPanelsRequest.Builder> listControlPanelsRequest)
                                                      throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client.listControlPanelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client
             .listControlPanelsPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListControlPanelsIterable responses = client.listControlPanelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listControlPanels(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListControlPanelsRequest) operation.

This is a convenience which creates an instance of the ListControlPanelsRequest.Builder avoiding the need to create one manually via ListControlPanelsRequest.builder()

Parameters:

listControlPanelsRequest - A Consumer that will call methods on ListControlPanelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRoutingControls

default ListRoutingControlsResponse listRoutingControls(ListRoutingControlsRequest listRoutingControlsRequest)
                                                 throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that 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 routing.

Parameters:

listRoutingControlsRequest -

Returns:

Result of the ListRoutingControls operation returned by the service.

See Also:

• AWS API Documentation

listRoutingControls

default ListRoutingControlsResponse listRoutingControls(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
                                                 throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Returns an array of routing controls for a control panel. A routing control is an Amazon Route 53 Application Recovery Controller construct that 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 routing.

This is a convenience which creates an instance of the ListRoutingControlsRequest.Builder avoiding the need to create one manually via ListRoutingControlsRequest.builder()

Parameters:

listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a request.

Returns:

Result of the ListRoutingControls operation returned by the service.

See Also:

• AWS API Documentation

listRoutingControlsPaginator

default ListRoutingControlsIterable listRoutingControlsPaginator(ListRoutingControlsRequest listRoutingControlsRequest)
                                                          throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client
             .listRoutingControlsPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation.

Parameters:

listRoutingControlsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRoutingControlsPaginator

default ListRoutingControlsIterable listRoutingControlsPaginator(Consumer<ListRoutingControlsRequest.Builder> listRoutingControlsRequest)
                                                          throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client
             .listRoutingControlsPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListRoutingControlsIterable responses = client.listRoutingControlsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listRoutingControls(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListRoutingControlsRequest) operation.

This is a convenience which creates an instance of the ListRoutingControlsRequest.Builder avoiding the need to create one manually via ListRoutingControlsRequest.builder()

Parameters:

listRoutingControlsRequest - A Consumer that will call methods on ListRoutingControlsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSafetyRules

default ListSafetyRulesResponse listSafetyRules(ListSafetyRulesRequest listSafetyRulesRequest)
                                         throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

Parameters:

listSafetyRulesRequest -

Returns:

Result of the ListSafetyRules operation returned by the service.

See Also:

• AWS API Documentation

listSafetyRules

default ListSafetyRulesResponse listSafetyRules(Consumer<ListSafetyRulesRequest.Builder> listSafetyRulesRequest)
                                         throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

List the safety rules (the assertion rules and gating rules) that you've defined for the routing controls in a control panel.

This is a convenience which creates an instance of the ListSafetyRulesRequest.Builder avoiding the need to create one manually via ListSafetyRulesRequest.builder()

Parameters:

listSafetyRulesRequest - A Consumer that will call methods on ListSafetyRulesRequest.Builder to create a request.

Returns:

Result of the ListSafetyRules operation returned by the service.

See Also:

• AWS API Documentation

listSafetyRulesPaginator

default ListSafetyRulesIterable listSafetyRulesPaginator(ListSafetyRulesRequest listSafetyRulesRequest)
                                                  throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client.listSafetyRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client
             .listSafetyRulesPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client.listSafetyRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation.

Parameters:

listSafetyRulesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSafetyRulesPaginator

default ListSafetyRulesIterable listSafetyRulesPaginator(Consumer<ListSafetyRulesRequest.Builder> listSafetyRulesRequest)
                                                  throws ResourceNotFoundException,
ThrottlingException,
ValidationException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

This is a variant of listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client.listSafetyRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client
             .listSafetyRulesPaginator(request);
     for (software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.route53recoverycontrolconfig.paginators.ListSafetyRulesIterable responses = client.listSafetyRulesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSafetyRules(software.amazon.awssdk.services.route53recoverycontrolconfig.model.ListSafetyRulesRequest) operation.

This is a convenience which creates an instance of the ListSafetyRulesRequest.Builder avoiding the need to create one manually via ListSafetyRulesRequest.builder()

Parameters:

listSafetyRulesRequest - A Consumer that will call methods on ListSafetyRulesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Lists the tags for a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Lists the tags for a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Adds a tag to a resource.

Parameters:

tagResourceRequest - Request of adding tag to the resource

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Adds a tag to a resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Request of adding tag to the resource

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Removes a tag from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Removes a tag from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateControlPanel

default UpdateControlPanelResponse updateControlPanel(UpdateControlPanelRequest updateControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

Parameters:

updateControlPanelRequest - The details of the control panel that you're updating.

Returns:

Result of the UpdateControlPanel operation returned by the service.

See Also:

• AWS API Documentation

updateControlPanel

default UpdateControlPanelResponse updateControlPanel(Consumer<UpdateControlPanelRequest.Builder> updateControlPanelRequest)
                                               throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

This is a convenience which creates an instance of the UpdateControlPanelRequest.Builder avoiding the need to create one manually via UpdateControlPanelRequest.builder()

Parameters:

updateControlPanelRequest - A Consumer that will call methods on UpdateControlPanelRequest.Builder to create a request. The details of the control panel that you're updating.

Returns:

Result of the UpdateControlPanel operation returned by the service.

See Also:

• AWS API Documentation

updateRoutingControl

default UpdateRoutingControlResponse updateRoutingControl(UpdateRoutingControlRequest updateRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Parameters:

updateRoutingControlRequest - The details of the routing control that you're updating.

Returns:

Result of the UpdateRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

updateRoutingControl

default UpdateRoutingControlResponse updateRoutingControl(Consumer<UpdateRoutingControlRequest.Builder> updateRoutingControlRequest)
                                                   throws ValidationException,
InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ConflictException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

This is a convenience which creates an instance of the UpdateRoutingControlRequest.Builder avoiding the need to create one manually via UpdateRoutingControlRequest.builder()

Parameters:

updateRoutingControlRequest - A Consumer that will call methods on UpdateRoutingControlRequest.Builder to create a request. The details of the routing control that you're updating.

Returns:

Result of the UpdateRoutingControl operation returned by the service.

See Also:

• AWS API Documentation

updateSafetyRule

default UpdateSafetyRuleResponse updateSafetyRule(UpdateSafetyRuleRequest updateSafetyRuleRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

Parameters:

updateSafetyRuleRequest - A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.

Returns:

Result of the UpdateSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

updateSafetyRule

default UpdateSafetyRuleResponse updateSafetyRule(Consumer<UpdateSafetyRuleRequest.Builder> updateSafetyRuleRequest)
                                           throws ResourceNotFoundException,
ValidationException,
InternalServerException,
AwsServiceException,
SdkClientException,
Route53RecoveryControlConfigException

Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.

This is a convenience which creates an instance of the UpdateSafetyRuleRequest.Builder avoiding the need to create one manually via UpdateSafetyRuleRequest.builder()

Parameters:

updateSafetyRuleRequest - A Consumer that will call methods on UpdateSafetyRuleRequest.Builder to create a request. A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.

Returns:

Result of the UpdateSafetyRule operation returned by the service.

See Also:

• AWS API Documentation

waiter

default Route53RecoveryControlConfigWaiter waiter()

Create an instance of Route53RecoveryControlConfigWaiter using this client.

Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

Returns:

an instance of Route53RecoveryControlConfigWaiter

create

static Route53RecoveryControlConfigClient create()

Create a Route53RecoveryControlConfigClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static Route53RecoveryControlConfigClientBuilder builder()

Create a builder that can be used to configure and create a Route53RecoveryControlConfigClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default Route53RecoveryControlConfigServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration