#[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)§
This struct is marked as non-exhaustive
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.
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§
Source§impl CreateAccessGrantInput
impl CreateAccessGrantInput
Sourcepub fn account_id(&self) -> Option<&str>
pub fn account_id(&self) -> Option<&str>
The Amazon Web Services account ID of the S3 Access Grants instance.
Sourcepub fn access_grants_location_id(&self) -> Option<&str>
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.
Sourcepub fn access_grants_location_configuration(
&self,
) -> Option<&AccessGrantsLocationConfiguration>
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.
Sourcepub fn grantee(&self) -> Option<&Grantee>
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.
Sourcepub fn permission(&self) -> Option<&Permission>
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.
Sourcepub fn application_arn(&self) -> Option<&str>
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.
Sourcepub fn s3_prefix_type(&self) -> Option<&S3PrefixType>
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.
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()
.
Source§impl CreateAccessGrantInput
impl CreateAccessGrantInput
Sourcepub fn builder() -> CreateAccessGrantInputBuilder
pub fn builder() -> CreateAccessGrantInputBuilder
Creates a new builder-style object to manufacture CreateAccessGrantInput
.
Trait Implementations§
Source§impl Clone for CreateAccessGrantInput
impl Clone for CreateAccessGrantInput
Source§fn clone(&self) -> CreateAccessGrantInput
fn clone(&self) -> CreateAccessGrantInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateAccessGrantInput
impl Debug for CreateAccessGrantInput
Source§impl PartialEq for CreateAccessGrantInput
impl PartialEq for CreateAccessGrantInput
impl StructuralPartialEq for CreateAccessGrantInput
Auto Trait Implementations§
impl Freeze for CreateAccessGrantInput
impl RefUnwindSafe for CreateAccessGrantInput
impl Send for CreateAccessGrantInput
impl Sync for CreateAccessGrantInput
impl Unpin for CreateAccessGrantInput
impl UnwindSafe for CreateAccessGrantInput
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);