backup_access_points

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

Overview

Name	backup_access_points
Type	Resource
Id	aws.backup.backup_access_points

Fields

The following fields are returned by SELECT queries:

describe_backup_access_point

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.

list_backup_access_points

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
describe_backup_access_point	select	access_point_arn, region		Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point. After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.
list_backup_access_points	select	region	MaxResults, NextToken	Returns a list of the backup access points in your account and Region.
create_backup_access_point	insert	region, RecoveryPointArn		Creates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point, without initiating a restore. While a backup access point is active for a recovery point, Backup pauses lifecycle transitions and blocks deletion of that recovery point.
delete_backup_access_point	delete	access_point_arn, region		Deletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other backup access points remain for the recovery point, resumes lifecycle transitions for that recovery point. Always delete backup access points using this operation rather than deleting the underlying Amazon S3 access point directly.

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
access_point_arn	string	The Amazon Resource Name (ARN) of the backup access point to delete.
region	string	AWS region (default: us-east-1)
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

describe_backup_access_point

Returns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point. After a backup access point reaches the AVAILABLE status, use this operation to retrieve the Amazon S3 access point ARN and alias that you need to read the backup data.

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
WHERE access_point_arn = '{{ access_point_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_backup_access_points

Returns a list of the backup access points in your account and Region.

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
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_backup_access_point

Creates a backup access point for an Amazon S3 recovery point. A backup access point provides on-demand, read-only access to the backup data in a recovery point through an Amazon S3 access point, without initiating a restore. While a backup access point is active for a recovery point, Backup pauses lifecycle transitions and blocks deletion of that recovery point.

INSERT INTO aws.backup.backup_access_points (
AccessPointMetadata,
AccessPointPolicy,
Name,
RecoveryPointArn,
Tags,
region
)
SELECT 
'{{ AccessPointMetadata }}',
'{{ AccessPointPolicy }}',
'{{ Name }}',
'{{ RecoveryPointArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
access_point_arn,
status
;

Manifest

# Description fields are for documentation purposes
- name: backup_access_points
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the backup_access_points resource.
  - name: AccessPointMetadata
    value: "{{ AccessPointMetadata }}"
  - name: AccessPointPolicy
    value: "{{ AccessPointPolicy }}"
  - name: Name
    value: "{{ Name }}"
  - name: RecoveryPointArn
    value: "{{ RecoveryPointArn }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_backup_access_point

Deletes a backup access point. This deletes the underlying Amazon S3 access point and, if no other backup access points remain for the recovery point, resumes lifecycle transitions for that recovery point. Always delete backup access points using this operation rather than deleting the underlying Amazon S3 access point directly.

DELETE FROM aws.backup.backup_access_points
WHERE access_point_arn = '{{ access_point_arn }}' --required
AND region = '{{ region }}' --required
;