interface ProcessingInputsObjectProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnProcessingJob_ProcessingInputsObjectProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty`
Python	`aws_cdk.aws_sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnProcessingJob` » `ProcessingInputsObjectProperty`

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 { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const processingInputsObjectProperty: sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty = {
  inputName: 'inputName',

  // the properties below are optional
  appManaged: false,
  datasetDefinition: {
    athenaDatasetDefinition: {
      catalog: 'catalog',
      database: 'database',
      outputFormat: 'outputFormat',
      outputS3Uri: 'outputS3Uri',
      queryString: 'queryString',

      // the properties below are optional
      kmsKeyId: 'kmsKeyId',
      outputCompression: 'outputCompression',
      workGroup: 'workGroup',
    },
    dataDistributionType: 'dataDistributionType',
    inputMode: 'inputMode',
    localPath: 'localPath',
    redshiftDatasetDefinition: {
      clusterId: 'clusterId',
      clusterRoleArn: 'clusterRoleArn',
      database: 'database',
      dbUser: 'dbUser',
      outputFormat: 'outputFormat',
      outputS3Uri: 'outputS3Uri',
      queryString: 'queryString',

      // the properties below are optional
      kmsKeyId: 'kmsKeyId',
      outputCompression: 'outputCompression',
    },
  },
  s3Input: {
    s3DataType: 's3DataType',
    s3Uri: 's3Uri',

    // the properties below are optional
    localPath: 'localPath',
    s3CompressionType: 's3CompressionType',
    s3DataDistributionType: 's3DataDistributionType',
    s3InputMode: 's3InputMode',
  },
};

Properties

Name	Type	Description
inputName	`string`	The name for the processing job input.
appManaged?	`boolean \|` `IResolvable`	When `True` , input operations such as data download are managed natively by the processing job application.
datasetDefinition?	`IResolvable` `\|` `DatasetDefinitionProperty`	Configuration for Dataset Definition inputs.
s3Input?	`IResolvable` `\|` `S3InputProperty`	Configuration for downloading input data from Amazon S3 into the processing container.

inputName

Type: string

The name for the processing job input.

appManaged?

Type: boolean | IResolvable (optional)

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.

datasetDefinition?

Type: IResolvable | DatasetDefinitionProperty (optional)

Configuration for Dataset Definition inputs.

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

s3Input?

Type: IResolvable | S3InputProperty (optional)

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