Class CfnDataQualityJobDefinition
Creates a definition for a job that monitors data quality and drift.
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDataQualityJobDefinition : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDataQualityJobDefinition
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For information about model monitor, see Amazon SageMaker Model Monitor .
CloudformationResource: AWS::SageMaker::DataQualityJobDefinition
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 cfnDataQualityJobDefinition = new CfnDataQualityJobDefinition(this, "MyCfnDataQualityJobDefinition", 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 = new JsonProperty {
Line = false
},
Parquet = false
},
LocalPath = "localPath",
// the properties below are optional
ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
},
EndpointInput = new EndpointInputProperty {
EndpointName = "endpointName",
LocalPath = "localPath",
// the properties below are optional
ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
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
CfnDataQualityJobDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataQualityJobDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDataQualityJobDefinition(Construct, String, ICfnDataQualityJobDefinitionProps) |
Properties
AttrCreationTime | The time when the job definition was created. |
AttrJobDefinitionArn | The Amazon Resource Name (ARN) of the job definition. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | The name of the endpoint used to run the monitoring job. |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataQualityJobDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataQualityJobDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataQualityJobDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataQualityJobDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDataQualityJobDefinition(Construct, String, ICfnDataQualityJobDefinitionProps)
public CfnDataQualityJobDefinition(Construct scope, string id, ICfnDataQualityJobDefinitionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDataQualityJobDefinitionProps
Resource properties.
Properties
AttrCreationTime
The time when the job definition was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationTime
AttrJobDefinitionArn
The Amazon Resource Name (ARN) of the job definition.
public virtual string AttrJobDefinitionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: JobDefinitionArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataQualityAppSpecification
Specifies the container that runs the monitoring job.
public virtual object DataQualityAppSpecification { get; set; }
Property Value
System.Object
DataQualityBaselineConfig
Configures the constraints and baselines for the monitoring job.
public virtual object DataQualityBaselineConfig { get; set; }
Property Value
System.Object
DataQualityJobInput
A list of inputs for the monitoring job.
public virtual object DataQualityJobInput { get; set; }
Property Value
System.Object
DataQualityJobOutputConfig
The output configuration for monitoring jobs.
public virtual object DataQualityJobOutputConfig { get; set; }
Property Value
System.Object
EndpointName
The name of the endpoint used to run the monitoring job.
public virtual string EndpointName { get; set; }
Property Value
System.String
JobDefinitionName
The name for the monitoring job definition.
public virtual string JobDefinitionName { get; set; }
Property Value
System.String
JobResources
Identifies the resources to deploy for a monitoring job.
public virtual object JobResources { get; set; }
Property Value
System.Object
NetworkConfig
Specifies networking configuration for the monitoring job.
public virtual object NetworkConfig { get; set; }
Property Value
System.Object
RoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
public virtual string RoleArn { get; set; }
Property Value
System.String
StoppingCondition
A time limit for how long the monitoring job is allowed to run before stopping.
public virtual object StoppingCondition { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>