Studio (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.nimblestudio.model.Studio

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Studio
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Studio()

Constructors
Constructor and Description
`Studio()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Studio`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Studio`	`clearTagsEntries()` Removes all the entries added into Tags.
`Studio`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAdminRoleArn()` The IAM role that studio admins assume when logging in to the Nimble Studio portal.
`String`	`getArn()` The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
`Date`	`getCreatedAt()` The ISO timestamp in seconds for when the resource was created.
`String`	`getDisplayName()` A friendly name for the studio.
`String`	`getHomeRegion()` The Amazon Web Services Region where the studio resource is located.
`String`	`getSsoClientId()` The IAM Identity Center application client ID used to integrate with IAM Identity Center.
`String`	`getState()` The current state of the studio resource.
`String`	`getStatusCode()` Status codes that provide additional detail on the studio state.
`String`	`getStatusMessage()` Additional detail on the studio state.
`StudioEncryptionConfiguration`	`getStudioEncryptionConfiguration()` Configuration of the encryption method that is used for the studio.
`String`	`getStudioId()` The unique identifier for a studio resource.
`String`	`getStudioName()` The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
`String`	`getStudioUrl()` The address of the web page for the studio.
`Map<String,String>`	`getTags()` A collection of labels, in the form of key-value pairs, that apply to this resource.
`Date`	`getUpdatedAt()` The ISO timestamp in seconds for when the resource was updated.
`String`	`getUserRoleArn()` The IAM role that studio users assume when logging in to the Nimble Studio portal.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdminRoleArn(String adminRoleArn)` The IAM role that studio admins assume when logging in to the Nimble Studio portal.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
`void`	`setCreatedAt(Date createdAt)` The ISO timestamp in seconds for when the resource was created.
`void`	`setDisplayName(String displayName)` A friendly name for the studio.
`void`	`setHomeRegion(String homeRegion)` The Amazon Web Services Region where the studio resource is located.
`void`	`setSsoClientId(String ssoClientId)` The IAM Identity Center application client ID used to integrate with IAM Identity Center.
`void`	`setState(String state)` The current state of the studio resource.
`void`	`setStatusCode(String statusCode)` Status codes that provide additional detail on the studio state.
`void`	`setStatusMessage(String statusMessage)` Additional detail on the studio state.
`void`	`setStudioEncryptionConfiguration(StudioEncryptionConfiguration studioEncryptionConfiguration)` Configuration of the encryption method that is used for the studio.
`void`	`setStudioId(String studioId)` The unique identifier for a studio resource.
`void`	`setStudioName(String studioName)` The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
`void`	`setStudioUrl(String studioUrl)` The address of the web page for the studio.
`void`	`setTags(Map<String,String> tags)` A collection of labels, in the form of key-value pairs, that apply to this resource.
`void`	`setUpdatedAt(Date updatedAt)` The ISO timestamp in seconds for when the resource was updated.
`void`	`setUserRoleArn(String userRoleArn)` The IAM role that studio users assume when logging in to the Nimble Studio portal.
`String`	`toString()` Returns a string representation of this object.
`Studio`	`withAdminRoleArn(String adminRoleArn)` The IAM role that studio admins assume when logging in to the Nimble Studio portal.
`Studio`	`withArn(String arn)` The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
`Studio`	`withCreatedAt(Date createdAt)` The ISO timestamp in seconds for when the resource was created.
`Studio`	`withDisplayName(String displayName)` A friendly name for the studio.
`Studio`	`withHomeRegion(String homeRegion)` The Amazon Web Services Region where the studio resource is located.
`Studio`	`withSsoClientId(String ssoClientId)` The IAM Identity Center application client ID used to integrate with IAM Identity Center.
`Studio`	`withState(String state)` The current state of the studio resource.
`Studio`	`withState(StudioState state)` The current state of the studio resource.
`Studio`	`withStatusCode(String statusCode)` Status codes that provide additional detail on the studio state.
`Studio`	`withStatusCode(StudioStatusCode statusCode)` Status codes that provide additional detail on the studio state.
`Studio`	`withStatusMessage(String statusMessage)` Additional detail on the studio state.
`Studio`	`withStudioEncryptionConfiguration(StudioEncryptionConfiguration studioEncryptionConfiguration)` Configuration of the encryption method that is used for the studio.
`Studio`	`withStudioId(String studioId)` The unique identifier for a studio resource.
`Studio`	`withStudioName(String studioName)` The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
`Studio`	`withStudioUrl(String studioUrl)` The address of the web page for the studio.
`Studio`	`withTags(Map<String,String> tags)` A collection of labels, in the form of key-value pairs, that apply to this resource.
`Studio`	`withUpdatedAt(Date updatedAt)` The ISO timestamp in seconds for when the resource was updated.
`Studio`	`withUserRoleArn(String userRoleArn)` The IAM role that studio users assume when logging in to the Nimble Studio portal.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Studio
```
public Studio()
```
- Method Detail
  - setAdminRoleArn
```
public void setAdminRoleArn(String adminRoleArn)
```
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    
    Parameters:
    
    adminRoleArn - The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - getAdminRoleArn
```
public String getAdminRoleArn()
```
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - withAdminRoleArn
```
public Studio withAdminRoleArn(String adminRoleArn)
```
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    
    Parameters:
    
    adminRoleArn - The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - withArn
```
public Studio withArn(String arn)
```
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The ISO timestamp in seconds for when the resource was created.
    
    Parameters:
    
    createdAt - The ISO timestamp in seconds for when the resource was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The ISO timestamp in seconds for when the resource was created.
    
    Returns:
    
    The ISO timestamp in seconds for when the resource was created.
  - withCreatedAt
```
public Studio withCreatedAt(Date createdAt)
```
    The ISO timestamp in seconds for when the resource was created.
    
    Parameters:
    
    createdAt - The ISO timestamp in seconds for when the resource was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    A friendly name for the studio.
    
    Parameters:
    
    displayName - A friendly name for the studio.
  - getDisplayName
```
public String getDisplayName()
```
    A friendly name for the studio.
    
    Returns:
    
    A friendly name for the studio.
  - withDisplayName
```
public Studio withDisplayName(String displayName)
```
    A friendly name for the studio.
    
    Parameters:
    
    displayName - A friendly name for the studio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHomeRegion
```
public void setHomeRegion(String homeRegion)
```
    The Amazon Web Services Region where the studio resource is located.
    
    Parameters:
    
    homeRegion - The Amazon Web Services Region where the studio resource is located.
  - getHomeRegion
```
public String getHomeRegion()
```
    The Amazon Web Services Region where the studio resource is located.
    
    Returns:
    
    The Amazon Web Services Region where the studio resource is located.
  - withHomeRegion
```
public Studio withHomeRegion(String homeRegion)
```
    The Amazon Web Services Region where the studio resource is located.
    
    Parameters:
    
    homeRegion - The Amazon Web Services Region where the studio resource is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSsoClientId
```
public void setSsoClientId(String ssoClientId)
```
    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.
    
    Parameters:
    
    ssoClientId - 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.
  - getSsoClientId
```
public String getSsoClientId()
```
    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.
    
    Returns:
    
    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.
  - withSsoClientId
```
public Studio withSsoClientId(String ssoClientId)
```
    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.
    
    Parameters:
    
    ssoClientId - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the studio resource.
    
    Parameters:
    
    state - The current state of the studio resource.
    
    See Also:
    
    StudioState
  - getState
```
public String getState()
```
    The current state of the studio resource.
    
    Returns:
    
    The current state of the studio resource.
    
    See Also:
    
    StudioState
  - withState
```
public Studio withState(String state)
```
    The current state of the studio resource.
    
    Parameters:
    
    state - The current state of the studio resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StudioState
  - withState
```
public Studio withState(StudioState state)
```
    The current state of the studio resource.
    
    Parameters:
    
    state - The current state of the studio resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StudioState
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    Status codes that provide additional detail on the studio state.
    
    Parameters:
    
    statusCode - Status codes that provide additional detail on the studio state.
    
    See Also:
    
    StudioStatusCode
  - getStatusCode
```
public String getStatusCode()
```
    Status codes that provide additional detail on the studio state.
    
    Returns:
    
    Status codes that provide additional detail on the studio state.
    
    See Also:
    
    StudioStatusCode
  - withStatusCode
```
public Studio withStatusCode(String statusCode)
```
    Status codes that provide additional detail on the studio state.
    
    Parameters:
    
    statusCode - Status codes that provide additional detail on the studio state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StudioStatusCode
  - withStatusCode
```
public Studio withStatusCode(StudioStatusCode statusCode)
```
    Status codes that provide additional detail on the studio state.
    
    Parameters:
    
    statusCode - Status codes that provide additional detail on the studio state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StudioStatusCode
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    Additional detail on the studio state.
    
    Parameters:
    
    statusMessage - Additional detail on the studio state.
  - getStatusMessage
```
public String getStatusMessage()
```
    Additional detail on the studio state.
    
    Returns:
    
    Additional detail on the studio state.
  - withStatusMessage
```
public Studio withStatusMessage(String statusMessage)
```
    Additional detail on the studio state.
    
    Parameters:
    
    statusMessage - Additional detail on the studio state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStudioEncryptionConfiguration
```
public void setStudioEncryptionConfiguration(StudioEncryptionConfiguration studioEncryptionConfiguration)
```
    Configuration of the encryption method that is used for the studio.
    
    Parameters:
    
    studioEncryptionConfiguration - Configuration of the encryption method that is used for the studio.
  - getStudioEncryptionConfiguration
```
public StudioEncryptionConfiguration getStudioEncryptionConfiguration()
```
    Configuration of the encryption method that is used for the studio.
    
    Returns:
    
    Configuration of the encryption method that is used for the studio.
  - withStudioEncryptionConfiguration
```
public Studio withStudioEncryptionConfiguration(StudioEncryptionConfiguration studioEncryptionConfiguration)
```
    Configuration of the encryption method that is used for the studio.
    
    Parameters:
    
    studioEncryptionConfiguration - Configuration of the encryption method that is used for the studio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStudioId
```
public void setStudioId(String studioId)
```
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    
    Parameters:
    
    studioId - The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - getStudioId
```
public String getStudioId()
```
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    
    Returns:
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - withStudioId
```
public Studio withStudioId(String studioId)
```
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    
    Parameters:
    
    studioId - The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStudioName
```
public void setStudioName(String studioName)
```
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    
    Parameters:
    
    studioName - The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - getStudioName
```
public String getStudioName()
```
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    
    Returns:
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - withStudioName
```
public Studio withStudioName(String studioName)
```
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    
    Parameters:
    
    studioName - The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStudioUrl
```
public void setStudioUrl(String studioUrl)
```
    The address of the web page for the studio.
    
    Parameters:
    
    studioUrl - The address of the web page for the studio.
  - getStudioUrl
```
public String getStudioUrl()
```
    The address of the web page for the studio.
    
    Returns:
    
    The address of the web page for the studio.
  - withStudioUrl
```
public Studio withStudioUrl(String studioUrl)
```
    The address of the web page for the studio.
    
    Parameters:
    
    studioUrl - The address of the web page for the studio.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    
    Returns:
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    
    Parameters:
    
    tags - A collection of labels, in the form of key-value pairs, that apply to this resource.
  - withTags
```
public Studio withTags(Map<String,String> tags)
```
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    
    Parameters:
    
    tags - A collection of labels, in the form of key-value pairs, that apply to this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Studio addTagsEntry(String key,
                           String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Studio clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The ISO timestamp in seconds for when the resource was updated.
    
    Parameters:
    
    updatedAt - The ISO timestamp in seconds for when the resource was updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The ISO timestamp in seconds for when the resource was updated.
    
    Returns:
    
    The ISO timestamp in seconds for when the resource was updated.
  - withUpdatedAt
```
public Studio withUpdatedAt(Date updatedAt)
```
    The ISO timestamp in seconds for when the resource was updated.
    
    Parameters:
    
    updatedAt - The ISO timestamp in seconds for when the resource was updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserRoleArn
```
public void setUserRoleArn(String userRoleArn)
```
    The IAM role that studio users assume when logging in to the Nimble Studio portal.
    
    Parameters:
    
    userRoleArn - The IAM role that studio users assume when logging in to the Nimble Studio portal.
  - getUserRoleArn
```
public String getUserRoleArn()
```
    The IAM role that studio users assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.
  - withUserRoleArn
```
public Studio withUserRoleArn(String userRoleArn)
```
    The IAM role that studio users assume when logging in to the Nimble Studio portal.
    
    Parameters:
    
    userRoleArn - The IAM role that studio users assume when logging in to the Nimble Studio portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Studio clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Studio

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Studio

Method Detail

setAdminRoleArn

getAdminRoleArn

withAdminRoleArn

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setDisplayName

getDisplayName

withDisplayName

setHomeRegion

getHomeRegion

withHomeRegion

setSsoClientId

getSsoClientId

withSsoClientId

setState

getState

withState

withState

setStatusCode

getStatusCode

withStatusCode

withStatusCode

setStatusMessage

getStatusMessage

withStatusMessage

setStudioEncryptionConfiguration

getStudioEncryptionConfiguration

withStudioEncryptionConfiguration

setStudioId

getStudioId

withStudioId

setStudioName

getStudioName

withStudioName

setStudioUrl

getStudioUrl

withStudioUrl

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setUpdatedAt

getUpdatedAt

withUpdatedAt

setUserRoleArn

getUserRoleArn

withUserRoleArn

toString

equals

hashCode

clone

marshall