Package software.amazon.awssdk.services.nimble.model

Interface StudioComponent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StudioComponent.Builder,StudioComponent>, SdkBuilder<StudioComponent.Builder,StudioComponent>, SdkPojo

Enclosing class:

StudioComponent

public static interface StudioComponent.Builder
extends SdkPojo, CopyableBuilder<StudioComponent.Builder,StudioComponent>

Method Summary

Modifier and Type	Method	Description
StudioComponent.Builder	arn(String arn)	The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
default StudioComponent.Builder	configuration(Consumer<StudioComponentConfiguration.Builder> configuration)	The configuration of the studio component, based on component type.
StudioComponent.Builder	configuration(StudioComponentConfiguration configuration)	The configuration of the studio component, based on component type.
StudioComponent.Builder	createdAt(Instant createdAt)	The ISO timestamp in seconds for when the resource was created.
StudioComponent.Builder	createdBy(String createdBy)	The user ID of the user that created the studio component.
StudioComponent.Builder	description(String description)	A human-readable description for the studio component resource.
StudioComponent.Builder	ec2SecurityGroupIds(String... ec2SecurityGroupIds)	The EC2 security groups that control access to the studio component.
StudioComponent.Builder	ec2SecurityGroupIds(Collection<String> ec2SecurityGroupIds)	The EC2 security groups that control access to the studio component.
StudioComponent.Builder	initializationScripts(Collection<StudioComponentInitializationScript> initializationScripts)	Initialization scripts for studio components.
StudioComponent.Builder	initializationScripts(Consumer<StudioComponentInitializationScript.Builder>... initializationScripts)	Initialization scripts for studio components.
StudioComponent.Builder	initializationScripts(StudioComponentInitializationScript... initializationScripts)	Initialization scripts for studio components.
StudioComponent.Builder	name(String name)	A friendly name for the studio component resource.
StudioComponent.Builder	runtimeRoleArn(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.
StudioComponent.Builder	scriptParameters(Collection<ScriptParameterKeyValue> scriptParameters)	Parameters for the studio component scripts.
StudioComponent.Builder	scriptParameters(Consumer<ScriptParameterKeyValue.Builder>... scriptParameters)	Parameters for the studio component scripts.
StudioComponent.Builder	scriptParameters(ScriptParameterKeyValue... scriptParameters)	Parameters for the studio component scripts.
StudioComponent.Builder	secureInitializationRoleArn(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.
StudioComponent.Builder	state(String state)	The current state.
StudioComponent.Builder	state(StudioComponentState state)	The current state.
StudioComponent.Builder	statusCode(String statusCodeValue)	The status code.
StudioComponent.Builder	statusCode(StudioComponentStatusCode statusCodeValue)	The status code.
StudioComponent.Builder	statusMessage(String statusMessage)	The status message for the studio component.
StudioComponent.Builder	studioComponentId(String studioComponentId)	The unique identifier for a studio component resource.
StudioComponent.Builder	subtype(String subtype)	The specific subtype of a studio component.
StudioComponent.Builder	subtype(StudioComponentSubtype subtype)	The specific subtype of a studio component.
StudioComponent.Builder	tags(Map<String,String> tags)	A collection of labels, in the form of key-value pairs, that apply to this resource.
StudioComponent.Builder	type(String type)	The type of the studio component.
StudioComponent.Builder	type(StudioComponentType type)	The type of the studio component.
StudioComponent.Builder	updatedAt(Instant updatedAt)	The ISO timestamp in seconds for when the resource was updated.
StudioComponent.Builder	updatedBy(String updatedBy)	The user ID of the user that most recently updated the resource.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

arn

StudioComponent.Builder arn(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.

configuration

StudioComponent.Builder configuration(StudioComponentConfiguration configuration)

The configuration of the studio component, based on component type.

Parameters:

configuration - The configuration of the studio component, based on component type.

Returns:

Returns a reference to this object so that method calls can be chained together.

configuration

default StudioComponent.Builder configuration(Consumer<StudioComponentConfiguration.Builder> configuration)

The configuration of the studio component, based on component type.

This is a convenience method that creates an instance of the StudioComponentConfiguration.Builder avoiding the need to create one manually via StudioComponentConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(StudioComponentConfiguration).

Parameters:

configuration - a consumer that will call methods on StudioComponentConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• configuration(StudioComponentConfiguration)

createdAt

StudioComponent.Builder createdAt(Instant 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.

createdBy

StudioComponent.Builder createdBy(String createdBy)

The user ID of the user that created the studio component.

Parameters:

createdBy - The user ID of the user that created the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

StudioComponent.Builder description(String description)

A human-readable description for the studio component resource.

Parameters:

description - A human-readable description for the studio component resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

ec2SecurityGroupIds

StudioComponent.Builder ec2SecurityGroupIds(Collection<String> ec2SecurityGroupIds)

The EC2 security groups that control access to the studio component.

Parameters:

ec2SecurityGroupIds - The EC2 security groups that control access to the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

ec2SecurityGroupIds

StudioComponent.Builder ec2SecurityGroupIds(String... ec2SecurityGroupIds)

The EC2 security groups that control access to the studio component.

Parameters:

ec2SecurityGroupIds - The EC2 security groups that control access to the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

initializationScripts

StudioComponent.Builder initializationScripts(Collection<StudioComponentInitializationScript> initializationScripts)

Initialization scripts for studio components.

Parameters:

initializationScripts - Initialization scripts for studio components.

Returns:

Returns a reference to this object so that method calls can be chained together.

initializationScripts

StudioComponent.Builder initializationScripts(StudioComponentInitializationScript... initializationScripts)

Initialization scripts for studio components.

Parameters:

initializationScripts - Initialization scripts for studio components.

Returns:

Returns a reference to this object so that method calls can be chained together.

initializationScripts

StudioComponent.Builder initializationScripts(Consumer<StudioComponentInitializationScript.Builder>... initializationScripts)

Initialization scripts for studio components.

This is a convenience method that creates an instance of the StudioComponentInitializationScript.Builder avoiding the need to create one manually via StudioComponentInitializationScript.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initializationScripts(List<StudioComponentInitializationScript>).

Parameters:

initializationScripts - a consumer that will call methods on StudioComponentInitializationScript.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• initializationScripts(java.util.Collection<StudioComponentInitializationScript>)

name

StudioComponent.Builder name(String name)

A friendly name for the studio component resource.

Parameters:

name - A friendly name for the studio component resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

runtimeRoleArn

StudioComponent.Builder runtimeRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

scriptParameters

StudioComponent.Builder scriptParameters(Collection<ScriptParameterKeyValue> scriptParameters)

Parameters for the studio component scripts.

Parameters:

scriptParameters - Parameters for the studio component scripts.

Returns:

Returns a reference to this object so that method calls can be chained together.

scriptParameters

StudioComponent.Builder scriptParameters(ScriptParameterKeyValue... scriptParameters)

Parameters for the studio component scripts.

Parameters:

scriptParameters - Parameters for the studio component scripts.

Returns:

Returns a reference to this object so that method calls can be chained together.

scriptParameters

StudioComponent.Builder scriptParameters(Consumer<ScriptParameterKeyValue.Builder>... scriptParameters)

Parameters for the studio component scripts.

This is a convenience method that creates an instance of the ScriptParameterKeyValue.Builder avoiding the need to create one manually via ScriptParameterKeyValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scriptParameters(List<ScriptParameterKeyValue>).

Parameters:

scriptParameters - a consumer that will call methods on ScriptParameterKeyValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• scriptParameters(java.util.Collection<ScriptParameterKeyValue>)

secureInitializationRoleArn

StudioComponent.Builder secureInitializationRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

state

StudioComponent.Builder state(String state)

The current state.

Parameters:

state - The current state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentState
• StudioComponentState

state

StudioComponent.Builder state(StudioComponentState state)

The current state.

Parameters:

state - The current state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentState
• StudioComponentState

statusCode

StudioComponent.Builder statusCode(String statusCodeValue)

The status code.

Parameters:

statusCodeValue - The status code.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentStatusCode
• StudioComponentStatusCode

statusCode

StudioComponent.Builder statusCode(StudioComponentStatusCode statusCodeValue)

The status code.

Parameters:

statusCodeValue - The status code.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentStatusCode
• StudioComponentStatusCode

statusMessage

StudioComponent.Builder statusMessage(String statusMessage)

The status message for the studio component.

Parameters:

statusMessage - The status message for the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

studioComponentId

StudioComponent.Builder studioComponentId(String studioComponentId)

The unique identifier for a studio component resource.

Parameters:

studioComponentId - The unique identifier for a studio component resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

subtype

StudioComponent.Builder subtype(String subtype)

The specific subtype of a studio component.

Parameters:

subtype - The specific subtype of a studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentSubtype
• StudioComponentSubtype

subtype

StudioComponent.Builder subtype(StudioComponentSubtype subtype)

The specific subtype of a studio component.

Parameters:

subtype - The specific subtype of a studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentSubtype
• StudioComponentSubtype

tags

StudioComponent.Builder tags(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.

type

StudioComponent.Builder type(String type)

The type of the studio component.

Parameters:

type - The type of the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentType
• StudioComponentType

type

StudioComponent.Builder type(StudioComponentType type)

The type of the studio component.

Parameters:

type - The type of the studio component.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StudioComponentType
• StudioComponentType

updatedAt

StudioComponent.Builder updatedAt(Instant 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.

updatedBy

StudioComponent.Builder updatedBy(String updatedBy)

The user ID of the user that most recently updated the resource.

Parameters:

updatedBy - The user ID of the user that most recently updated the resource.

Returns:

Returns a reference to this object so that method calls can be chained together.