Class CfnProcessingJob.S3InputProperty

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

Inheritance

object

CfnProcessingJob.S3InputProperty

Implements

CfnProcessingJob.IS3InputProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnProcessingJob.S3InputProperty : CfnProcessingJob.IS3InputProperty

Syntax (vb)

Public Class CfnProcessingJob.S3InputProperty Implements CfnProcessingJob.IS3InputProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var s3InputProperty = new S3InputProperty {
                 S3DataType = "s3DataType",
                 S3Uri = "s3Uri",

                 // the properties below are optional
                 LocalPath = "localPath",
                 S3CompressionType = "s3CompressionType",
                 S3DataDistributionType = "s3DataDistributionType",
                 S3InputMode = "s3InputMode"
             };

Synopsis

Constructors

S3InputProperty()

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

Properties

LocalPath	The local path in your container where you want Amazon SageMaker to write input data to.
S3CompressionType	Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.
S3DataDistributionType	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.
S3DataType	Whether you use an `S3Prefix` or a `ManifestFile` for the data type.
S3InputMode	Whether to use `File` or `Pipe` input mode.
S3Uri	The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

Constructors

S3InputProperty()

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

public S3InputProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var s3InputProperty = new S3InputProperty {
                 S3DataType = "s3DataType",
                 S3Uri = "s3Uri",

                 // the properties below are optional
                 LocalPath = "localPath",
                 S3CompressionType = "s3CompressionType",
                 S3DataDistributionType = "s3DataDistributionType",
                 S3InputMode = "s3InputMode"
             };

Properties

LocalPath

The local path in your container where you want Amazon SageMaker to write input data to.

public string? LocalPath { get; set; }

Property Value

string

Remarks

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).

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

S3CompressionType

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container.

public string? S3CompressionType { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3compressiontype

S3DataDistributionType

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.

public string? S3DataDistributionType { get; set; }

Property Value

string

Remarks

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

S3DataType

Whether you use an S3Prefix or a ManifestFile for the data type.

public string S3DataType { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3datatype

S3InputMode

Whether to use File or Pipe input mode.

public string? S3InputMode { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-s3input.html#cfn-sagemaker-processingjob-s3input-s3inputmode

S3Uri

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

public string S3Uri { get; set; }