StudioComponent (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.nimble.model.StudioComponent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StudioComponent.Builder,StudioComponent>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class StudioComponent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StudioComponent.Builder,StudioComponent>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StudioComponent.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StudioComponent.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
`static StudioComponent.Builder`	`builder()`
`StudioComponentConfiguration`	`configuration()` The configuration of the studio component, based on component type.
`Instant`	`createdAt()` The ISO timestamp in seconds for when the resource was created.
`String`	`createdBy()` The user ID of the user that created the studio component.
`String`	`description()` A human-readable description for the studio component resource.
`List<String>`	`ec2SecurityGroupIds()` The EC2 security groups that control access to the studio component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEc2SecurityGroupIds()` For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property.
`int`	`hashCode()`
`boolean`	`hasInitializationScripts()` For responses, this returns true if the service returned a value for the InitializationScripts property.
`boolean`	`hasScriptParameters()` For responses, this returns true if the service returned a value for the ScriptParameters property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<StudioComponentInitializationScript>`	`initializationScripts()` Initialization scripts for studio components.
`String`	`name()` A friendly name for the studio component resource.
`String`	`runtimeRoleArn()` 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.
`List<ScriptParameterKeyValue>`	`scriptParameters()` Parameters for the studio component scripts.
`List<SdkField<?>>`	`sdkFields()`
`String`	`secureInitializationRoleArn()` 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.
`static Class<? extends StudioComponent.Builder>`	`serializableBuilderClass()`
`StudioComponentState`	`state()` The current state.
`String`	`stateAsString()` The current state.
`StudioComponentStatusCode`	`statusCode()` The status code.
`String`	`statusCodeAsString()` The status code.
`String`	`statusMessage()` The status message for the studio component.
`String`	`studioComponentId()` The unique identifier for a studio component resource.
`StudioComponentSubtype`	`subtype()` The specific subtype of a studio component.
`String`	`subtypeAsString()` The specific subtype of a studio component.
`Map<String,String>`	`tags()` A collection of labels, in the form of key-value pairs, that apply to this resource.
`StudioComponent.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`StudioComponentType`	`type()` The type of the studio component.
`String`	`typeAsString()` The type of the studio component.
`Instant`	`updatedAt()` The ISO timestamp in seconds for when the resource was updated.
`String`	`updatedBy()` The user ID of the user that most recently updated the resource.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    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.
  - configuration
```
public final StudioComponentConfiguration configuration()
```
    The configuration of the studio component, based on component type.
    
    Returns:
    
    The configuration of the studio component, based on component type.
  - createdAt
```
public final Instant createdAt()
```
    The ISO timestamp in seconds for when the resource was created.
    
    Returns:
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy
```
public final String createdBy()
```
    The user ID of the user that created the studio component.
    
    Returns:
    
    The user ID of the user that created the studio component.
  - description
```
public final String description()
```
    A human-readable description for the studio component resource.
    
    Returns:
    
    A human-readable description for the studio component resource.
  - hasEc2SecurityGroupIds
```
public final boolean hasEc2SecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - ec2SecurityGroupIds
```
public final List<String> ec2SecurityGroupIds()
```
    The EC2 security groups that control access to the studio component.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEc2SecurityGroupIds() method.
    
    Returns:
    
    The EC2 security groups that control access to the studio component.
  - hasInitializationScripts
```
public final boolean hasInitializationScripts()
```
    For responses, this returns true if the service returned a value for the InitializationScripts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - initializationScripts
```
public final List<StudioComponentInitializationScript> initializationScripts()
```
    Initialization scripts for studio components.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInitializationScripts() method.
    
    Returns:
    
    Initialization scripts for studio components.
  - name
```
public final String name()
```
    A friendly name for the studio component resource.
    
    Returns:
    
    A friendly name for the studio component resource.
  - runtimeRoleArn
```
public final String runtimeRoleArn()
```
    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.
    
    Returns:
    
    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.
  - hasScriptParameters
```
public final boolean hasScriptParameters()
```
    For responses, this returns true if the service returned a value for the ScriptParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - scriptParameters
```
public final List<ScriptParameterKeyValue> scriptParameters()
```
    Parameters for the studio component scripts.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScriptParameters() method.
    
    Returns:
    
    Parameters for the studio component scripts.
  - secureInitializationRoleArn
```
public final String secureInitializationRoleArn()
```
    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.
    
    Returns:
    
    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.
  - state
```
public final StudioComponentState state()
```
    The current state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return StudioComponentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state.
    
    See Also:
    
    StudioComponentState
  - stateAsString
```
public final String stateAsString()
```
    The current state.
    
    If the service returns an enum value that is not available in the current SDK version, state will return StudioComponentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state.
    
    See Also:
    
    StudioComponentState
  - statusCode
```
public final StudioComponentStatusCode statusCode()
```
    The status code.
    
    If the service returns an enum value that is not available in the current SDK version, statusCode() will return StudioComponentStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    
    Returns:
    
    The status code.
    
    See Also:
    
    StudioComponentStatusCode
  - statusCodeAsString
```
public final String statusCodeAsString()
```
    The status code.
    
    If the service returns an enum value that is not available in the current SDK version, statusCode() will return StudioComponentStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().
    
    Returns:
    
    The status code.
    
    See Also:
    
    StudioComponentStatusCode
  - statusMessage
```
public final String statusMessage()
```
    The status message for the studio component.
    
    Returns:
    
    The status message for the studio component.
  - studioComponentId
```
public final String studioComponentId()
```
    The unique identifier for a studio component resource.
    
    Returns:
    
    The unique identifier for a studio component resource.
  - subtype
```
public final StudioComponentSubtype subtype()
```
    The specific subtype of a studio component.
    
    If the service returns an enum value that is not available in the current SDK version, subtype will return StudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().
    
    Returns:
    
    The specific subtype of a studio component.
    
    See Also:
    
    StudioComponentSubtype
  - subtypeAsString
```
public final String subtypeAsString()
```
    The specific subtype of a studio component.
    
    If the service returns an enum value that is not available in the current SDK version, subtype will return StudioComponentSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subtypeAsString().
    
    Returns:
    
    The specific subtype of a studio component.
    
    See Also:
    
    StudioComponentSubtype
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
  - type
```
public final StudioComponentType type()
```
    The type of the studio component.
    
    If the service returns an enum value that is not available in the current SDK version, type will return StudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the studio component.
    
    See Also:
    
    StudioComponentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the studio component.
    
    If the service returns an enum value that is not available in the current SDK version, type will return StudioComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the studio component.
    
    See Also:
    
    StudioComponentType
  - updatedAt
```
public final Instant updatedAt()
```
    The ISO timestamp in seconds for when the resource was updated.
    
    Returns:
    
    The ISO timestamp in seconds for when the resource was updated.
  - updatedBy
```
public final String updatedBy()
```
    The user ID of the user that most recently updated the resource.
    
    Returns:
    
    The user ID of the user that most recently updated the resource.
  - toBuilder
```
public StudioComponent.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StudioComponent.Builder,StudioComponent>
  - builder
```
public static StudioComponent.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StudioComponent.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StudioComponent

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

configuration

createdAt

createdBy

description

hasEc2SecurityGroupIds

ec2SecurityGroupIds

hasInitializationScripts

initializationScripts

name

runtimeRoleArn

hasScriptParameters

scriptParameters

secureInitializationRoleArn

state

stateAsString

statusCode

statusCodeAsString

statusMessage

studioComponentId

subtype

subtypeAsString

hasTags

tags

type

typeAsString

updatedAt

updatedBy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields