Struct aws_sdk_s3control::operation::create_access_grant::CreateAccessGrantInput

#[non_exhaustive]
pub struct CreateAccessGrantInput {
    pub account_id: Option<String>,
    pub access_grants_location_id: Option<String>,
    pub access_grants_location_configuration: Option<AccessGrantsLocationConfiguration>,
    pub grantee: Option<Grantee>,
    pub permission: Option<Permission>,
    pub application_arn: Option<String>,
    pub s3_prefix_type: Option<S3PrefixType>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

account_id: Option<String>

The Amazon Web Services account ID of the S3 Access Grants instance.

access_grants_location_id: 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.

access_grants_location_configuration: 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.

grantee: 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.

permission: 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.

application_arn: 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.

s3_prefix_type: 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.

tags: 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.

Implementations

impl CreateAccessGrantInput

pub fn account_id(&self) -> Option<&str>

The Amazon Web Services account ID of the S3 Access Grants instance.

pub fn access_grants_location_id(&self) -> Option<&str>

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, ) -> 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) -> 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) -> 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) -> Option<&str>

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) -> 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateAccessGrantInput

pub fn builder() -> CreateAccessGrantInputBuilder

Creates a new builder-style object to manufacture CreateAccessGrantInput.

Trait Implementations

impl Clone for CreateAccessGrantInput

fn clone(&self) -> CreateAccessGrantInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAccessGrantInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAccessGrantInput

fn eq(&self, other: &CreateAccessGrantInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateAccessGrantInput