Interface CreateImageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>, SageMakerRequest.Builder, SdkBuilder<CreateImageRequest.Builder,CreateImageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateImageRequest

@Mutable
@NotThreadSafe
public static interface CreateImageRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

Method Summary

Modifier and Type	Method	Description
CreateImageRequest.Builder	description(String description)	The description of the image.
CreateImageRequest.Builder	displayName(String displayName)	The display name of the image.
CreateImageRequest.Builder	imageName(String imageName)	The name of the image.
CreateImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateImageRequest.Builder	roleArn(String roleArn)	The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.
CreateImageRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the image.
CreateImageRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the image.
CreateImageRequest.Builder	tags(Tag... tags)	A list of tags to apply to the image.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

description

CreateImageRequest.Builder description(String description)

The description of the image.

Parameters:

description - The description of the image.

Returns:

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

displayName

CreateImageRequest.Builder displayName(String displayName)

The display name of the image. If not provided, ImageName is displayed.

Parameters:

displayName - The display name of the image. If not provided, ImageName is displayed.

Returns:

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

imageName

CreateImageRequest.Builder imageName(String imageName)

The name of the image. Must be unique to your account.

Parameters:

imageName - The name of the image. Must be unique to your account.

Returns:

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

roleArn

CreateImageRequest.Builder roleArn(String roleArn)

The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

Parameters:

roleArn - The ARN of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf.

Returns:

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

tags

CreateImageRequest.Builder tags(Collection<Tag> tags)

A list of tags to apply to the image.

Parameters:

tags - A list of tags to apply to the image.

Returns:

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

tags

CreateImageRequest.Builder tags(Tag... tags)

A list of tags to apply to the image.

Parameters:

tags - A list of tags to apply to the image.

Returns:

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

tags

CreateImageRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags to apply to the image.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.