Struct aws_sdk_nimble::types::Studio

#[non_exhaustive]
pub struct Studio {

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

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)

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.

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.

tags: Option<HashMap<String, String>>

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

impl Studio

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

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

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 created_at(&self) -> Option<&DateTime>

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

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

A friendly name for the studio.

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

The Amazon Web Services Region where the studio resource is located.

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.

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

The current state of the studio resource.

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

Status codes that provide additional detail on the studio state.

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

Additional detail on the studio state.

pub fn studio_encryption_configuration( &self ) -> Option<&StudioEncryptionConfiguration>

Configuration of the encryption method that is used for the studio.

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.

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.

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

The address of the web page for the studio.

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 updated_at(&self) -> Option<&DateTime>

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

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

The IAM role that studio users assume when logging in to the Nimble Studio portal.

impl Studio

pub fn builder() -> StudioBuilder

Creates a new builder-style object to manufacture Studio.

Trait Implementations

impl Clone for Studio

fn clone(&self) -> Studio

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Studio

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

Formats the value using the given formatter.

impl PartialEq for Studio

fn eq(&self, other: &Studio) -> 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 Studio