#[non_exhaustive]pub struct Studio {Show 16 fields
pub admin_role_arn: Option<String>,
pub arn: Option<String>,
pub created_at: Option<DateTime>,
pub display_name: Option<String>,
pub home_region: Option<String>,
pub sso_client_id: Option<String>,
pub state: Option<StudioState>,
pub status_code: Option<StudioStatusCode>,
pub status_message: Option<String>,
pub studio_encryption_configuration: Option<StudioEncryptionConfiguration>,
pub studio_id: Option<String>,
pub studio_name: Option<String>,
pub studio_url: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub updated_at: Option<DateTime>,
pub user_role_arn: Option<String>,
}Expand description
Represents a studio resource.
A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.
When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.
The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.
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.admin_role_arn: Option<String>The IAM role that studio admins assume when logging in to the Nimble Studio portal.
arn: Option<String>The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
created_at: Option<DateTime>The ISO timestamp in seconds for when the resource was created.
display_name: Option<String>A friendly name for the studio.
home_region: Option<String>The Amazon Web Services Region where the studio resource is located.
sso_client_id: Option<String>The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
state: Option<StudioState>The current state of the studio resource.
status_code: Option<StudioStatusCode>Status codes that provide additional detail on the studio state.
status_message: Option<String>Additional detail on the studio state.
studio_encryption_configuration: Option<StudioEncryptionConfiguration>Configuration of the encryption method that is used for the studio.
studio_id: Option<String>The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
studio_name: Option<String>The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
studio_url: Option<String>The address of the web page for the studio.
A collection of labels, in the form of key-value pairs, that apply to this resource.
updated_at: Option<DateTime>The ISO timestamp in seconds for when the resource was updated.
user_role_arn: Option<String>The IAM role that studio users assume when logging in to the Nimble Studio portal.
Implementations§
Source§impl Studio
impl Studio
Sourcepub fn admin_role_arn(&self) -> Option<&str>
pub fn admin_role_arn(&self) -> Option<&str>
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
Sourcepub fn arn(&self) -> Option<&str>
pub fn arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The ISO timestamp in seconds for when the resource was created.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
A friendly name for the studio.
Sourcepub fn home_region(&self) -> Option<&str>
pub fn home_region(&self) -> Option<&str>
The Amazon Web Services Region where the studio resource is located.
Sourcepub fn sso_client_id(&self) -> Option<&str>
pub fn sso_client_id(&self) -> Option<&str>
The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
Sourcepub fn state(&self) -> Option<&StudioState>
pub fn state(&self) -> Option<&StudioState>
The current state of the studio resource.
Sourcepub fn status_code(&self) -> Option<&StudioStatusCode>
pub fn status_code(&self) -> Option<&StudioStatusCode>
Status codes that provide additional detail on the studio state.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
Additional detail on the studio state.
Sourcepub fn studio_encryption_configuration(
&self,
) -> Option<&StudioEncryptionConfiguration>
pub fn studio_encryption_configuration( &self, ) -> Option<&StudioEncryptionConfiguration>
Configuration of the encryption method that is used for the studio.
Sourcepub fn studio_id(&self) -> Option<&str>
pub fn studio_id(&self) -> Option<&str>
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
Sourcepub fn studio_name(&self) -> Option<&str>
pub fn studio_name(&self) -> Option<&str>
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
Sourcepub fn studio_url(&self) -> Option<&str>
pub fn studio_url(&self) -> Option<&str>
The address of the web page for the studio.
A collection of labels, in the form of key-value pairs, that apply to this resource.
Sourcepub fn updated_at(&self) -> Option<&DateTime>
pub fn updated_at(&self) -> Option<&DateTime>
The ISO timestamp in seconds for when the resource was updated.
Sourcepub fn user_role_arn(&self) -> Option<&str>
pub fn user_role_arn(&self) -> Option<&str>
The IAM role that studio users assume when logging in to the Nimble Studio portal.
Trait Implementations§
impl StructuralPartialEq for Studio
Auto Trait Implementations§
impl Freeze for Studio
impl RefUnwindSafe for Studio
impl Send for Studio
impl Sync for Studio
impl Unpin for Studio
impl UnwindSafe for Studio
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);