Package software.amazon.awscdk.services.sagemaker

Class CfnProcessingJob.Builder

java.lang.Object

software.amazon.awscdk.services.sagemaker.CfnProcessingJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProcessingJob>

Enclosing class:

CfnProcessingJob

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

A fluent builder for CfnProcessingJob.

Method Summary

Modifier and Type	Method	Description
CfnProcessingJob.Builder	appSpecification(IResolvable appSpecification)	Configuration to run a processing job in a specified container image.
CfnProcessingJob.Builder	appSpecification(CfnProcessingJob.AppSpecificationProperty appSpecification)	Configuration to run a processing job in a specified container image.
CfnProcessingJob	build()
static CfnProcessingJob.Builder	create(software.constructs.Construct scope, String id)
CfnProcessingJob.Builder	environment(Map<String,String> environment)	Sets the environment variables in the Docker container.
CfnProcessingJob.Builder	environment(IResolvable environment)	Sets the environment variables in the Docker container.
CfnProcessingJob.Builder	experimentConfig(IResolvable experimentConfig)	Associates a SageMaker job as a trial component with an experiment and trial.
CfnProcessingJob.Builder	experimentConfig(CfnProcessingJob.ExperimentConfigProperty experimentConfig)	Associates a SageMaker job as a trial component with an experiment and trial.
CfnProcessingJob.Builder	networkConfig(IResolvable networkConfig)	Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
CfnProcessingJob.Builder	networkConfig(CfnProcessingJob.NetworkConfigProperty networkConfig)	Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
CfnProcessingJob.Builder	processingInputs(List<? extends Object> processingInputs)	List of input configurations for the processing job.
CfnProcessingJob.Builder	processingInputs(IResolvable processingInputs)	List of input configurations for the processing job.
CfnProcessingJob.Builder	processingJobName(String processingJobName)	The name of the processing job.
CfnProcessingJob.Builder	processingOutputConfig(IResolvable processingOutputConfig)	Contains information about the output location for the compiled model and the target device that the model runs on.
CfnProcessingJob.Builder	processingOutputConfig(CfnProcessingJob.ProcessingOutputConfigProperty processingOutputConfig)	Contains information about the output location for the compiled model and the target device that the model runs on.
CfnProcessingJob.Builder	processingResources(IResolvable processingResources)	Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
CfnProcessingJob.Builder	processingResources(CfnProcessingJob.ProcessingResourcesProperty processingResources)	Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
CfnProcessingJob.Builder	roleArn(String roleArn)	The ARN of the role used to create the processing job.
CfnProcessingJob.Builder	stoppingCondition(IResolvable stoppingCondition)	Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.
CfnProcessingJob.Builder	stoppingCondition(CfnProcessingJob.StoppingConditionProperty stoppingCondition)	Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.
CfnProcessingJob.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs.

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 CfnProcessingJob.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 CfnProcessingJob.Builder.

appSpecification

@Stability(Stable)
public CfnProcessingJob.Builder appSpecification(IResolvable appSpecification)

Configuration to run a processing job in a specified container image.

Parameters:

appSpecification - Configuration to run a processing job in a specified container image. This parameter is required.

Returns:

this

See Also:

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

appSpecification

@Stability(Stable)
public CfnProcessingJob.Builder appSpecification(CfnProcessingJob.AppSpecificationProperty appSpecification)

Configuration to run a processing job in a specified container image.

Parameters:

appSpecification - Configuration to run a processing job in a specified container image. This parameter is required.

Returns:

this

See Also:

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

processingResources

@Stability(Stable)
public CfnProcessingJob.Builder processingResources(IResolvable processingResources)

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.

In distributed training, you specify more than one instance.

Parameters:

processingResources - Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. This parameter is required.

Returns:

this

See Also:

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

processingResources

@Stability(Stable)
public CfnProcessingJob.Builder processingResources(CfnProcessingJob.ProcessingResourcesProperty processingResources)

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.

In distributed training, you specify more than one instance.

Parameters:

processingResources - Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnProcessingJob.Builder roleArn(String roleArn)

The ARN of the role used to create the processing job.

Parameters:

roleArn - The ARN of the role used to create the processing job. This parameter is required.

Returns:

this

See Also:

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

environment

@Stability(Stable)
public CfnProcessingJob.Builder environment(Map<String,String> environment)

Sets the environment variables in the Docker container.

Parameters:

environment - Sets the environment variables in the Docker container. This parameter is required.

Returns:

this

See Also:

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

environment

@Stability(Stable)
public CfnProcessingJob.Builder environment(IResolvable environment)

Sets the environment variables in the Docker container.

Parameters:

environment - Sets the environment variables in the Docker container. This parameter is required.

Returns:

this

See Also:

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

experimentConfig

@Stability(Stable)
public CfnProcessingJob.Builder experimentConfig(IResolvable experimentConfig)

Associates a SageMaker job as a trial component with an experiment and trial.

Specified when you call the CreateProcessingJob API.

Parameters:

experimentConfig - Associates a SageMaker job as a trial component with an experiment and trial. This parameter is required.

Returns:

this

See Also:

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

experimentConfig

@Stability(Stable)
public CfnProcessingJob.Builder experimentConfig(CfnProcessingJob.ExperimentConfigProperty experimentConfig)

Associates a SageMaker job as a trial component with an experiment and trial.

Specified when you call the CreateProcessingJob API.

Parameters:

experimentConfig - Associates a SageMaker job as a trial component with an experiment and trial. This parameter is required.

Returns:

this

See Also:

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

networkConfig

@Stability(Stable)
public CfnProcessingJob.Builder networkConfig(IResolvable networkConfig)

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

Parameters:

networkConfig - Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs. This parameter is required.

Returns:

this

See Also:

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

networkConfig

@Stability(Stable)
public CfnProcessingJob.Builder networkConfig(CfnProcessingJob.NetworkConfigProperty networkConfig)

Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

Parameters:

networkConfig - Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs. This parameter is required.

Returns:

this

See Also:

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

processingInputs

@Stability(Stable)
public CfnProcessingJob.Builder processingInputs(IResolvable processingInputs)

List of input configurations for the processing job.

Parameters:

processingInputs - List of input configurations for the processing job. This parameter is required.

Returns:

this

See Also:

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

processingInputs

@Stability(Stable)
public CfnProcessingJob.Builder processingInputs(List<? extends Object> processingInputs)

List of input configurations for the processing job.

Parameters:

processingInputs - List of input configurations for the processing job. This parameter is required.

Returns:

this

See Also:

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

processingJobName

@Stability(Stable)
public CfnProcessingJob.Builder processingJobName(String processingJobName)

The name of the processing job.

If you don't provide a job name, then a unique name is automatically created for the job.

Parameters:

processingJobName - The name of the processing job. This parameter is required.

Returns:

this

See Also:

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

processingOutputConfig

@Stability(Stable)
public CfnProcessingJob.Builder processingOutputConfig(IResolvable processingOutputConfig)

Contains information about the output location for the compiled model and the target device that the model runs on.

TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

Parameters:

processingOutputConfig - Contains information about the output location for the compiled model and the target device that the model runs on. This parameter is required.

Returns:

this

See Also:

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

processingOutputConfig

@Stability(Stable)
public CfnProcessingJob.Builder processingOutputConfig(CfnProcessingJob.ProcessingOutputConfigProperty processingOutputConfig)

Contains information about the output location for the compiled model and the target device that the model runs on.

TargetDevice and TargetPlatform are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the TargetDevice list, use TargetPlatform to describe the platform of your edge device and CompilerOptions if there are specific settings that are required or recommended to use for particular TargetPlatform.

Parameters:

processingOutputConfig - Contains information about the output location for the compiled model and the target device that the model runs on. This parameter is required.

Returns:

this

See Also:

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

stoppingCondition

@Stability(Stable)
public CfnProcessingJob.Builder stoppingCondition(IResolvable stoppingCondition)

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.

After the condition is met, the processing job is stopped.

Parameters:

stoppingCondition - Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. This parameter is required.

Returns:

this

See Also:

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

stoppingCondition

@Stability(Stable)
public CfnProcessingJob.Builder stoppingCondition(CfnProcessingJob.StoppingConditionProperty stoppingCondition)

Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.

After the condition is met, the processing job is stopped.

Parameters:

stoppingCondition - Configures conditions under which the processing job should be stopped, such as how long the processing job has been running. This parameter is required.

Returns:

this

See Also:

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

tags

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

An array of key-value pairs.

For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

Parameters:

tags - An array of key-value pairs. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnProcessingJob build()

Specified by:

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

Returns:

a newly built instance of CfnProcessingJob.