Struct aws_sdk_s3control::operation::create_access_grant::builders::CreateAccessGrantFluentBuilder

pub struct CreateAccessGrantFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAccessGrant.

Creates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation.

Permissions

You must have the s3:CreateAccessGrant permission to use this operation.

Additional Permissions

For any directory identity - sso:DescribeInstance and sso:DescribeApplication

For directory users - identitystore:DescribeUser

For directory groups - identitystore:DescribeGroup

Implementations

impl CreateAccessGrantFluentBuilder

pub fn as_input(&self) -> &CreateAccessGrantInputBuilder

Access the CreateAccessGrant as a reference.

pub async fn send( self ) -> Result<CreateAccessGrantOutput, SdkError<CreateAccessGrantError, 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<CreateAccessGrantOutput, CreateAccessGrantError, 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 ID of the Amazon Web Services account that is making this request.

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

The ID of the Amazon Web Services account that is making this request.

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

The ID of the Amazon Web Services account that is making this request.

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

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

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

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

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

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

If you are passing the default location, you cannot create an access grant for the entire default location. You must also specify a bucket or a bucket and prefix in the Subprefix field.

pub fn access_grants_location_configuration( self, input: AccessGrantsLocationConfiguration ) -> Self

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

pub fn set_access_grants_location_configuration( self, input: Option<AccessGrantsLocationConfiguration> ) -> Self

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

pub fn get_access_grants_location_configuration( &self ) -> &Option<AccessGrantsLocationConfiguration>

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. It contains the S3SubPrefix field. The grant scope is the result of appending the subprefix to the location scope of the registered location.

pub fn grantee(self, input: Grantee) -> Self

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

pub fn set_grantee(self, input: Option<Grantee>) -> Self

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

pub fn get_grantee(&self) -> &Option<Grantee>

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

pub fn permission(self, input: Permission) -> Self

The type of access that you are granting to your S3 data, which can be set to one of the following values:

• READ – Grant read-only access to the S3 data.

• WRITE – Grant write-only access to the S3 data.

• READWRITE – Grant both read and write access to the S3 data.

pub fn set_permission(self, input: Option<Permission>) -> Self

The type of access that you are granting to your S3 data, which can be set to one of the following values:

• READ – Grant read-only access to the S3 data.

• WRITE – Grant write-only access to the S3 data.

• READWRITE – Grant both read and write access to the S3 data.

pub fn get_permission(&self) -> &Option<Permission>

The type of access that you are granting to your S3 data, which can be set to one of the following values:

• READ – Grant read-only access to the S3 data.

• WRITE – Grant write-only access to the S3 data.

• READWRITE – Grant both read and write access to the S3 data.

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

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

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

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

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

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If an application ARN is included in the request to create an access grant, the grantee can only access the S3 data through this application.

pub fn s3_prefix_type(self, input: S3PrefixType) -> Self

The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

pub fn set_s3_prefix_type(self, input: Option<S3PrefixType>) -> Self

The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

pub fn get_s3_prefix_type(&self) -> &Option<S3PrefixType>

The type of S3SubPrefix. The only possible value is Object. Pass this value if the access grant scope is an object. Do not pass this value if the access grant scope is a bucket or a bucket and a prefix.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

The Amazon Web Services resource tags that you are adding to the access grant. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

Trait Implementations

impl Clone for CreateAccessGrantFluentBuilder

fn clone(&self) -> CreateAccessGrantFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAccessGrantFluentBuilder

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

Formats the value using the given formatter.