Class CfnModelBiasJobDefinitionProps

Properties for defining a CfnModelBiasJobDefinition.

Inheritance

System.Object

CfnModelBiasJobDefinitionProps

Implements

ICfnModelBiasJobDefinitionProps

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public class CfnModelBiasJobDefinitionProps : Object, ICfnModelBiasJobDefinitionProps

Syntax (vb)

Public Class CfnModelBiasJobDefinitionProps
    Inherits Object
    Implements ICfnModelBiasJobDefinitionProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.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 cfnModelBiasJobDefinitionProps = new CfnModelBiasJobDefinitionProps {
    JobResources = new MonitoringResourcesProperty {
        ClusterConfig = new ClusterConfigProperty {
            InstanceCount = 123,
            InstanceType = "instanceType",
            VolumeSizeInGb = 123,

            // the properties below are optional
            VolumeKmsKeyId = "volumeKmsKeyId"
        }
    },
    ModelBiasAppSpecification = new ModelBiasAppSpecificationProperty {
        ConfigUri = "configUri",
        ImageUri = "imageUri",

        // the properties below are optional
        Environment = new Dictionary<string, string> {
            { "environmentKey", "environment" }
        }
    },
    ModelBiasJobInput = new ModelBiasJobInputProperty {
        GroundTruthS3Input = new MonitoringGroundTruthS3InputProperty {
            S3Uri = "s3Uri"
        },

        // the properties below are optional
        BatchTransformInput = new BatchTransformInputProperty {
            DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
            DatasetFormat = new DatasetFormatProperty {
                Csv = new CsvProperty {
                    Header = false
                },
                Json = json,
                Parquet = false
            },
            LocalPath = "localPath",

            // the properties below are optional
            EndTimeOffset = "endTimeOffset",
            FeaturesAttribute = "featuresAttribute",
            InferenceAttribute = "inferenceAttribute",
            ProbabilityAttribute = "probabilityAttribute",
            ProbabilityThresholdAttribute = 123,
            S3DataDistributionType = "s3DataDistributionType",
            S3InputMode = "s3InputMode",
            StartTimeOffset = "startTimeOffset"
        },
        EndpointInput = new EndpointInputProperty {
            EndpointName = "endpointName",
            LocalPath = "localPath",

            // the properties below are optional
            EndTimeOffset = "endTimeOffset",
            FeaturesAttribute = "featuresAttribute",
            InferenceAttribute = "inferenceAttribute",
            ProbabilityAttribute = "probabilityAttribute",
            ProbabilityThresholdAttribute = 123,
            S3DataDistributionType = "s3DataDistributionType",
            S3InputMode = "s3InputMode",
            StartTimeOffset = "startTimeOffset"
        }
    },
    ModelBiasJobOutputConfig = 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"
    },
    RoleArn = "roleArn",

    // the properties below are optional
    EndpointName = "endpointName",
    JobDefinitionName = "jobDefinitionName",
    ModelBiasBaselineConfig = new ModelBiasBaselineConfigProperty {
        BaseliningJobName = "baseliningJobName",
        ConstraintsResource = new ConstraintsResourceProperty {
            S3Uri = "s3Uri"
        }
    },
    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

CfnModelBiasJobDefinitionProps()

Properties

EndpointName	`AWS::SageMaker::ModelBiasJobDefinition.EndpointName`.
JobDefinitionName	The name of the bias job definition.
JobResources	Identifies the resources to deploy for a monitoring job.
ModelBiasAppSpecification	Configures the model bias job to run a specified Docker container image.
ModelBiasBaselineConfig	The baseline configuration for a model bias job.
ModelBiasJobInput	Inputs for the model bias job.
ModelBiasJobOutputConfig	The output configuration for monitoring jobs.
NetworkConfig	Networking options for a model bias 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

CfnModelBiasJobDefinitionProps()

public CfnModelBiasJobDefinitionProps()

Properties

EndpointName

AWS::SageMaker::ModelBiasJobDefinition.EndpointName.

public string EndpointName { get; set; }

Property Value

System.String

Remarks

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

JobDefinitionName

The name of the bias job definition.

public string JobDefinitionName { get; set; }

Property Value

System.String

Remarks

The name must be unique within an AWS Region in the AWS account.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-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-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-jobresources

ModelBiasAppSpecification

Configures the model bias job to run a specified Docker container image.

public object ModelBiasAppSpecification { get; set; }

Property Value

System.Object

Remarks

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

ModelBiasBaselineConfig

The baseline configuration for a model bias job.

public object ModelBiasBaselineConfig { get; set; }

Property Value

System.Object

Remarks

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

ModelBiasJobInput

Inputs for the model bias job.

public object ModelBiasJobInput { get; set; }

Property Value

System.Object

Remarks

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

ModelBiasJobOutputConfig

The output configuration for monitoring jobs.

public object ModelBiasJobOutputConfig { get; set; }

Property Value

System.Object

Remarks

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

NetworkConfig

Networking options for a model bias job.

public object NetworkConfig { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-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-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-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-modelbiasjobdefinition.html#cfn-sagemaker-modelbiasjobdefinition-stoppingcondition

Implements

ICfnModelBiasJobDefinitionProps