Route53RecoveryControlConfig

import { Route53RecoveryControlConfig } from "https://aws-api.deno.dev/v0.4/services/route53recoverycontrolconfig.ts?docs=full";

class Route53RecoveryControlConfig {

constructor(apiFactory: client.ApiFactory);

async createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>;

async createControlPanel(params: CreateControlPanelRequest, opts?: client.RequestOptions): Promise<CreateControlPanelResponse>;

async createRoutingControl(params: CreateRoutingControlRequest, opts?: client.RequestOptions): Promise<CreateRoutingControlResponse>;

async createSafetyRule(params?: CreateSafetyRuleRequest, opts?: client.RequestOptions): Promise<CreateSafetyRuleResponse>;

async deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<void>;

async deleteControlPanel(params: DeleteControlPanelRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRoutingControl(params: DeleteRoutingControlRequest, opts?: client.RequestOptions): Promise<void>;

async deleteSafetyRule(params: DeleteSafetyRuleRequest, opts?: client.RequestOptions): Promise<void>;

async describeCluster(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>;

async describeControlPanel(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<DescribeControlPanelResponse>;

async describeRoutingControl(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<DescribeRoutingControlResponse>;

async describeSafetyRule(params: DescribeSafetyRuleRequest, opts?: client.RequestOptions): Promise<DescribeSafetyRuleResponse>;

async listAssociatedRoute53HealthChecks(params: ListAssociatedRoute53HealthChecksRequest, opts?: client.RequestOptions): Promise<ListAssociatedRoute53HealthChecksResponse>;

async listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>;

async listControlPanels(params?: ListControlPanelsRequest, opts?: client.RequestOptions): Promise<ListControlPanelsResponse>;

async listRoutingControls(params: ListRoutingControlsRequest, opts?: client.RequestOptions): Promise<ListRoutingControlsResponse>;

async listSafetyRules(params: ListSafetyRulesRequest, opts?: client.RequestOptions): Promise<ListSafetyRulesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateControlPanel(params: UpdateControlPanelRequest, opts?: client.RequestOptions): Promise<UpdateControlPanelResponse>;

async updateRoutingControl(params: UpdateRoutingControlRequest, opts?: client.RequestOptions): Promise<UpdateRoutingControlResponse>;

async updateSafetyRule(params?: UpdateSafetyRuleRequest, opts?: client.RequestOptions): Promise<UpdateSafetyRuleResponse>;

async waitForClusterCreated(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>;

async waitForClusterDeleted(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<Error | DescribeClusterResponse>;

async waitForControlPanelCreated(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<DescribeControlPanelResponse>;

async waitForControlPanelDeleted(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<Error | DescribeControlPanelResponse>;

async waitForRoutingControlCreated(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<DescribeRoutingControlResponse>;

async waitForRoutingControlDeleted(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<Error | DescribeRoutingControlResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new Route53RecoveryControlConfig(apiFactory: client.ApiFactory)

[src]

§Methods

createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>

[src]

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.

createControlPanel(params: CreateControlPanelRequest, opts?: client.RequestOptions): Promise<CreateControlPanelResponse>

[src]

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.

createRoutingControl(params: CreateRoutingControlRequest, opts?: client.RequestOptions): Promise<CreateRoutingControlResponse>

[src]

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.

createSafetyRule(params?: CreateSafetyRuleRequest, opts?: client.RequestOptions): Promise<CreateSafetyRuleResponse>

[src]

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.

deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<void>

[src]

Delete a cluster.

deleteControlPanel(params: DeleteControlPanelRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a control panel.

deleteRoutingControl(params: DeleteRoutingControlRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a routing control.

deleteSafetyRule(params: DeleteSafetyRuleRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a safety rule.

describeCluster(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>

[src]

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

describeControlPanel(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<DescribeControlPanelResponse>

[src]

Displays details about a control panel.

describeRoutingControl(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<DescribeRoutingControlResponse>

[src]

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.

describeSafetyRule(params: DescribeSafetyRuleRequest, opts?: client.RequestOptions): Promise<DescribeSafetyRuleResponse>

[src]

Returns information about a safety rule.

listAssociatedRoute53HealthChecks(params: ListAssociatedRoute53HealthChecksRequest, opts?: client.RequestOptions): Promise<ListAssociatedRoute53HealthChecksResponse>

[src]

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

listClusters(params?: ListClustersRequest, opts?: client.RequestOptions): Promise<ListClustersResponse>

[src]

Returns an array of all the clusters in an account.

listControlPanels(params?: ListControlPanelsRequest, opts?: client.RequestOptions): Promise<ListControlPanelsResponse>

[src]

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

listRoutingControls(params: ListRoutingControlsRequest, opts?: client.RequestOptions): Promise<ListRoutingControlsResponse>

[src]

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.

listSafetyRules(params: ListSafetyRulesRequest, opts?: client.RequestOptions): Promise<ListSafetyRulesResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for a resource.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds a tag to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from a resource.

updateControlPanel(params: UpdateControlPanelRequest, opts?: client.RequestOptions): Promise<UpdateControlPanelResponse>

[src]

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

updateRoutingControl(params: UpdateRoutingControlRequest, opts?: client.RequestOptions): Promise<UpdateRoutingControlResponse>

[src]

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.

updateSafetyRule(params?: UpdateSafetyRuleRequest, opts?: client.RequestOptions): Promise<UpdateSafetyRuleResponse>

[src]

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.

waitForClusterCreated(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<DescribeClusterResponse>

[src]

Wait until a cluster is created Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

waitForClusterDeleted(params: DescribeClusterRequest, opts?: client.RequestOptions): Promise<Error | DescribeClusterResponse>

[src]

Wait for a cluster to be deleted Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

waitForControlPanelCreated(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<DescribeControlPanelResponse>

[src]

Wait until a control panel is created Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

waitForControlPanelDeleted(params: DescribeControlPanelRequest, opts?: client.RequestOptions): Promise<Error | DescribeControlPanelResponse>

[src]

Wait until a control panel is deleted Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

waitForRoutingControlCreated(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<DescribeRoutingControlResponse>

[src]

Wait until a routing control is created Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

waitForRoutingControlDeleted(params: DescribeRoutingControlRequest, opts?: client.RequestOptions): Promise<Error | DescribeRoutingControlResponse>

[src]

Wait for a routing control to be deleted Checks state up to 26 times, 5 seconds apart (about 3 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]