Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJob.ProcessingInputsObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJob.ProcessingInputsObjectProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJob

@Stability(Stable)
public static interface CfnProcessingJob.ProcessingInputsObjectProperty
extends software.amazon.jsii.JsiiSerializable

The inputs for a processing job.

The processing input must specify exactly one of either S3Input or DatasetDefinition types.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ProcessingInputsObjectProperty processingInputsObjectProperty = ProcessingInputsObjectProperty.builder()
         .inputName("inputName")
         // the properties below are optional
         .appManaged(false)
         .datasetDefinition(DatasetDefinitionProperty.builder()
                 .athenaDatasetDefinition(AthenaDatasetDefinitionProperty.builder()
                         .catalog("catalog")
                         .database("database")
                         .outputFormat("outputFormat")
                         .outputS3Uri("outputS3Uri")
                         .queryString("queryString")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .outputCompression("outputCompression")
                         .workGroup("workGroup")
                         .build())
                 .dataDistributionType("dataDistributionType")
                 .inputMode("inputMode")
                 .localPath("localPath")
                 .redshiftDatasetDefinition(RedshiftDatasetDefinitionProperty.builder()
                         .clusterId("clusterId")
                         .clusterRoleArn("clusterRoleArn")
                         .database("database")
                         .dbUser("dbUser")
                         .outputFormat("outputFormat")
                         .outputS3Uri("outputS3Uri")
                         .queryString("queryString")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .outputCompression("outputCompression")
                         .build())
                 .build())
         .s3Input(S3InputProperty.builder()
                 .s3DataType("s3DataType")
                 .s3Uri("s3Uri")
                 // the properties below are optional
                 .localPath("localPath")
                 .s3CompressionType("s3CompressionType")
                 .s3DataDistributionType("s3DataDistributionType")
                 .s3InputMode("s3InputMode")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProcessingJob.ProcessingInputsObjectProperty.Builder	A builder for CfnProcessingJob.ProcessingInputsObjectProperty
static final class	CfnProcessingJob.ProcessingInputsObjectProperty.Jsii$Proxy	An implementation for CfnProcessingJob.ProcessingInputsObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJob.ProcessingInputsObjectProperty.Builder	builder()
default Object	getAppManaged()	When True , input operations such as data download are managed natively by the processing job application.
default Object	getDatasetDefinition()	Configuration for Dataset Definition inputs.
String	getInputName()	The name for the processing job input.
default Object	getS3Input()	Configuration for downloading input data from Amazon S3 into the processing container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputName

@Stability(Stable)
@NotNull
String getInputName()

The name for the processing job input.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-inputname

getAppManaged

@Stability(Stable)
@Nullable
default Object getAppManaged()

When True , input operations such as data download are managed natively by the processing job application.

When False (default), input operations are managed by Amazon SageMaker.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-appmanaged

getDatasetDefinition

@Stability(Stable)
@Nullable
default Object getDatasetDefinition()

Configuration for Dataset Definition inputs.

The Dataset Definition input must specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition types.

Returns union: either IResolvable or CfnProcessingJob.DatasetDefinitionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-datasetdefinition

getS3Input

@Stability(Stable)
@Nullable
default Object getS3Input()

Configuration for downloading input data from Amazon S3 into the processing container.

Returns union: either IResolvable or CfnProcessingJob.S3InputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-s3input

builder

@Stability(Stable)
static CfnProcessingJob.ProcessingInputsObjectProperty.Builder builder()

Returns:

a CfnProcessingJob.ProcessingInputsObjectProperty.Builder of CfnProcessingJob.ProcessingInputsObjectProperty