pub struct PutBucketAclFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to PutBucketAcl
.
This operation is not supported by directory buckets.
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have the WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
-
Specify the ACL in the request body
-
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported
error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
- Permissions
-
You can set access permissions by using one of the following methods:
-
Specify a canned ACL with the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value ofx-amz-acl
. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL. -
Specify access permissions explicitly with the
x-amz-grant-read
,x-amz-grant-read-acp
,x-amz-grant-write-acp
, andx-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use thex-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.You specify each grantee as a type=value pair, where the type is one of the following:
-
id
– if the value specified is the canonical user ID of an Amazon Web Services account -
uri
– if you are granting permissions to a predefined group -
emailAddress
– if the value specified is the email address of an Amazon Web Services accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
-
US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
-
For example, the following
x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
-
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
-
- Grantee Values
-
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
-
By the person's ID:
<>ID<> <>GranteesEmail<> DisplayName is optional and ignored in the request
-
By URI:
<>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<> -
By Email address:
<>Grantees@email.com<> &The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
-
US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
-
-
The following operations are related to PutBucketAcl
:
Implementations§
source§impl PutBucketAclFluentBuilder
impl PutBucketAclFluentBuilder
sourcepub fn as_input(&self) -> &PutBucketAclInputBuilder
pub fn as_input(&self) -> &PutBucketAclInputBuilder
Access the PutBucketAcl as a reference.
sourcepub async fn send(
self,
) -> Result<PutBucketAclOutput, SdkError<PutBucketAclError, HttpResponse>>
pub async fn send( self, ) -> Result<PutBucketAclOutput, SdkError<PutBucketAclError, 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.
sourcepub fn customize(
self,
) -> CustomizableOperation<PutBucketAclOutput, PutBucketAclError, Self>
pub fn customize( self, ) -> CustomizableOperation<PutBucketAclOutput, PutBucketAclError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn acl(self, input: BucketCannedAcl) -> Self
pub fn acl(self, input: BucketCannedAcl) -> Self
The canned ACL to apply to the bucket.
sourcepub fn set_acl(self, input: Option<BucketCannedAcl>) -> Self
pub fn set_acl(self, input: Option<BucketCannedAcl>) -> Self
The canned ACL to apply to the bucket.
sourcepub fn get_acl(&self) -> &Option<BucketCannedAcl>
pub fn get_acl(&self) -> &Option<BucketCannedAcl>
The canned ACL to apply to the bucket.
sourcepub fn access_control_policy(self, input: AccessControlPolicy) -> Self
pub fn access_control_policy(self, input: AccessControlPolicy) -> Self
Contains the elements that set the ACL permissions for an object per grantee.
sourcepub fn set_access_control_policy(
self,
input: Option<AccessControlPolicy>,
) -> Self
pub fn set_access_control_policy( self, input: Option<AccessControlPolicy>, ) -> Self
Contains the elements that set the ACL permissions for an object per grantee.
sourcepub fn get_access_control_policy(&self) -> &Option<AccessControlPolicy>
pub fn get_access_control_policy(&self) -> &Option<AccessControlPolicy>
Contains the elements that set the ACL permissions for an object per grantee.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The bucket to which to apply the ACL.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The bucket to which to apply the ACL.
sourcepub fn content_md5(self, input: impl Into<String>) -> Self
pub fn content_md5(self, input: impl Into<String>) -> Self
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
sourcepub fn set_content_md5(self, input: Option<String>) -> Self
pub fn set_content_md5(self, input: Option<String>) -> Self
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
sourcepub fn get_content_md5(&self) -> &Option<String>
pub fn get_content_md5(&self) -> &Option<String>
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
sourcepub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
pub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
sourcepub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
pub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
sourcepub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
sourcepub fn grant_full_control(self, input: impl Into<String>) -> Self
pub fn grant_full_control(self, input: impl Into<String>) -> Self
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
sourcepub fn set_grant_full_control(self, input: Option<String>) -> Self
pub fn set_grant_full_control(self, input: Option<String>) -> Self
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
sourcepub fn get_grant_full_control(&self) -> &Option<String>
pub fn get_grant_full_control(&self) -> &Option<String>
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
sourcepub fn grant_read(self, input: impl Into<String>) -> Self
pub fn grant_read(self, input: impl Into<String>) -> Self
Allows grantee to list the objects in the bucket.
sourcepub fn set_grant_read(self, input: Option<String>) -> Self
pub fn set_grant_read(self, input: Option<String>) -> Self
Allows grantee to list the objects in the bucket.
sourcepub fn get_grant_read(&self) -> &Option<String>
pub fn get_grant_read(&self) -> &Option<String>
Allows grantee to list the objects in the bucket.
sourcepub fn grant_read_acp(self, input: impl Into<String>) -> Self
pub fn grant_read_acp(self, input: impl Into<String>) -> Self
Allows grantee to read the bucket ACL.
sourcepub fn set_grant_read_acp(self, input: Option<String>) -> Self
pub fn set_grant_read_acp(self, input: Option<String>) -> Self
Allows grantee to read the bucket ACL.
sourcepub fn get_grant_read_acp(&self) -> &Option<String>
pub fn get_grant_read_acp(&self) -> &Option<String>
Allows grantee to read the bucket ACL.
sourcepub fn grant_write(self, input: impl Into<String>) -> Self
pub fn grant_write(self, input: impl Into<String>) -> Self
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
sourcepub fn set_grant_write(self, input: Option<String>) -> Self
pub fn set_grant_write(self, input: Option<String>) -> Self
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
sourcepub fn get_grant_write(&self) -> &Option<String>
pub fn get_grant_write(&self) -> &Option<String>
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
sourcepub fn grant_write_acp(self, input: impl Into<String>) -> Self
pub fn grant_write_acp(self, input: impl Into<String>) -> Self
Allows grantee to write the ACL for the applicable bucket.
sourcepub fn set_grant_write_acp(self, input: Option<String>) -> Self
pub fn set_grant_write_acp(self, input: Option<String>) -> Self
Allows grantee to write the ACL for the applicable bucket.
sourcepub fn get_grant_write_acp(&self) -> &Option<String>
pub fn get_grant_write_acp(&self) -> &Option<String>
Allows grantee to write the ACL for the applicable bucket.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
Trait Implementations§
source§impl Clone for PutBucketAclFluentBuilder
impl Clone for PutBucketAclFluentBuilder
source§fn clone(&self) -> PutBucketAclFluentBuilder
fn clone(&self) -> PutBucketAclFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for PutBucketAclFluentBuilder
impl !RefUnwindSafe for PutBucketAclFluentBuilder
impl Send for PutBucketAclFluentBuilder
impl Sync for PutBucketAclFluentBuilder
impl Unpin for PutBucketAclFluentBuilder
impl !UnwindSafe for PutBucketAclFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)