Skip to content

CreateBackupAccessPointRequest

Source code in docs_src/capo_backup/types/create_backup_access_point_request.py
class CreateBackupAccessPointRequest(TypedDict, closed=True):
    access_point_metadata: NotRequired[
        "capo_backup.types.access_point_metadata_map.AccessPointMetadataMap"
    ]
    """<p>Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an <code>AccessPointInTime</code> timestamp (in format <code>2021-11-27T03:30:27Z</code>). The access point provides access to the content present in the backup at that specific time. You can specify any time within the continuous backup's retention period, up to the latest restorable time. For snapshot recovery points, do not include <code>AccessPointInTime</code>.</p>"""
    access_point_policy: NotRequired[
        "capo_backup.types.access_point_policy.AccessPointPolicy"
    ]
    """<p>An optional resource-based policy, in JSON format, to apply to the underlying Amazon S3 access point. The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-policies.html">Configuring IAM policies for using access points</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    name: "capo_backup.types.access_point_name.AccessPointName"
    """<p>The name of the backup access point. This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. For more information about access point naming, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-restrictions-limitations-naming-rules.html">Access points naming rules, restrictions, and limitations</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    recovery_point_arn: "capo_backup.types.recovery_point_arn.RecoveryPointArn"
    """<p>The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The recovery point must be an Amazon S3 recovery point in the <code>AVAILABLE</code>, <code>STOPPED</code>, or <code>COMPLETED</code> state.</p>"""
    tags: NotRequired["capo_backup.types.tag_map.TagMap"]
    """<p>The tags to assign to the backup access point.</p>"""

access_point_metadata instance-attribute

access_point_metadata: NotRequired[AccessPointMetadataMap]

Metadata for the backup access point. For continuous (point-in-time) recovery points, you must include an AccessPointInTime timestamp (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time. You can specify any time within the continuous backup's retention period, up to the latest restorable time. For snapshot recovery points, do not include AccessPointInTime.

access_point_policy instance-attribute

access_point_policy: NotRequired[AccessPointPolicy]

An optional resource-based policy, in JSON format, to apply to the underlying Amazon S3 access point. The policy controls how backup data can be accessed through the access point. If you do not specify a policy, access is governed by the caller's IAM permissions. For more information, see Configuring IAM policies for using access points in the Amazon S3 User Guide.

name instance-attribute

The name of the backup access point. This name is shared with the Amazon S3 access point namespace. It must be unique within your account and Region and cannot conflict with an existing Amazon S3 access point. For more information about access point naming, see Access points naming rules, restrictions, and limitations in the Amazon S3 User Guide.

recovery_point_arn instance-attribute

recovery_point_arn: RecoveryPointArn

The Amazon Resource Name (ARN) of the recovery point for which to create the backup access point. The recovery point must be an Amazon S3 recovery point in the AVAILABLE, STOPPED, or COMPLETED state.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to assign to the backup access point.