Class CfnDataQualityJobDefinitionProps

Properties for defining a CfnDataQualityJobDefinition.

Inheritance

System.Object

CfnDataQualityJobDefinitionProps

Implements

ICfnDataQualityJobDefinitionProps

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public class CfnDataQualityJobDefinitionProps : Object, ICfnDataQualityJobDefinitionProps

Syntax (vb)

Public Class CfnDataQualityJobDefinitionProps
    Inherits Object
    Implements ICfnDataQualityJobDefinitionProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.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 json;

var cfnDataQualityJobDefinitionProps = new CfnDataQualityJobDefinitionProps {
    DataQualityAppSpecification = new DataQualityAppSpecificationProperty {
        ImageUri = "imageUri",

        // the properties below are optional
        ContainerArguments = new [] { "containerArguments" },
        ContainerEntrypoint = new [] { "containerEntrypoint" },
        Environment = new Dictionary<string, string> {
            { "environmentKey", "environment" }
        },
        PostAnalyticsProcessorSourceUri = "postAnalyticsProcessorSourceUri",
        RecordPreprocessorSourceUri = "recordPreprocessorSourceUri"
    },
    DataQualityJobInput = new DataQualityJobInputProperty {
        BatchTransformInput = new BatchTransformInputProperty {
            DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
            DatasetFormat = new DatasetFormatProperty {
                Csv = new CsvProperty {
                    Header = false
                },
                Json = json,
                Parquet = false
            },
            LocalPath = "localPath",

            // the properties below are optional
            S3DataDistributionType = "s3DataDistributionType",
            S3InputMode = "s3InputMode"
        },
        EndpointInput = new EndpointInputProperty {
            EndpointName = "endpointName",
            LocalPath = "localPath",

            // the properties below are optional
            S3DataDistributionType = "s3DataDistributionType",
            S3InputMode = "s3InputMode"
        }
    },
    DataQualityJobOutputConfig = new MonitoringOutputConfigProperty {
        MonitoringOutputs = new [] { new MonitoringOutputProperty {
            S3Output = new S3OutputProperty {
                LocalPath = "localPath",
                S3Uri = "s3Uri",

                // the properties below are optional
                S3UploadMode = "s3UploadMode"
            }
        } },

        // the properties below are optional
        KmsKeyId = "kmsKeyId"
    },
    JobResources = new MonitoringResourcesProperty {
        ClusterConfig = new ClusterConfigProperty {
            InstanceCount = 123,
            InstanceType = "instanceType",
            VolumeSizeInGb = 123,

            // the properties below are optional
            VolumeKmsKeyId = "volumeKmsKeyId"
        }
    },
    RoleArn = "roleArn",

    // the properties below are optional
    DataQualityBaselineConfig = new DataQualityBaselineConfigProperty {
        BaseliningJobName = "baseliningJobName",
        ConstraintsResource = new ConstraintsResourceProperty {
            S3Uri = "s3Uri"
        },
        StatisticsResource = new StatisticsResourceProperty {
            S3Uri = "s3Uri"
        }
    },
    EndpointName = "endpointName",
    JobDefinitionName = "jobDefinitionName",
    NetworkConfig = new NetworkConfigProperty {
        EnableInterContainerTrafficEncryption = false,
        EnableNetworkIsolation = false,
        VpcConfig = new VpcConfigProperty {
            SecurityGroupIds = new [] { "securityGroupIds" },
            Subnets = new [] { "subnets" }
        }
    },
    StoppingCondition = new StoppingConditionProperty {
        MaxRuntimeInSeconds = 123
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnDataQualityJobDefinitionProps()

Properties

DataQualityAppSpecification	Specifies the container that runs the monitoring job.
DataQualityBaselineConfig	Configures the constraints and baselines for the monitoring job.
DataQualityJobInput	A list of inputs for the monitoring job.
DataQualityJobOutputConfig	The output configuration for monitoring jobs.
EndpointName	`AWS::SageMaker::DataQualityJobDefinition.EndpointName`.
JobDefinitionName	The name for the monitoring job definition.
JobResources	Identifies the resources to deploy for a monitoring job.
NetworkConfig	Specifies networking configuration for the monitoring job.
RoleArn	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
StoppingCondition	A time limit for how long the monitoring job is allowed to run before stopping.
Tags	An array of key-value pairs to apply to this resource.

Constructors

CfnDataQualityJobDefinitionProps()

public CfnDataQualityJobDefinitionProps()

Properties

DataQualityAppSpecification

Specifies the container that runs the monitoring job.

public object DataQualityAppSpecification { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityappspecification

DataQualityBaselineConfig

Configures the constraints and baselines for the monitoring job.

public object DataQualityBaselineConfig { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualitybaselineconfig

DataQualityJobInput

A list of inputs for the monitoring job.

public object DataQualityJobInput { get; set; }

Property Value

System.Object

Remarks

Currently endpoints are supported as monitoring inputs.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjobinput

DataQualityJobOutputConfig

The output configuration for monitoring jobs.

public object DataQualityJobOutputConfig { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-dataqualityjoboutputconfig

EndpointName

AWS::SageMaker::DataQualityJobDefinition.EndpointName.

public string EndpointName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-endpointname

JobDefinitionName

The name for the monitoring job definition.

public string JobDefinitionName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobdefinitionname

JobResources

Identifies the resources to deploy for a monitoring job.

public object JobResources { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-jobresources

NetworkConfig

Specifies networking configuration for the monitoring job.

public object NetworkConfig { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-networkconfig

RoleArn

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

public string RoleArn { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-rolearn

StoppingCondition

A time limit for how long the monitoring job is allowed to run before stopping.

public object StoppingCondition { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-dataqualityjobdefinition.html#cfn-sagemaker-dataqualityjobdefinition-stoppingcondition

Implements

ICfnDataQualityJobDefinitionProps