Class StudioComponent
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.static StudioComponent.Builder
builder()
The configuration of the studio component, based on component type.final Instant
The ISO timestamp in seconds for when the resource was created.final String
The user ID of the user that created the studio component.final String
A human-readable description for the studio component resource.The EC2 security groups that control access to the studio component.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Ec2SecurityGroupIds property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InitializationScripts property.final boolean
For responses, this returns true if the service returned a value for the ScriptParameters property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Initialization scripts for studio components.final String
name()
A friendly name for the studio component resource.final String
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.final List
<ScriptParameterKeyValue> Parameters for the studio component scripts.final String
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> final StudioComponentState
state()
The current state.final String
The current state.The status code.final String
The status code.final String
The status message for the studio component.final String
The unique identifier for a studio component resource.final StudioComponentSubtype
subtype()
The specific subtype of a studio component.final String
The specific subtype of a studio component.tags()
A collection of labels, in the form of key-value pairs, that apply to this resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final StudioComponentType
type()
The type of the studio component.final String
The type of the studio component.final Instant
The ISO timestamp in seconds for when the resource was updated.final String
The user ID of the user that most recently updated the resource.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The configuration of the studio component, based on component type.
- Returns:
- The configuration of the studio component, based on component type.
-
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
The user ID of the user that created the studio component.
- Returns:
- The user ID of the user that created the studio component.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
A friendly name for the studio component resource.
- Returns:
- A friendly name for the studio component resource.
-
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 theisEmpty()
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
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
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
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStudioComponentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
stateAsString
The current state.
If the service returns an enum value that is not available in the current SDK version,
state
will returnStudioComponentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state.
- See Also:
-
statusCode
The status code.
If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnStudioComponentStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code.
- See Also:
-
statusCodeAsString
The status code.
If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnStudioComponentStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The status code.
- See Also:
-
statusMessage
The status message for the studio component.
- Returns:
- The status message for the studio component.
-
studioComponentId
The unique identifier for a studio component resource.
- Returns:
- The unique identifier for a studio component resource.
-
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 returnStudioComponentSubtype.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsubtypeAsString()
.- Returns:
- The specific subtype of a studio component.
- See Also:
-
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 returnStudioComponentSubtype.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsubtypeAsString()
.- Returns:
- The specific subtype of a studio component.
- See Also:
-
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 theisEmpty()
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
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
The type of the studio component.
If the service returns an enum value that is not available in the current SDK version,
type
will returnStudioComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the studio component.
- See Also:
-
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 returnStudioComponentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the studio component.
- See Also:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StudioComponent.Builder,
StudioComponent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-