Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface 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.

Hierarchy

  • Studio

Index

Properties

Optional adminRoleArn

adminRoleArn: undefined | string

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

Optional arn

arn: undefined | string

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

Optional createdAt

createdAt: Date

The Unix epoch timestamp in seconds for when the resource was created.

Optional displayName

displayName: undefined | string

A friendly name for the studio.

Optional homeRegion

homeRegion: undefined | string

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

Optional ssoClientId

ssoClientId: undefined | string

The IAM Identity Center application client ID used to integrate with IAM Identity Center to enable IAM Identity Center users to log in to Nimble Studio portal.

Optional state

state: StudioState | string

The current state of the studio resource.

Optional statusCode

statusCode: StudioStatusCode | string

Status codes that provide additional detail on the studio state.

Optional statusMessage

statusMessage: undefined | string

Additional detail on the studio state.

Optional studioEncryptionConfiguration

studioEncryptionConfiguration: StudioEncryptionConfiguration

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

Optional studioId

studioId: undefined | string

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

Optional studioName

studioName: undefined | string

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

Optional studioUrl

studioUrl: undefined | string

The address of the web page for the studio.

Optional tags

tags: Record<string, string>

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

Optional updatedAt

updatedAt: Date

The Unix epoch timestamp in seconds for when the resource was updated.

Optional userRoleArn

userRoleArn: undefined | string

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