@propulsionworks/cloudformation 0.1.18 → 0.1.20

package/out/exports/resources.generated/aws-sagemaker-processingjob.d.ts

@@ -0,0 +1,608 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Resource Type definition for AWS::SageMaker::ProcessingJob
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
+ */
+export type SageMakerProcessingJob = ResourceDefinitionWithAttributes<"AWS::SageMaker::ProcessingJob", SageMakerProcessingJobProps, SageMakerProcessingJobAttribs>;
+/**
+ * Resource Type definition for AWS::SageMaker::ProcessingJob
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html}
+ */
+export type SageMakerProcessingJobProps = {
+    /**
+     * Configures the processing job to run a specified Docker container image.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-appspecification}
+     */
+    AppSpecification: AppSpecification;
+    /**
+     * Sets the environment variables in the Docker container
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-environment}
+     */
+    Environment?: Record<string, string> | undefined;
+    /**
+     * Associates a SageMaker job as a trial component with an experiment and trial.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-experimentconfig}
+     */
+    ExperimentConfig?: ExperimentConfig | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-networkconfig}
+     */
+    NetworkConfig?: NetworkConfig | undefined;
+    /**
+     * An array of inputs configuring the data to download into the processing container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processinginputs}
+     */
+    ProcessingInputs?: ProcessingInputsObject[] | undefined;
+    /**
+     * The name of the processing job. The name must be unique within an AWS Region in the AWS account.
+     * @minLength 1
+     * @maxLength 63
+     * @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingjobname}
+     */
+    ProcessingJobName?: string | undefined;
+    /**
+     * Configuration for uploading output from the processing container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingoutputconfig}
+     */
+    ProcessingOutputConfig?: ProcessingOutputConfig | undefined;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingresources}
+     */
+    ProcessingResources: ProcessingResources;
+    /**
+     * The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-rolearn}
+     */
+    RoleArn: string;
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-stoppingcondition}
+     */
+    StoppingCondition?: StoppingCondition | undefined;
+    /**
+     * (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags(https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the AWS Billing and Cost Management User Guide.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-tags}
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#aws-resource-sagemaker-processingjob-return-values}
+ */
+export type SageMakerProcessingJobAttribs = {
+    /**
+     * The ARN of an AutoML job associated with this processing job.
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-automljobarn}
+     */
+    AutoMLJobArn: string;
+    /**
+     * The time at which the processing job was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-creationtime}
+     */
+    CreationTime: string;
+    /**
+     * An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
+     * @maxLength 1024
+     * @pattern [\S\s]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-exitmessage}
+     */
+    ExitMessage: string;
+    /**
+     * A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
+     * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-failurereason}
+     */
+    FailureReason: string;
+    /**
+     * The time at which the processing job was last modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-lastmodifiedtime}
+     */
+    LastModifiedTime: string;
+    /**
+     * The ARN of a monitoring schedule for an endpoint associated with this processing job.
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-monitoringschedulearn}
+     */
+    MonitoringScheduleArn: string;
+    /**
+     * The time at which the processing job completed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingendtime}
+     */
+    ProcessingEndTime: string;
+    /**
+     * The Amazon Resource Name (ARN) of the processing job.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:processing-job/.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingjobarn}
+     */
+    ProcessingJobArn: string;
+    /**
+     * Provides the status of a processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingjobstatus}
+     */
+    ProcessingJobStatus: "Completed" | "InProgress" | "Stopping" | "Stopped" | "Failed";
+    /**
+     * The time at which the processing job started.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingstarttime}
+     */
+    ProcessingStartTime: string;
+    /**
+     * The ARN of a training job associated with this processing job
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-trainingjobarn}
+     */
+    TrainingJobArn: string;
+};
+/**
+ * Configures the processing job to run a specified Docker container image.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html}
+ */
+export type AppSpecification = {
+    /**
+     * The arguments for a container used to run a processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html#cfn-sagemaker-processingjob-appspecification-containerarguments}
+     */
+    ContainerArguments?: string[] | undefined;
+    /**
+     * The entrypoint for a container used to run a processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html#cfn-sagemaker-processingjob-appspecification-containerentrypoint}
+     */
+    ContainerEntrypoint?: string[] | undefined;
+    /**
+     * The container image to be run by the processing job.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-appspecification.html#cfn-sagemaker-processingjob-appspecification-imageuri}
+     */
+    ImageUri: string;
+};
+/**
+ * Configuration for Athena Dataset Definition input.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html}
+ */
+export type AthenaDatasetDefinition = {
+    /**
+     * The name of the data catalog used in Athena query execution.
+     * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-catalog}
+     */
+    Catalog: string;
+    /**
+     * The name of the database used in the Athena query execution.
+     * @maxLength 255
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-database}
+     */
+    Database: string;
+    /**
+     * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.
+     * @minLength 0
+     * @maxLength 2048
+     * @pattern [a-zA-Z0-9:/_-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-kmskeyid}
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The compression used for Athena query results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputcompression}
+     */
+    OutputCompression?: "GZIP" | "SNAPPY" | "ZLIB" | undefined;
+    /**
+     * The data storage format for Athena query results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputformat}
+     */
+    OutputFormat: "PARQUET" | "AVRO" | "ORC" | "JSON" | "TEXTFILE";
+    /**
+     * The location in Amazon S3 where Athena query results are stored.
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern (https|s3)://([^/]+)/?(.*)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-outputs3uri}
+     */
+    OutputS3Uri: string;
+    /**
+     * The SQL query statements, to be executed.
+     * @maxLength 4096
+     * @pattern [\s\S]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-querystring}
+     */
+    QueryString: string;
+    /**
+     * The name of the workgroup in which the Athena query is being started.
+     * @maxLength 128
+     * @pattern [a-zA-Z0-9._-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-athenadatasetdefinition.html#cfn-sagemaker-processingjob-athenadatasetdefinition-workgroup}
+     */
+    WorkGroup?: string | undefined;
+};
+/**
+ * Configuration for the cluster used to run a processing job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html}
+ */
+export type ClusterConfig = {
+    /**
+     * The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.
+     * @min 1
+     * @max 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-instancecount}
+     */
+    InstanceCount: number;
+    /**
+     * The ML compute instance type for the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-instancetype}
+     */
+    InstanceType: "ml.t3.medium" | "ml.t3.large" | "ml.t3.xlarge" | "ml.t3.2xlarge" | "ml.m4.xlarge" | "ml.m4.2xlarge" | "ml.m4.4xlarge" | "ml.m4.10xlarge" | "ml.m4.16xlarge" | "ml.c4.xlarge" | "ml.c4.2xlarge" | "ml.c4.4xlarge" | "ml.c4.8xlarge" | "ml.c5.xlarge" | "ml.c5.2xlarge" | "ml.c5.4xlarge" | "ml.c5.9xlarge" | "ml.c5.18xlarge" | "ml.m5.large" | "ml.m5.xlarge" | "ml.m5.2xlarge" | "ml.m5.4xlarge" | "ml.m5.12xlarge" | "ml.m5.24xlarge" | "ml.r5.large" | "ml.r5.xlarge" | "ml.r5.2xlarge" | "ml.r5.4xlarge" | "ml.r5.8xlarge" | "ml.r5.12xlarge" | "ml.r5.16xlarge" | "ml.r5.24xlarge" | "ml.g4dn.xlarge" | "ml.g4dn.2xlarge" | "ml.g4dn.4xlarge" | "ml.g4dn.8xlarge" | "ml.g4dn.12xlarge" | "ml.g4dn.16xlarge" | "ml.g5.xlarge" | "ml.g5.2xlarge" | "ml.g5.4xlarge" | "ml.g5.8xlarge" | "ml.g5.16xlarge" | "ml.g5.12xlarge" | "ml.g5.24xlarge" | "ml.g5.48xlarge" | "ml.r5d.large" | "ml.r5d.xlarge" | "ml.r5d.2xlarge" | "ml.r5d.4xlarge" | "ml.r5d.8xlarge" | "ml.r5d.12xlarge" | "ml.r5d.16xlarge" | "ml.r5d.24xlarge" | "ml.g6.xlarge" | "ml.g6.2xlarge" | "ml.g6.4xlarge" | "ml.g6.8xlarge" | "ml.g6.12xlarge" | "ml.g6.16xlarge" | "ml.g6.24xlarge" | "ml.g6.48xlarge" | "ml.g6e.xlarge" | "ml.g6e.2xlarge" | "ml.g6e.4xlarge" | "ml.g6e.8xlarge" | "ml.g6e.12xlarge" | "ml.g6e.16xlarge" | "ml.g6e.24xlarge" | "ml.g6e.48xlarge" | "ml.m6i.large" | "ml.m6i.xlarge" | "ml.m6i.2xlarge" | "ml.m6i.4xlarge" | "ml.m6i.8xlarge" | "ml.m6i.12xlarge" | "ml.m6i.16xlarge" | "ml.m6i.24xlarge" | "ml.m6i.32xlarge" | "ml.c6i.xlarge" | "ml.c6i.2xlarge" | "ml.c6i.4xlarge" | "ml.c6i.8xlarge" | "ml.c6i.12xlarge" | "ml.c6i.16xlarge" | "ml.c6i.24xlarge" | "ml.c6i.32xlarge" | "ml.m7i.large" | "ml.m7i.xlarge" | "ml.m7i.2xlarge" | "ml.m7i.4xlarge" | "ml.m7i.8xlarge" | "ml.m7i.12xlarge" | "ml.m7i.16xlarge" | "ml.m7i.24xlarge" | "ml.m7i.48xlarge" | "ml.c7i.large" | "ml.c7i.xlarge" | "ml.c7i.2xlarge" | "ml.c7i.4xlarge" | "ml.c7i.8xlarge" | "ml.c7i.12xlarge" | "ml.c7i.16xlarge" | "ml.c7i.24xlarge" | "ml.c7i.48xlarge" | "ml.r7i.large" | "ml.r7i.xlarge" | "ml.r7i.2xlarge" | "ml.r7i.4xlarge" | "ml.r7i.8xlarge" | "ml.r7i.12xlarge" | "ml.r7i.16xlarge" | "ml.r7i.24xlarge" | "ml.r7i.48xlarge";
+    /**
+     * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
+     * @minLength 0
+     * @maxLength 2048
+     * @pattern [a-zA-Z0-9:/_-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-volumekmskeyid}
+     */
+    VolumeKmsKeyId?: string | undefined;
+    /**
+     * The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.
+     * @min 1
+     * @max 16384
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-volumesizeingb}
+     */
+    VolumeSizeInGB: number;
+};
+/**
+ * Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either `AthenaDatasetDefinition` or `RedshiftDatasetDefinition` types.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html}
+ */
+export type DatasetDefinition = {
+    /**
+     * Configuration for Athena Dataset Definition input.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-athenadatasetdefinition}
+     */
+    AthenaDatasetDefinition?: AthenaDatasetDefinition | undefined;
+    /**
+     * Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-datadistributiontype}
+     */
+    DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-inputmode}
+     */
+    InputMode?: "File" | "Pipe" | undefined;
+    /**
+     * The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).
+     * @minLength 0
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-localpath}
+     */
+    LocalPath?: string | undefined;
+    /**
+     * Configuration for Redshift Dataset Definition input.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-datasetdefinition.html#cfn-sagemaker-processingjob-datasetdefinition-redshiftdatasetdefinition}
+     */
+    RedshiftDatasetDefinition?: RedshiftDatasetDefinition | undefined;
+};
+/**
+ * Associates a SageMaker job as a trial component with an experiment and trial.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html}
+ */
+export type ExperimentConfig = {
+    /**
+     * The name of an existing experiment to associate with the trial component.
+     * @maxLength 120
+     * @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-experimentname}
+     */
+    ExperimentName?: string | undefined;
+    /**
+     * The name of the experiment run to associate with the trial component.
+     * @maxLength 120
+     * @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-runname}
+     */
+    RunName?: string | undefined;
+    /**
+     * The display name for the trial component. If this key isn't specified, the display name is the trial component name.
+     * @maxLength 120
+     * @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-trialcomponentdisplayname}
+     */
+    TrialComponentDisplayName?: string | undefined;
+    /**
+     * The name of an existing trial to associate the trial component with. If not specified, a new trial is created.
+     * @maxLength 120
+     * @pattern [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-experimentconfig.html#cfn-sagemaker-processingjob-experimentconfig-trialname}
+     */
+    TrialName?: string | undefined;
+};
+/**
+ * Configuration for processing job outputs in Amazon SageMaker Feature Store.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-featurestoreoutput.html}
+ */
+export type FeatureStoreOutput = {
+    /**
+     * The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.
+     * @maxLength 64
+     * @pattern [a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-featurestoreoutput.html#cfn-sagemaker-processingjob-featurestoreoutput-featuregroupname}
+     */
+    FeatureGroupName: string;
+};
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html}
+ */
+export type NetworkConfig = {
+    /**
+     * Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html#cfn-sagemaker-processingjob-networkconfig-enableintercontainertrafficencryption}
+     */
+    EnableInterContainerTrafficEncryption?: boolean | undefined;
+    /**
+     * Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html#cfn-sagemaker-processingjob-networkconfig-enablenetworkisolation}
+     */
+    EnableNetworkIsolation?: boolean | undefined;
+    /**
+     * Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-networkconfig.html#cfn-sagemaker-processingjob-networkconfig-vpcconfig}
+     */
+    VpcConfig?: VpcConfig | undefined;
+};
+/**
+ * The inputs for a processing job. The processing input must specify exactly one of either S3Input or DatasetDefinition types.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html}
+ */
+export type ProcessingInputsObject = {
+    /**
+     * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-appmanaged}
+     */
+    AppManaged?: boolean | undefined;
+    /**
+     * Configuration for Dataset Definition inputs. The Dataset Definition input must specify exactly one of either `AthenaDatasetDefinition` or `RedshiftDatasetDefinition` types.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-datasetdefinition}
+     */
+    DatasetDefinition?: DatasetDefinition | undefined;
+    /**
+     * The name for the processing job input.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-inputname}
+     */
+    InputName: string;
+    /**
+     * Configuration for downloading input data from Amazon S3 into the processing container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processinginputsobject.html#cfn-sagemaker-processingjob-processinginputsobject-s3input}
+     */
+    S3Input?: S3Input | undefined;
+};
+/**
+ * Configuration for uploading output from the processing container.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputconfig.html}
+ */
+export type ProcessingOutputConfig = {
+    /**
+     * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
+     * @maxLength 2048
+     * @pattern [a-zA-Z0-9:/_-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputconfig.html#cfn-sagemaker-processingjob-processingoutputconfig-kmskeyid}
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * An array of outputs configuring the data to upload from the processing container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputconfig.html#cfn-sagemaker-processingjob-processingoutputconfig-outputs}
+     */
+    Outputs: ProcessingOutputsObject[];
+};
+/**
+ * Describes the results of a processing job. The processing output must specify exactly one of either S3Output or FeatureStoreOutput types.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html}
+ */
+export type ProcessingOutputsObject = {
+    /**
+     * When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html#cfn-sagemaker-processingjob-processingoutputsobject-appmanaged}
+     */
+    AppManaged?: boolean | undefined;
+    /**
+     * Configuration for processing job outputs in Amazon SageMaker Feature Store.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html#cfn-sagemaker-processingjob-processingoutputsobject-featurestoreoutput}
+     */
+    FeatureStoreOutput?: FeatureStoreOutput | undefined;
+    /**
+     * The name for the processing job output.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html#cfn-sagemaker-processingjob-processingoutputsobject-outputname}
+     */
+    OutputName: string;
+    /**
+     * Configuration for uploading output data to Amazon S3 from the processing container.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingoutputsobject.html#cfn-sagemaker-processingjob-processingoutputsobject-s3output}
+     */
+    S3Output?: S3Output | undefined;
+};
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingresources.html}
+ */
+export type ProcessingResources = {
+    /**
+     * Configuration for the cluster used to run a processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-processingresources.html#cfn-sagemaker-processingjob-processingresources-clusterconfig}
+     */
+    ClusterConfig: ClusterConfig;
+};
+/**
+ * Configuration for Redshift Dataset Definition input.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html}
+ */
+export type RedshiftDatasetDefinition = {
+    /**
+     * The Redshift cluster Identifier.
+     * @maxLength 63
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-clusterid}
+     */
+    ClusterId: string;
+    /**
+     * The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
+     * @minLength 20
+     * @maxLength 2048
+     * @pattern arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-clusterrolearn}
+     */
+    ClusterRoleArn: string;
+    /**
+     * The name of the Redshift database used in Redshift query execution.
+     * @maxLength 64
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-database}
+     */
+    Database: string;
+    /**
+     * The database user name used in Redshift query execution.
+     * @maxLength 128
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-dbuser}
+     */
+    DbUser: string;
+    /**
+     * The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.
+     * @minLength 0
+     * @maxLength 2048
+     * @pattern [a-zA-Z0-9:/_-]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-kmskeyid}
+     */
+    KmsKeyId?: string | undefined;
+    /**
+     * The compression used for Redshift query results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-outputcompression}
+     */
+    OutputCompression?: "None" | "GZIP" | "SNAPPY" | "ZSTD" | "BZIP2" | undefined;
+    /**
+     * The data storage format for Redshift query results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-outputformat}
+     */
+    OutputFormat: "PARQUET" | "CSV";
+    /**
+     * The location in Amazon S3 where the Redshift query results are stored.
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern (https|s3)://([^/]+)/?(.*)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-outputs3uri}
+     */
+    OutputS3Uri: string;
+    /**
+     * The SQL query statements to be executed.
+     * @maxLength 4096
+     * @pattern [\s\S]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-redshiftdatasetdefinition.html#cfn-sagemaker-processingjob-redshiftdatasetdefinition-querystring}
+     */
+    QueryString: string;
+};
+/**
+ * Configuration for downloading input data from Amazon S3 into the processing container.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html}
+ */
+export type S3Input = {
+    /**
+     * The local path in your container where you want Amazon SageMaker to write input data to. `LocalPath` is an absolute path to the input data and must begin with `/opt/ml/processing/`. LocalPath is a required parameter when `AppManaged` is `False` (default).
+     * @minLength 0
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-localpath}
+     */
+    LocalPath?: string | undefined;
+    /**
+     * Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. `Gzip` can only be used when `Pipe` mode is specified as the `S3InputMode`. In `Pipe` mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3compressiontype}
+     */
+    S3CompressionType?: "None" | "Gzip" | undefined;
+    /**
+     * Whether to distribute the data from Amazon S3 to all processing instances with `FullyReplicated`, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3datadistributiontype}
+     */
+    S3DataDistributionType?: "FullyReplicated" | "ShardedByS3Key" | undefined;
+    /**
+     * Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3datatype}
+     */
+    S3DataType: "ManifestFile" | "S3Prefix";
+    /**
+     * Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3inputmode}
+     */
+    S3InputMode?: "File" | "Pipe" | undefined;
+    /**
+     * The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern (https|s3)://([^/]+)/?(.*)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3uri}
+     */
+    S3Uri: string;
+};
+/**
+ * Configuration for uploading output data to Amazon S3 from the processing container.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3output.html}
+ */
+export type S3Output = {
+    /**
+     * The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.
+     * @minLength 0
+     * @maxLength 256
+     * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3output.html#cfn-sagemaker-processingjob-s3output-localpath}
+     */
+    LocalPath?: string | undefined;
+    /**
+     * Whether to upload the results of the processing job continuously or after the job completes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3output.html#cfn-sagemaker-processingjob-s3output-s3uploadmode}
+     */
+    S3UploadMode: "Continuous" | "EndOfJob";
+    /**
+     * A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
+     * @minLength 0
+     * @maxLength 1024
+     * @pattern (https|s3)://([^/]+)/?(.*)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3output.html#cfn-sagemaker-processingjob-s3output-s3uri}
+     */
+    S3Uri: string;
+};
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-stoppingcondition.html}
+ */
+export type StoppingCondition = {
+    /**
+     * Specifies the maximum runtime in seconds.
+     * @min 1
+     * @max 777600
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-stoppingcondition.html#cfn-sagemaker-processingjob-stoppingcondition-maxruntimeinseconds}
+     */
+    MaxRuntimeInSeconds: number;
+};
+/**
+ * Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html}
+ */
+export type VpcConfig = {
+    /**
+     * The VPC security group IDs, in the form 'sg-xxxxxxxx'. Specify the security groups for the VPC that is specified in the 'Subnets' field.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html#cfn-sagemaker-processingjob-vpcconfig-securitygroupids}
+     */
+    SecurityGroupIds: string[];
+    /**
+     * The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see https://docs.aws.amazon.com/sagemaker/latest/dg/regions-quotas.html
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-vpcconfig.html#cfn-sagemaker-processingjob-vpcconfig-subnets}
+     */
+    Subnets: string[];
+};
+//# sourceMappingURL=aws-sagemaker-processingjob.d.ts.map