#[non_exhaustive]pub struct StudioComponent {Show 20 fields
pub arn: Option<String>,
pub configuration: Option<StudioComponentConfiguration>,
pub created_at: Option<DateTime>,
pub created_by: Option<String>,
pub description: Option<String>,
pub ec2_security_group_ids: Option<Vec<String>>,
pub initialization_scripts: Option<Vec<StudioComponentInitializationScript>>,
pub name: Option<String>,
pub script_parameters: Option<Vec<ScriptParameterKeyValue>>,
pub state: Option<StudioComponentState>,
pub status_code: Option<StudioComponentStatusCode>,
pub status_message: Option<String>,
pub studio_component_id: Option<String>,
pub subtype: Option<StudioComponentSubtype>,
pub tags: Option<HashMap<String, String>>,
pub type: Option<StudioComponentType>,
pub updated_at: Option<DateTime>,
pub updated_by: Option<String>,
pub secure_initialization_role_arn: Option<String>,
pub runtime_role_arn: Option<String>,
}Expand description
A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.
Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.
A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.
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.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.
configuration: Option<StudioComponentConfiguration>The configuration of the studio component, based on component type.
created_at: Option<DateTime>The ISO timestamp in seconds for when the resource was created.
created_by: Option<String>The user ID of the user that created the studio component.
description: Option<String>A human-readable description for the studio component resource.
ec2_security_group_ids: Option<Vec<String>>The EC2 security groups that control access to the studio component.
initialization_scripts: Option<Vec<StudioComponentInitializationScript>>Initialization scripts for studio components.
name: Option<String>A friendly name for the studio component resource.
script_parameters: Option<Vec<ScriptParameterKeyValue>>Parameters for the studio component scripts.
state: Option<StudioComponentState>The current state.
status_code: Option<StudioComponentStatusCode>The status code.
status_message: Option<String>The status message for the studio component.
studio_component_id: Option<String>The unique identifier for a studio component resource.
subtype: Option<StudioComponentSubtype>The specific subtype of a studio component.
A collection of labels, in the form of key-value pairs, that apply to this resource.
type: Option<StudioComponentType>The type of the studio component.
updated_at: Option<DateTime>The ISO timestamp in seconds for when the resource was updated.
updated_by: Option<String>The user ID of the user that most recently updated the resource.
secure_initialization_role_arn: Option<String>An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
runtime_role_arn: Option<String>An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
Implementations§
Source§impl StudioComponent
impl StudioComponent
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 configuration(&self) -> Option<&StudioComponentConfiguration>
pub fn configuration(&self) -> Option<&StudioComponentConfiguration>
The configuration of the studio component, based on component type.
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 created_by(&self) -> Option<&str>
pub fn created_by(&self) -> Option<&str>
The user ID of the user that created the studio component.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A human-readable description for the studio component resource.
Sourcepub fn ec2_security_group_ids(&self) -> &[String]
pub fn ec2_security_group_ids(&self) -> &[String]
The EC2 security groups that control access to the studio component.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ec2_security_group_ids.is_none().
Sourcepub fn initialization_scripts(&self) -> &[StudioComponentInitializationScript]
pub fn initialization_scripts(&self) -> &[StudioComponentInitializationScript]
Initialization scripts for studio components.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .initialization_scripts.is_none().
Sourcepub fn script_parameters(&self) -> &[ScriptParameterKeyValue]
pub fn script_parameters(&self) -> &[ScriptParameterKeyValue]
Parameters for the studio component scripts.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .script_parameters.is_none().
Sourcepub fn state(&self) -> Option<&StudioComponentState>
pub fn state(&self) -> Option<&StudioComponentState>
The current state.
Sourcepub fn status_code(&self) -> Option<&StudioComponentStatusCode>
pub fn status_code(&self) -> Option<&StudioComponentStatusCode>
The status code.
Sourcepub fn status_message(&self) -> Option<&str>
pub fn status_message(&self) -> Option<&str>
The status message for the studio component.
Sourcepub fn studio_component_id(&self) -> Option<&str>
pub fn studio_component_id(&self) -> Option<&str>
The unique identifier for a studio component resource.
Sourcepub fn subtype(&self) -> Option<&StudioComponentSubtype>
pub fn subtype(&self) -> Option<&StudioComponentSubtype>
The specific subtype of a studio component.
A collection of labels, in the form of key-value pairs, that apply to this resource.
Sourcepub fn type(&self) -> Option<&StudioComponentType>
pub fn type(&self) -> Option<&StudioComponentType>
The type of the studio component.
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 updated_by(&self) -> Option<&str>
pub fn updated_by(&self) -> Option<&str>
The user ID of the user that most recently updated the resource.
Sourcepub fn secure_initialization_role_arn(&self) -> Option<&str>
pub fn secure_initialization_role_arn(&self) -> Option<&str>
An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
Sourcepub fn runtime_role_arn(&self) -> Option<&str>
pub fn runtime_role_arn(&self) -> Option<&str>
An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
Source§impl StudioComponent
impl StudioComponent
Sourcepub fn builder() -> StudioComponentBuilder
pub fn builder() -> StudioComponentBuilder
Creates a new builder-style object to manufacture StudioComponent.
Trait Implementations§
Source§impl Clone for StudioComponent
impl Clone for StudioComponent
Source§fn clone(&self) -> StudioComponent
fn clone(&self) -> StudioComponent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for StudioComponent
impl Debug for StudioComponent
Source§impl PartialEq for StudioComponent
impl PartialEq for StudioComponent
impl StructuralPartialEq for StudioComponent
Auto Trait Implementations§
impl Freeze for StudioComponent
impl RefUnwindSafe for StudioComponent
impl Send for StudioComponent
impl Sync for StudioComponent
impl Unpin for StudioComponent
impl UnwindSafe for StudioComponent
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);