pub struct CreateAccessGrantFluentBuilder { /* private fields */ }
Expand description
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
andsso:DescribeApplication
For directory users -
identitystore:DescribeUser
For directory groups -
identitystore:DescribeGroup
You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt
, containing two spaces after my
, you must URL encode this value to my%20%20file.txt
.
Implementations§
Source§impl CreateAccessGrantFluentBuilder
impl CreateAccessGrantFluentBuilder
Sourcepub fn as_input(&self) -> &CreateAccessGrantInputBuilder
pub fn as_input(&self) -> &CreateAccessGrantInputBuilder
Access the CreateAccessGrant as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateAccessGrantOutput, SdkError<CreateAccessGrantError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateAccessGrantOutput, CreateAccessGrantError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateAccessGrantOutput, CreateAccessGrantError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
The Amazon Web Services account ID of the S3 Access Grants instance.
Sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
The Amazon Web Services account ID of the S3 Access Grants instance.
Sourcepub fn get_account_id(&self) -> &Option<String>
pub fn get_account_id(&self) -> &Option<String>
The Amazon Web Services account ID of the S3 Access Grants instance.
Sourcepub fn access_grants_location_id(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_access_grants_location_id(self, input: Option<String>) -> Self
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.
Sourcepub fn get_access_grants_location_id(&self) -> &Option<String>
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.
Sourcepub fn access_grants_location_configuration(
self,
input: AccessGrantsLocationConfiguration,
) -> Self
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.
Sourcepub fn set_access_grants_location_configuration(
self,
input: Option<AccessGrantsLocationConfiguration>,
) -> Self
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.
Sourcepub fn get_access_grants_location_configuration(
&self,
) -> &Option<AccessGrantsLocationConfiguration>
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.
Sourcepub fn grantee(self, input: Grantee) -> Self
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.
Sourcepub fn set_grantee(self, input: Option<Grantee>) -> Self
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.
Sourcepub fn get_grantee(&self) -> &Option<Grantee>
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.
Sourcepub fn permission(self, input: Permission) -> Self
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.
Sourcepub fn set_permission(self, input: Option<Permission>) -> Self
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.
Sourcepub fn get_permission(&self) -> &Option<Permission>
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.
Sourcepub fn application_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_application_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_application_arn(&self) -> &Option<String>
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.
Sourcepub fn s3_prefix_type(self, input: S3PrefixType) -> Self
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.
Sourcepub fn set_s3_prefix_type(self, input: Option<S3PrefixType>) -> Self
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.
Sourcepub fn get_s3_prefix_type(&self) -> &Option<S3PrefixType>
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.
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.
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.
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§
Source§impl Clone for CreateAccessGrantFluentBuilder
impl Clone for CreateAccessGrantFluentBuilder
Source§fn clone(&self) -> CreateAccessGrantFluentBuilder
fn clone(&self) -> CreateAccessGrantFluentBuilder
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 CreateAccessGrantFluentBuilder
impl !RefUnwindSafe for CreateAccessGrantFluentBuilder
impl Send for CreateAccessGrantFluentBuilder
impl Sync for CreateAccessGrantFluentBuilder
impl Unpin for CreateAccessGrantFluentBuilder
impl !UnwindSafe for CreateAccessGrantFluentBuilder
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§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);