managed_resources

Creates, updates, deletes, gets or lists a managed_resources resource.

Overview

Name	managed_resources
Type	Resource
Id	aws.arc_zonal_shift.managed_resources

Fields

The following fields are returned by SELECT queries:

get_managed_resource

Name	Datatype	Description
name	string	The name of the resource.
applied_weights	object	A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
arn	string	The Amazon Resource Name (ARN) for the resource. (pattern: <code>arn:.*</code>)
autoshifts	array	An array of the autoshifts that are active for the resource.
practice_run_configuration	object	The practice run configuration for zonal autoshift that's associated with the resource.
zonal_autoshift_status	string	The status for zonal autoshift for a resource. When the autoshift status is ENABLED, Amazon Web Services shifts traffic for a resource away from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. (ENABLED, DISABLED)
zonal_shifts	array	The zonal shifts that are currently active for a resource.

list_managed_resources

Name	Datatype	Description
name	string	The name of the managed resource.
applied_weights	object	A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.
arn	string	The Amazon Resource Name (ARN) for the managed resource. (pattern: <code>arn:.*</code>)
autoshifts	array	An array of the autoshifts that have been completed for a resource.
availability_zones	array	The Availability Zones that a resource is deployed in.
practice_run_status	string	This status tracks whether a practice run configuration exists for a resource. When you configure a practice run for a resource so that a practice run configuration exists, ARC sets this value to ENABLED. If a you have not configured a practice run for the resource, or delete a practice run configuration, ARC sets the value to DISABLED. ARC updates this status; you can't set a practice run status to ENABLED or DISABLED. (ENABLED, DISABLED)
zonal_autoshift_status	string	The status of autoshift for a resource. When you configure zonal autoshift for a resource, you can set the value of the status to ENABLED or DISABLED. (ENABLED, DISABLED)
zonal_shifts	array	An array of the zonal shifts for a resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_managed_resource	select	resource_identifier, region		Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.
list_managed_resources	select	region	nextToken, maxResults	Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
resource_identifier	string	The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift: Amazon EC2 Auto Scaling groups Amazon Elastic Kubernetes Service Application Load Balancer Network Load Balancer
maxResults	integer	The number of objects that you want to return with this call.
nextToken	string	Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

SELECT examples

get_managed_resource

Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.

SELECT
name,
applied_weights,
arn,
autoshifts,
practice_run_configuration,
zonal_autoshift_status,
zonal_shifts
FROM aws.arc_zonal_shift.managed_resources
WHERE resource_identifier = '{{ resource_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_managed_resources

Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.

SELECT
name,
applied_weights,
arn,
autoshifts,
availability_zones,
practice_run_status,
zonal_autoshift_status,
zonal_shifts
FROM aws.arc_zonal_shift.managed_resources
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;