#[non_exhaustive]pub struct RoleBuilder { /* private fields */ }
Expand description
A builder for Role
.
Implementations§
Source§impl RoleBuilder
impl RoleBuilder
Sourcepub fn path(self, input: impl Into<String>) -> Self
pub fn path(self, input: impl Into<String>) -> Self
The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
This field is required.Sourcepub fn set_path(self, input: Option<String>) -> Self
pub fn set_path(self, input: Option<String>) -> Self
The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
Sourcepub fn get_path(&self) -> &Option<String>
pub fn get_path(&self) -> &Option<String>
The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
Sourcepub fn role_name(self, input: impl Into<String>) -> Self
pub fn role_name(self, input: impl Into<String>) -> Self
The friendly name that identifies the role.
This field is required.Sourcepub fn set_role_name(self, input: Option<String>) -> Self
pub fn set_role_name(self, input: Option<String>) -> Self
The friendly name that identifies the role.
Sourcepub fn get_role_name(&self) -> &Option<String>
pub fn get_role_name(&self) -> &Option<String>
The friendly name that identifies the role.
Sourcepub fn role_id(self, input: impl Into<String>) -> Self
pub fn role_id(self, input: impl Into<String>) -> Self
The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
This field is required.Sourcepub fn set_role_id(self, input: Option<String>) -> Self
pub fn set_role_id(self, input: Option<String>) -> Self
The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
Sourcepub fn get_role_id(&self) -> &Option<String>
pub fn get_role_id(&self) -> &Option<String>
The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.
Sourcepub fn create_date(self, input: DateTime) -> Self
pub fn create_date(self, input: DateTime) -> Self
The date and time, in ISO 8601 date-time format, when the role was created.
This field is required.Sourcepub fn set_create_date(self, input: Option<DateTime>) -> Self
pub fn set_create_date(self, input: Option<DateTime>) -> Self
The date and time, in ISO 8601 date-time format, when the role was created.
Sourcepub fn get_create_date(&self) -> &Option<DateTime>
pub fn get_create_date(&self) -> &Option<DateTime>
The date and time, in ISO 8601 date-time format, when the role was created.
Sourcepub fn assume_role_policy_document(self, input: impl Into<String>) -> Self
pub fn assume_role_policy_document(self, input: impl Into<String>) -> Self
The policy that grants an entity permission to assume the role.
Sourcepub fn set_assume_role_policy_document(self, input: Option<String>) -> Self
pub fn set_assume_role_policy_document(self, input: Option<String>) -> Self
The policy that grants an entity permission to assume the role.
Sourcepub fn get_assume_role_policy_document(&self) -> &Option<String>
pub fn get_assume_role_policy_document(&self) -> &Option<String>
The policy that grants an entity permission to assume the role.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the role that you provide.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the role that you provide.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the role that you provide.
Sourcepub fn max_session_duration(self, input: i32) -> Self
pub fn max_session_duration(self, input: i32) -> Self
The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds
API parameter or duration-seconds
CLI parameter.
Sourcepub fn set_max_session_duration(self, input: Option<i32>) -> Self
pub fn set_max_session_duration(self, input: Option<i32>) -> Self
The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds
API parameter or duration-seconds
CLI parameter.
Sourcepub fn get_max_session_duration(&self) -> &Option<i32>
pub fn get_max_session_duration(&self) -> &Option<i32>
The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds
API parameter or duration-seconds
CLI parameter.
Sourcepub fn permissions_boundary(self, input: AttachedPermissionsBoundary) -> Self
pub fn permissions_boundary(self, input: AttachedPermissionsBoundary) -> Self
The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Sourcepub fn set_permissions_boundary(
self,
input: Option<AttachedPermissionsBoundary>,
) -> Self
pub fn set_permissions_boundary( self, input: Option<AttachedPermissionsBoundary>, ) -> Self
The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Sourcepub fn get_permissions_boundary(&self) -> &Option<AttachedPermissionsBoundary>
pub fn get_permissions_boundary(&self) -> &Option<AttachedPermissionsBoundary>
The ARN of the policy used to set the permissions boundary for the role.
For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
Sourcepub fn role_last_used(self, input: RoleLastUsed) -> Self
pub fn role_last_used(self, input: RoleLastUsed) -> Self
Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
Sourcepub fn set_role_last_used(self, input: Option<RoleLastUsed>) -> Self
pub fn set_role_last_used(self, input: Option<RoleLastUsed>) -> Self
Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
Sourcepub fn get_role_last_used(&self) -> &Option<RoleLastUsed>
pub fn get_role_last_used(&self) -> &Option<RoleLastUsed>
Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
Trait Implementations§
Source§impl Clone for RoleBuilder
impl Clone for RoleBuilder
Source§fn clone(&self) -> RoleBuilder
fn clone(&self) -> RoleBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RoleBuilder
impl Debug for RoleBuilder
Source§impl Default for RoleBuilder
impl Default for RoleBuilder
Source§fn default() -> RoleBuilder
fn default() -> RoleBuilder
Source§impl PartialEq for RoleBuilder
impl PartialEq for RoleBuilder
impl StructuralPartialEq for RoleBuilder
Auto Trait Implementations§
impl Freeze for RoleBuilder
impl RefUnwindSafe for RoleBuilder
impl Send for RoleBuilder
impl Sync for RoleBuilder
impl Unpin for RoleBuilder
impl UnwindSafe for RoleBuilder
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);