class CfnProcessingJobPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnProcessingJobPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnProcessingJobPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnProcessingJobPropsMixin
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnProcessingJobPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnProcessingJobPropsMixin

Implements IMixin

Extends Mixin

An Amazon SageMaker processing job that is used to analyze data and evaluate models.

For more information, see Process Data and Evaluate Models .

Also, note the following details specific to processing jobs created using CloudFormation stacks:

• When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the StopProcessingJob API but not deleted. Any tags associated with the processing job are deleted using the DeleteTags API.
• If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified ProcessingJobName value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an AlreadyExists error. To prevent this, we recommend that you don't specify the optional ProcessingJobName property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the ProcessingJobName and redeploy the stack to recover from a failed rollback.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';
const cfnProcessingJobPropsMixin = new sagemaker_mixins.CfnProcessingJobPropsMixin({
  appSpecification: {
    containerArguments: ['containerArguments'],
    containerEntrypoint: ['containerEntrypoint'],
    imageUri: 'imageUri',
  },
  environment: {
    environmentKey: 'environment',
  },
  experimentConfig: {
    experimentName: 'experimentName',
    runName: 'runName',
    trialComponentDisplayName: 'trialComponentDisplayName',
    trialName: 'trialName',
  },
  networkConfig: {
    enableInterContainerTrafficEncryption: false,
    enableNetworkIsolation: false,
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  processingInputs: [{
    appManaged: false,
    datasetDefinition: {
      athenaDatasetDefinition: {
        catalog: 'catalog',
        database: 'database',
        kmsKeyId: 'kmsKeyId',
        outputCompression: 'outputCompression',
        outputFormat: 'outputFormat',
        outputS3Uri: 'outputS3Uri',
        queryString: 'queryString',
        workGroup: 'workGroup',
      },
      dataDistributionType: 'dataDistributionType',
      inputMode: 'inputMode',
      localPath: 'localPath',
      redshiftDatasetDefinition: {
        clusterId: 'clusterId',
        clusterRoleArn: 'clusterRoleArn',
        database: 'database',
        dbUser: 'dbUser',
        kmsKeyId: 'kmsKeyId',
        outputCompression: 'outputCompression',
        outputFormat: 'outputFormat',
        outputS3Uri: 'outputS3Uri',
        queryString: 'queryString',
      },
    },
    inputName: 'inputName',
    s3Input: {
      localPath: 'localPath',
      s3CompressionType: 's3CompressionType',
      s3DataDistributionType: 's3DataDistributionType',
      s3DataType: 's3DataType',
      s3InputMode: 's3InputMode',
      s3Uri: 's3Uri',
    },
  }],
  processingJobName: 'processingJobName',
  processingOutputConfig: {
    kmsKeyId: 'kmsKeyId',
    outputs: [{
      appManaged: false,
      featureStoreOutput: {
        featureGroupName: 'featureGroupName',
      },
      outputName: 'outputName',
      s3Output: {
        localPath: 'localPath',
        s3UploadMode: 's3UploadMode',
        s3Uri: 's3Uri',
      },
    }],
  },
  processingResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeKmsKeyId: 'volumeKmsKeyId',
      volumeSizeInGb: 123,
    },
  },
  roleArn: 'roleArn',
  stoppingCondition: {
    maxRuntimeInSeconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnProcessingJobPropsMixin(props: CfnProcessingJobMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnProcessingJobMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SageMaker::ProcessingJob.

Properties

Name	Type	Description
props	CfnProcessingJobMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnProcessingJobMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.