nimble/aws.sdk.kotlin.services.nimble.model/Studio

Studio

class Studio

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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val adminRoleArn: String?

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

Link copied to clipboard
val arn: String?

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

Link copied to clipboard
val createdAt: Instant?

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

Link copied to clipboard
val displayName: String?

A friendly name for the studio.

Link copied to clipboard
val homeRegion: String?

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

Link copied to clipboard
val ssoClientId: 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.

Link copied to clipboard
val state: StudioState?

The current state of the studio resource.

Link copied to clipboard
val statusCode: StudioStatusCode?

Status codes that provide additional detail on the studio state.

Link copied to clipboard
val statusMessage: String?

Additional detail on the studio state.

Link copied to clipboard
val studioEncryptionConfiguration: StudioEncryptionConfiguration?

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

Link copied to clipboard
val studioId: String?

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

Link copied to clipboard
val studioName: String?

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

Link copied to clipboard
val studioUrl: String?

The address of the web page for the studio.

Link copied to clipboard
val tags: Map<String, String>?

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

Link copied to clipboard
val updatedAt: Instant?

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

Link copied to clipboard
val userRoleArn: String?

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

Functions

Link copied to clipboard
inline fun copy(block: Studio.Builder.() -> Unit = {}): Studio
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String