backup_access_points_by_resources

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

Overview

Name	backup_access_points_by_resources
Type	Resource
Id	aws.backup.backup_access_points_by_resources

Fields

The following fields are returned by SELECT queries:

list_backup_access_points_by_resource

Name	Datatype	Description
access_point_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the backup access point. (pattern: <code>(arn:aws[a-z-]*:backup:[a-z-\d]+:\d{12}:accesspoint/)[\da-z]{1}[\da-z-]{1,48}[\da-z]{1}(?<!-s3alias)(?<!-ext-s3alias)</code>)
access_point_metadata	object	Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.
backup_vault_arn	string	The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.
backup_vault_name	string	The name of the backup vault that contains the recovery point. (pattern: <code>^[a-zA-Z0-9-_]{2,50}$</code>)
creation_time	string (date-time)	The date and time that the backup access point was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
name	string	The name of the backup access point. (pattern: <code>[\da-z]{1}[\da-z-]{1,48}[\da-z]{1}(?<!-s3alias)(?<!-ext-s3alias)</code>)
recovery_point_arn	string	The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to. (pattern: <code>(arn:aws[a-z-]*:[a-z-\d]+:[a-z-\d]+:).+</code>)
resource_arn	string	The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket. (pattern: <code>(arn:aws[a-z-]*:[a-z-\d]+:).+</code>)
resource_type	string	The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.
status	string	The current status of the backup access point. (AVAILABLE, CREATING, DELETING, DISASSOCIATED, DISASSOCIATING, EXPIRED, FAILED)
status_message	string	A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_backup_access_points_by_resource	select	resource_arn, region	MaxResults, NextToken	Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.

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_arn	string	The Amazon Resource Name (ARN) of the resource whose backup access points you want to list.
MaxResults	integer	The maximum number of items to be returned.
NextToken	string	The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

SELECT examples

list_backup_access_points_by_resource

Returns the backup access points associated with the specified resource, such as an Amazon S3 bucket.

SELECT
access_point_arn,
access_point_metadata,
backup_vault_arn,
backup_vault_name,
creation_time,
name,
recovery_point_arn,
resource_arn,
resource_type,
status,
status_message
FROM aws.backup.backup_access_points_by_resources
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;