Package software.amazon.awscdk.services.sagemaker

Class CfnImage.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnImage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImage>

Enclosing class:

CfnImage

@Stability(Stable)
public static final class CfnImage.Builder
extends Object
implements software.amazon.jsii.Builder<CfnImage>

A fluent builder for CfnImage.

Method Summary

Modifier and Type	Method	Description
CfnImage	build()
static CfnImage.Builder	create(software.constructs.Construct scope, String id)
CfnImage.Builder	imageDescription(String imageDescription)	The description of the image.
CfnImage.Builder	imageDisplayName(String imageDisplayName)	The display name of the image.
CfnImage.Builder	imageName(String imageName)	The name of the Image.
CfnImage.Builder	imageRoleArn(String imageRoleArn)	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
CfnImage.Builder	tags(List<? extends CfnTag> tags)	A list of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnImage.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnImage.Builder.

imageName

@Stability(Stable)
public CfnImage.Builder imageName(String imageName)

The name of the Image. Must be unique by region in your account.

Length Constraints : Minimum length of 1. Maximum length of 63.

Pattern : ^[a-zA-Z0-9]([-.]?[a-zA-Z0-9]){0,62}$

Parameters:

imageName - The name of the Image. Must be unique by region in your account. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagename

imageRoleArn

@Stability(Stable)
public CfnImage.Builder imageRoleArn(String imageRoleArn)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Length Constraints : Minimum length of 20. Maximum length of 2048.

Pattern : ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Parameters:

imageRoleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagerolearn

imageDescription

@Stability(Stable)
public CfnImage.Builder imageDescription(String imageDescription)

The description of the image.

Parameters:

imageDescription - The description of the image. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedescription

imageDisplayName

@Stability(Stable)
public CfnImage.Builder imageDisplayName(String imageDisplayName)

The display name of the image.

Length Constraints : Minimum length of 1. Maximum length of 128.

Pattern : ^\S(.*\S)?$

Parameters:

imageDisplayName - The display name of the image. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-imagedisplayname

tags

@Stability(Stable)
public CfnImage.Builder tags(List<? extends CfnTag> tags)

A list of key-value pairs to apply to this resource.

Array Members : Minimum number of 0 items. Maximum number of 50 items.

Parameters:

tags - A list of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-image.html#cfn-sagemaker-image-tags

build

@Stability(Stable)
public CfnImage build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnImage>

Returns:

a newly built instance of CfnImage.