aws_sdk_backup/client/

create_backup_access_point.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateBackupAccessPoint`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`access_point_metadata(impl Into<String>, impl Into<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::access_point_metadata) / [`set_access_point_metadata(Option<HashMap::<String, String>>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::set_access_point_metadata):<br>required: **false**<br><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><br>
    ///   - [`access_point_policy(impl Into<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::access_point_policy) / [`set_access_point_policy(Option<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::set_access_point_policy):<br>required: **false**<br><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><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::set_name):<br>required: **true**<br><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><br>
    ///   - [`recovery_point_arn(impl Into<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::recovery_point_arn) / [`set_recovery_point_arn(Option<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::set_recovery_point_arn):<br>required: **true**<br><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><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::set_tags):<br>required: **false**<br><p>The tags to assign to the backup access point.</p><br>
    /// - On success, responds with [`CreateBackupAccessPointOutput`](crate::operation::create_backup_access_point::CreateBackupAccessPointOutput) with field(s):
    ///   - [`access_point_arn(String)`](crate::operation::create_backup_access_point::CreateBackupAccessPointOutput::access_point_arn): <p>The Amazon Resource Name (ARN) that uniquely identifies the created backup access point.</p>
    ///   - [`status(AccessPointStatus)`](crate::operation::create_backup_access_point::CreateBackupAccessPointOutput::status): <p>The current status of the backup access point. A newly created backup access point begins in the <code>CREATING</code> state and becomes usable when it reaches <code>AVAILABLE</code>.</p>
    /// - On failure, responds with [`SdkError<CreateBackupAccessPointError>`](crate::operation::create_backup_access_point::CreateBackupAccessPointError)
    pub fn create_backup_access_point(&self) -> crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder {
        crate::operation::create_backup_access_point::builders::CreateBackupAccessPointFluentBuilder::new(self.handle.clone())
    }
}