Class CfnModelExplainabilityJobDefinitionMixinProps

Properties for CfnModelExplainabilityJobDefinitionPropsMixin.

Inheritance

object

CfnModelExplainabilityJobDefinitionMixinProps

Implements

ICfnModelExplainabilityJobDefinitionMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnModelExplainabilityJobDefinitionMixinProps : ICfnModelExplainabilityJobDefinitionMixinProps

Syntax (vb)

Public Class CfnModelExplainabilityJobDefinitionMixinProps Implements ICfnModelExplainabilityJobDefinitionMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.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.Mixins.Preview.AWS.SageMaker.Mixins;

             var cfnModelExplainabilityJobDefinitionMixinProps = new CfnModelExplainabilityJobDefinitionMixinProps {
                 EndpointName = "endpointName",
                 JobDefinitionName = "jobDefinitionName",
                 JobResources = new MonitoringResourcesProperty {
                     ClusterConfig = new ClusterConfigProperty {
                         InstanceCount = 123,
                         InstanceType = "instanceType",
                         VolumeKmsKeyId = "volumeKmsKeyId",
                         VolumeSizeInGb = 123
                     }
                 },
                 ModelExplainabilityAppSpecification = new ModelExplainabilityAppSpecificationProperty {
                     ConfigUri = "configUri",
                     Environment = new Dictionary<string, string> {
                         { "environmentKey", "environment" }
                     },
                     ImageUri = "imageUri"
                 },
                 ModelExplainabilityBaselineConfig = new ModelExplainabilityBaselineConfigProperty {
                     BaseliningJobName = "baseliningJobName",
                     ConstraintsResource = new ConstraintsResourceProperty {
                         S3Uri = "s3Uri"
                     }
                 },
                 ModelExplainabilityJobInput = new ModelExplainabilityJobInputProperty {
                     BatchTransformInput = new BatchTransformInputProperty {
                         DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                         DatasetFormat = new DatasetFormatProperty {
                             Csv = new CsvProperty {
                                 Header = false
                             },
                             Json = new JsonProperty {
                                 Line = false
                             },
                             Parquet = false
                         },
                         FeaturesAttribute = "featuresAttribute",
                         InferenceAttribute = "inferenceAttribute",
                         LocalPath = "localPath",
                         ProbabilityAttribute = "probabilityAttribute",
                         S3DataDistributionType = "s3DataDistributionType",
                         S3InputMode = "s3InputMode"
                     },
                     EndpointInput = new EndpointInputProperty {
                         EndpointName = "endpointName",
                         FeaturesAttribute = "featuresAttribute",
                         InferenceAttribute = "inferenceAttribute",
                         LocalPath = "localPath",
                         ProbabilityAttribute = "probabilityAttribute",
                         S3DataDistributionType = "s3DataDistributionType",
                         S3InputMode = "s3InputMode"
                     }
                 },
                 ModelExplainabilityJobOutputConfig = new MonitoringOutputConfigProperty {
                     KmsKeyId = "kmsKeyId",
                     MonitoringOutputs = new [] { new MonitoringOutputProperty {
                         S3Output = new S3OutputProperty {
                             LocalPath = "localPath",
                             S3UploadMode = "s3UploadMode",
                             S3Uri = "s3Uri"
                         }
                     } }
                 },
                 NetworkConfig = new NetworkConfigProperty {
                     EnableInterContainerTrafficEncryption = false,
                     EnableNetworkIsolation = false,
                     VpcConfig = new VpcConfigProperty {
                         SecurityGroupIds = new [] { "securityGroupIds" },
                         Subnets = new [] { "subnets" }
                     }
                 },
                 RoleArn = "roleArn",
                 StoppingCondition = new StoppingConditionProperty {
                     MaxRuntimeInSeconds = 123
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnModelExplainabilityJobDefinitionMixinProps()

Properties for CfnModelExplainabilityJobDefinitionPropsMixin.

Properties

EndpointName	The name of the endpoint used to run the monitoring job.
JobDefinitionName	The name of the model explainability job definition.
JobResources	Identifies the resources to deploy for a monitoring job.
ModelExplainabilityAppSpecification	Configures the model explainability job to run a specified Docker container image.
ModelExplainabilityBaselineConfig	The baseline configuration for a model explainability job.
ModelExplainabilityJobInput	Inputs for the model explainability job.
ModelExplainabilityJobOutputConfig	The output configuration for monitoring jobs.
NetworkConfig	Networking options for a model explainability 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

CfnModelExplainabilityJobDefinitionMixinProps()

Properties for CfnModelExplainabilityJobDefinitionPropsMixin.

public CfnModelExplainabilityJobDefinitionMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.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.Mixins.Preview.AWS.SageMaker.Mixins;

             var cfnModelExplainabilityJobDefinitionMixinProps = new CfnModelExplainabilityJobDefinitionMixinProps {
                 EndpointName = "endpointName",
                 JobDefinitionName = "jobDefinitionName",
                 JobResources = new MonitoringResourcesProperty {
                     ClusterConfig = new ClusterConfigProperty {
                         InstanceCount = 123,
                         InstanceType = "instanceType",
                         VolumeKmsKeyId = "volumeKmsKeyId",
                         VolumeSizeInGb = 123
                     }
                 },
                 ModelExplainabilityAppSpecification = new ModelExplainabilityAppSpecificationProperty {
                     ConfigUri = "configUri",
                     Environment = new Dictionary<string, string> {
                         { "environmentKey", "environment" }
                     },
                     ImageUri = "imageUri"
                 },
                 ModelExplainabilityBaselineConfig = new ModelExplainabilityBaselineConfigProperty {
                     BaseliningJobName = "baseliningJobName",
                     ConstraintsResource = new ConstraintsResourceProperty {
                         S3Uri = "s3Uri"
                     }
                 },
                 ModelExplainabilityJobInput = new ModelExplainabilityJobInputProperty {
                     BatchTransformInput = new BatchTransformInputProperty {
                         DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                         DatasetFormat = new DatasetFormatProperty {
                             Csv = new CsvProperty {
                                 Header = false
                             },
                             Json = new JsonProperty {
                                 Line = false
                             },
                             Parquet = false
                         },
                         FeaturesAttribute = "featuresAttribute",
                         InferenceAttribute = "inferenceAttribute",
                         LocalPath = "localPath",
                         ProbabilityAttribute = "probabilityAttribute",
                         S3DataDistributionType = "s3DataDistributionType",
                         S3InputMode = "s3InputMode"
                     },
                     EndpointInput = new EndpointInputProperty {
                         EndpointName = "endpointName",
                         FeaturesAttribute = "featuresAttribute",
                         InferenceAttribute = "inferenceAttribute",
                         LocalPath = "localPath",
                         ProbabilityAttribute = "probabilityAttribute",
                         S3DataDistributionType = "s3DataDistributionType",
                         S3InputMode = "s3InputMode"
                     }
                 },
                 ModelExplainabilityJobOutputConfig = new MonitoringOutputConfigProperty {
                     KmsKeyId = "kmsKeyId",
                     MonitoringOutputs = new [] { new MonitoringOutputProperty {
                         S3Output = new S3OutputProperty {
                             LocalPath = "localPath",
                             S3UploadMode = "s3UploadMode",
                             S3Uri = "s3Uri"
                         }
                     } }
                 },
                 NetworkConfig = new NetworkConfigProperty {
                     EnableInterContainerTrafficEncryption = false,
                     EnableNetworkIsolation = false,
                     VpcConfig = new VpcConfigProperty {
                         SecurityGroupIds = new [] { "securityGroupIds" },
                         Subnets = new [] { "subnets" }
                     }
                 },
                 RoleArn = "roleArn",
                 StoppingCondition = new StoppingConditionProperty {
                     MaxRuntimeInSeconds = 123
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

EndpointName

The name of the endpoint used to run the monitoring job.

public string? EndpointName { get; set; }

Property Value

string

Remarks

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

JobDefinitionName

The name of the model explainability job definition.

public string? JobDefinitionName { get; set; }

Property Value

string

Remarks

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

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

JobResources

Identifies the resources to deploy for a monitoring job.

public object? JobResources { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IMonitoringResourcesProperty

ModelExplainabilityAppSpecification

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

public object? ModelExplainabilityAppSpecification { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IModelExplainabilityAppSpecificationProperty

ModelExplainabilityBaselineConfig

The baseline configuration for a model explainability job.

public object? ModelExplainabilityBaselineConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IModelExplainabilityBaselineConfigProperty

ModelExplainabilityJobInput

Inputs for the model explainability job.

public object? ModelExplainabilityJobInput { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IModelExplainabilityJobInputProperty

ModelExplainabilityJobOutputConfig

The output configuration for monitoring jobs.

public object? ModelExplainabilityJobOutputConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjoboutputconfig

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IMonitoringOutputConfigProperty

NetworkConfig

Networking options for a model explainability job.

public object? NetworkConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.INetworkConfigProperty

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

string

Remarks

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

StoppingCondition

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

public object? StoppingCondition { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.IStoppingConditionProperty

Tags

An array of key-value pairs to apply to this resource.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see Tag .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags

Implements

ICfnModelExplainabilityJobDefinitionMixinProps