Route53 Recovery Readiness

This page documents function available when using the Route53_Recovery_Readiness module, created with @service Route53_Recovery_Readiness.

Index

Documentation

Main.Route53_Recovery_Readiness.create_cell — Method

create_cell(cell_name)
create_cell(cell_name, params::Dict{String,<:Any})

Creates a new Cell.

Arguments

cell_name: The name of the Cell to create

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"cells": A list of Cell arns contained within this Cell (for use in nested Cells, e.g. regions within which AZs)
"tags":

source

Main.Route53_Recovery_Readiness.create_cross_account_authorization — Method

create_cross_account_authorization(cross_account_authorization)
create_cross_account_authorization(cross_account_authorization, params::Dict{String,<:Any})

Create a new cross account readiness authorization.

Arguments

cross_account_authorization: The cross account authorization

source

Main.Route53_Recovery_Readiness.create_readiness_check — Method

create_readiness_check(readiness_check_name, resource_set_name)
create_readiness_check(readiness_check_name, resource_set_name, params::Dict{String,<:Any})

Creates a new Readiness Check.

Arguments

readiness_check_name: The name of the ReadinessCheck to create
resource_set_name: The name of the ResourceSet to check

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"tags":

source

Main.Route53_Recovery_Readiness.create_recovery_group — Method

create_recovery_group(recovery_group_name)
create_recovery_group(recovery_group_name, params::Dict{String,<:Any})

Creates a new Recovery Group.

Arguments

recovery_group_name: The name of the RecoveryGroup to create

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"cells": A list of Cell arns
"tags":

source

Main.Route53_Recovery_Readiness.create_resource_set — Method

create_resource_set(resource_set_name, resource_set_type, resources)
create_resource_set(resource_set_name, resource_set_type, resources, params::Dict{String,<:Any})

Creates a new Resource Set.

Arguments

resource_set_name: The name of the ResourceSet to create
resource_set_type: AWS Resource type of the resources in the ResourceSet
resources: A list of Resource objects

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"tags":

source

Main.Route53_Recovery_Readiness.delete_cell — Method

delete_cell(cell_name)
delete_cell(cell_name, params::Dict{String,<:Any})

Deletes an existing Cell.

Arguments

cell_name: The Cell to delete

source

Main.Route53_Recovery_Readiness.delete_cross_account_authorization — Method

delete_cross_account_authorization(cross_account_authorization)
delete_cross_account_authorization(cross_account_authorization, params::Dict{String,<:Any})

Delete cross account readiness authorization

Arguments

cross_account_authorization: The cross account authorization

source

Main.Route53_Recovery_Readiness.delete_readiness_check — Method

delete_readiness_check(readiness_check_name)
delete_readiness_check(readiness_check_name, params::Dict{String,<:Any})

Deletes an existing Readiness Check.

Arguments

readiness_check_name: The ReadinessCheck to delete

source

Main.Route53_Recovery_Readiness.delete_recovery_group — Method

delete_recovery_group(recovery_group_name)
delete_recovery_group(recovery_group_name, params::Dict{String,<:Any})

Deletes an existing Recovery Group.

Arguments

recovery_group_name: The RecoveryGroup to delete

source

Main.Route53_Recovery_Readiness.delete_resource_set — Method

delete_resource_set(resource_set_name)
delete_resource_set(resource_set_name, params::Dict{String,<:Any})

Deletes an existing Resource Set.

Arguments

resource_set_name: The ResourceSet to delete

source

Main.Route53_Recovery_Readiness.get_architecture_recommendations — Method

get_architecture_recommendations(recovery_group_name)
get_architecture_recommendations(recovery_group_name, params::Dict{String,<:Any})

Returns a collection of recommendations to improve resilliance and readiness check quality for a Recovery Group.

Arguments

recovery_group_name: Name of RecoveryGroup (top level resource) to be analyzed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token that can be used to resume pagination from the end of the collection.

source

Main.Route53_Recovery_Readiness.get_cell — Method

get_cell(cell_name)
get_cell(cell_name, params::Dict{String,<:Any})

Returns information about a Cell.

Arguments

cell_name: The Cell to get

source

Main.Route53_Recovery_Readiness.get_cell_readiness_summary — Method

get_cell_readiness_summary(cell_name)
get_cell_readiness_summary(cell_name, params::Dict{String,<:Any})

Returns information about readiness of a Cell.

Arguments

cell_name: The name of the Cell

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.get_readiness_check — Method

get_readiness_check(readiness_check_name)
get_readiness_check(readiness_check_name, params::Dict{String,<:Any})

Returns information about a ReadinessCheck.

Arguments

readiness_check_name: The ReadinessCheck to get

source

Main.Route53_Recovery_Readiness.get_readiness_check_resource_status — Method

get_readiness_check_resource_status(readiness_check_name, resource_identifier)
get_readiness_check_resource_status(readiness_check_name, resource_identifier, params::Dict{String,<:Any})

Returns detailed information about the status of an individual resource within a Readiness Check's Resource Set.

Arguments

readiness_check_name: The ReadinessCheck to get
resource_identifier: The resource ARN or component Id to get

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.get_readiness_check_status — Method

get_readiness_check_status(readiness_check_name)
get_readiness_check_status(readiness_check_name, params::Dict{String,<:Any})

Returns information about the status of a Readiness Check.

Arguments

readiness_check_name: The ReadinessCheck to get

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.get_recovery_group — Method

get_recovery_group(recovery_group_name)
get_recovery_group(recovery_group_name, params::Dict{String,<:Any})

Returns information about a Recovery Group.

Arguments

recovery_group_name: The RecoveryGroup to get

source

Main.Route53_Recovery_Readiness.get_recovery_group_readiness_summary — Method

get_recovery_group_readiness_summary(recovery_group_name)
get_recovery_group_readiness_summary(recovery_group_name, params::Dict{String,<:Any})

Returns information about a Recovery Group.

Arguments

recovery_group_name: The name of the RecoveryGroup

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.get_resource_set — Method

get_resource_set(resource_set_name)
get_resource_set(resource_set_name, params::Dict{String,<:Any})

Returns information about a Resource Set.

Arguments

resource_set_name: The ResourceSet to get

source

Main.Route53_Recovery_Readiness.list_cells — Method

list_cells()
list_cells(params::Dict{String,<:Any})

Returns a collection of Cells.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.list_cross_account_authorizations — Method

list_cross_account_authorizations()
list_cross_account_authorizations(params::Dict{String,<:Any})

Returns a collection of cross account readiness authorizations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.list_readiness_checks — Method

list_readiness_checks()
list_readiness_checks(params::Dict{String,<:Any})

Returns a collection of Readiness Checks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.list_recovery_groups — Method

list_recovery_groups()
list_recovery_groups(params::Dict{String,<:Any})

Returns a collection of Recovery Groups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.list_resource_sets — Method

list_resource_sets()
list_resource_sets(params::Dict{String,<:Any})

Returns a collection of Resource Sets.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.

source

Main.Route53_Recovery_Readiness.list_rules — Method

list_rules()
list_rules(params::Dict{String,<:Any})

Returns a collection of rules that are applied as part of Readiness Checks.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

"maxResults": Upper bound on number of records to return.
"nextToken": A token used to resume pagination from the end of a previous request.
"resourceType": Filter parameter which specifies the rules to return given a resource type.

source

Main.Route53_Recovery_Readiness.list_tags_for_resources — Method

list_tags_for_resources(resource-arn)
list_tags_for_resources(resource-arn, params::Dict{String,<:Any})

Returns a list of the tags assigned to the specified resource.

Arguments

resource-arn: The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.

source

Main.Route53_Recovery_Readiness.tag_resource — Method

tag_resource(resource-arn, tags)
tag_resource(resource-arn, tags, params::Dict{String,<:Any})

Adds tags to the specified resource. You can specify one or more tags to add.

Arguments

resource-arn: The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
tags:

source

Main.Route53_Recovery_Readiness.untag_resource — Method

untag_resource(resource-arn, tag_keys)
untag_resource(resource-arn, tag_keys, params::Dict{String,<:Any})

Removes tags from the specified resource. You can specify one or more tags to remove.

Arguments

resource-arn: The Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
tag_keys: A comma-separated list of the tag keys to remove from the resource.

source

Main.Route53_Recovery_Readiness.update_cell — Method

update_cell(cell_name, cells)
update_cell(cell_name, cells, params::Dict{String,<:Any})

Updates an existing Cell.

Arguments

cell_name: The Cell to update
cells: A list of Cell arns, completely replaces previous list

source

Main.Route53_Recovery_Readiness.update_readiness_check — Method

update_readiness_check(readiness_check_name, resource_set_name)
update_readiness_check(readiness_check_name, resource_set_name, params::Dict{String,<:Any})

Updates an exisiting Readiness Check.

Arguments

readiness_check_name: The ReadinessCheck to update
resource_set_name: The name of the ResourceSet to check

source

Main.Route53_Recovery_Readiness.update_recovery_group — Method

update_recovery_group(cells, recovery_group_name)
update_recovery_group(cells, recovery_group_name, params::Dict{String,<:Any})

Updates an existing Recovery Group.

Arguments

cells: A list of Cell arns, completely replaces previous list
recovery_group_name: The RecoveryGroup to update

source

Main.Route53_Recovery_Readiness.update_resource_set — Method

update_resource_set(resource_set_name, resource_set_type, resources)
update_resource_set(resource_set_name, resource_set_type, resources, params::Dict{String,<:Any})

Updates an existing Resource Set.

Arguments

resource_set_name: The ResourceSet to update
resource_set_type: AWS Resource Type of the resources in the ResourceSet
resources: A list of Resource objects

source