Struct aws_sdk_s3control::operation::put_access_point_policy::builders::PutAccessPointPolicyFluentBuilder

pub struct PutAccessPointPolicyFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutAccessPointPolicy.

This operation is not supported by directory buckets.

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

• GetAccessPointPolicy

• DeleteAccessPointPolicy

Implementations

impl PutAccessPointPolicyFluentBuilder

pub fn as_input(&self) -> &PutAccessPointPolicyInputBuilder

Access the PutAccessPointPolicy as a reference.

pub async fn send( self ) -> Result<PutAccessPointPolicyOutput, SdkError<PutAccessPointPolicyError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<PutAccessPointPolicyOutput, PutAccessPointPolicyError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn account_id(self, input: impl Into<String>) -> Self

The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

pub fn set_account_id(self, input: Option<String>) -> Self

The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

pub fn get_account_id(&self) -> &Option<String>

The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

pub fn name(self, input: impl Into<String>) -> Self

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

pub fn set_name(self, input: Option<String>) -> Self

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

pub fn get_name(&self) -> &Option<String>

The name of the access point that you want to associate with the specified policy.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format arn:aws:s3-outposts: : :outpost/ /accesspoint/ . For example, to access the access point reports-ap through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. The value must be URL encoded.

pub fn policy(self, input: impl Into<String>) -> Self

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

pub fn set_policy(self, input: Option<String>) -> Self

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

pub fn get_policy(&self) -> &Option<String>

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

Trait Implementations

impl Clone for PutAccessPointPolicyFluentBuilder

fn clone(&self) -> PutAccessPointPolicyFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutAccessPointPolicyFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.