#[non_exhaustive]pub struct S3DataAccessAssetBuilder { /* private fields */ }
Expand description
A builder for S3DataAccessAsset
.
Implementations§
Source§impl S3DataAccessAssetBuilder
impl S3DataAccessAssetBuilder
Sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The Amazon S3 bucket hosting data to be shared in the S3 data access.
This field is required.Sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The Amazon S3 bucket hosting data to be shared in the S3 data access.
Sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The Amazon S3 bucket hosting data to be shared in the S3 data access.
Sourcepub fn key_prefixes(self, input: impl Into<String>) -> Self
pub fn key_prefixes(self, input: impl Into<String>) -> Self
Appends an item to key_prefixes
.
To override the contents of this collection use set_key_prefixes
.
The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
Sourcepub fn set_key_prefixes(self, input: Option<Vec<String>>) -> Self
pub fn set_key_prefixes(self, input: Option<Vec<String>>) -> Self
The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
Sourcepub fn get_key_prefixes(&self) -> &Option<Vec<String>>
pub fn get_key_prefixes(&self) -> &Option<Vec<String>>
The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.
Sourcepub fn keys(self, input: impl Into<String>) -> Self
pub fn keys(self, input: impl Into<String>) -> Self
Appends an item to keys
.
To override the contents of this collection use set_keys
.
S3 keys made available using this asset.
Sourcepub fn set_keys(self, input: Option<Vec<String>>) -> Self
pub fn set_keys(self, input: Option<Vec<String>>) -> Self
S3 keys made available using this asset.
Sourcepub fn s3_access_point_alias(self, input: impl Into<String>) -> Self
pub fn s3_access_point_alias(self, input: impl Into<String>) -> Self
The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.
Sourcepub fn set_s3_access_point_alias(self, input: Option<String>) -> Self
pub fn set_s3_access_point_alias(self, input: Option<String>) -> Self
The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.
Sourcepub fn get_s3_access_point_alias(&self) -> &Option<String>
pub fn get_s3_access_point_alias(&self) -> &Option<String>
The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.
Sourcepub fn s3_access_point_arn(self, input: impl Into<String>) -> Self
pub fn s3_access_point_arn(self, input: impl Into<String>) -> Self
The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.
Sourcepub fn set_s3_access_point_arn(self, input: Option<String>) -> Self
pub fn set_s3_access_point_arn(self, input: Option<String>) -> Self
The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.
Sourcepub fn get_s3_access_point_arn(&self) -> &Option<String>
pub fn get_s3_access_point_arn(&self) -> &Option<String>
The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.
Sourcepub fn kms_keys_to_grant(self, input: KmsKeyToGrant) -> Self
pub fn kms_keys_to_grant(self, input: KmsKeyToGrant) -> Self
Appends an item to kms_keys_to_grant
.
To override the contents of this collection use set_kms_keys_to_grant
.
List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.
Sourcepub fn set_kms_keys_to_grant(self, input: Option<Vec<KmsKeyToGrant>>) -> Self
pub fn set_kms_keys_to_grant(self, input: Option<Vec<KmsKeyToGrant>>) -> Self
List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.
Sourcepub fn get_kms_keys_to_grant(&self) -> &Option<Vec<KmsKeyToGrant>>
pub fn get_kms_keys_to_grant(&self) -> &Option<Vec<KmsKeyToGrant>>
List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.
Sourcepub fn build(self) -> Result<S3DataAccessAsset, BuildError>
pub fn build(self) -> Result<S3DataAccessAsset, BuildError>
Consumes the builder and constructs a S3DataAccessAsset
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for S3DataAccessAssetBuilder
impl Clone for S3DataAccessAssetBuilder
Source§fn clone(&self) -> S3DataAccessAssetBuilder
fn clone(&self) -> S3DataAccessAssetBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for S3DataAccessAssetBuilder
impl Debug for S3DataAccessAssetBuilder
Source§impl Default for S3DataAccessAssetBuilder
impl Default for S3DataAccessAssetBuilder
Source§fn default() -> S3DataAccessAssetBuilder
fn default() -> S3DataAccessAssetBuilder
Source§impl PartialEq for S3DataAccessAssetBuilder
impl PartialEq for S3DataAccessAssetBuilder
impl StructuralPartialEq for S3DataAccessAssetBuilder
Auto Trait Implementations§
impl Freeze for S3DataAccessAssetBuilder
impl RefUnwindSafe for S3DataAccessAssetBuilder
impl Send for S3DataAccessAssetBuilder
impl Sync for S3DataAccessAssetBuilder
impl Unpin for S3DataAccessAssetBuilder
impl UnwindSafe for S3DataAccessAssetBuilder
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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);