Struct aws_sdk_nimble::types::StudioComponent

#[non_exhaustive]
pub struct StudioComponent {

    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>,
}

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)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

tags: Option<HashMap<String, String>>

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

impl StudioComponent

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.

pub fn configuration(&self) -> Option<&StudioComponentConfiguration>

The configuration of the studio component, based on component type.

pub fn created_at(&self) -> Option<&DateTime>

The ISO timestamp in seconds for when the resource was created.

pub fn created_by(&self) -> Option<&str>

The user ID of the user that created the studio component.

pub fn description(&self) -> Option<&str>

A human-readable description for the studio component resource.

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().

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().

pub fn name(&self) -> Option<&str>

A friendly name for the studio component resource.

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().

pub fn state(&self) -> Option<&StudioComponentState>

The current state.

pub fn status_code(&self) -> Option<&StudioComponentStatusCode>

The status code.

pub fn status_message(&self) -> Option<&str>

The status message for the studio component.

pub fn studio_component_id(&self) -> Option<&str>

The unique identifier for a studio component resource.

pub fn subtype(&self) -> Option<&StudioComponentSubtype>

The specific subtype of a studio component.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A collection of labels, in the form of key-value pairs, that apply to this resource.

pub fn type(&self) -> Option<&StudioComponentType>

The type of the studio component.

pub fn updated_at(&self) -> Option<&DateTime>

The ISO timestamp in seconds for when the resource was updated.

pub fn updated_by(&self) -> Option<&str>

The user ID of the user that most recently updated the resource.

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.

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.

impl StudioComponent

pub fn builder() -> StudioComponentBuilder

Creates a new builder-style object to manufacture StudioComponent.

Trait Implementations

impl Clone for StudioComponent

fn clone(&self) -> StudioComponent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StudioComponent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StudioComponent

fn eq(&self, other: &StudioComponent) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StudioComponent