@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:49.998Z") public class CfnDataQualityJobDefinition extends CfnResource implements IInspectable
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.sagemaker.*; Object json; CfnDataQualityJobDefinition cfnDataQualityJobDefinition = CfnDataQualityJobDefinition.Builder.create(this, "MyCfnDataQualityJobDefinition") .dataQualityAppSpecification(DataQualityAppSpecificationProperty.builder() .imageUri("imageUri") // the properties below are optional .containerArguments(List.of("containerArguments")) .containerEntrypoint(List.of("containerEntrypoint")) .environment(Map.of( "environmentKey", "environment")) .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri") .recordPreprocessorSourceUri("recordPreprocessorSourceUri") .build()) .dataQualityJobInput(DataQualityJobInputProperty.builder() .batchTransformInput(BatchTransformInputProperty.builder() .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri") .datasetFormat(DatasetFormatProperty.builder() .csv(CsvProperty.builder() .header(false) .build()) .json(json) .parquet(false) .build()) .localPath("localPath") // the properties below are optional .s3DataDistributionType("s3DataDistributionType") .s3InputMode("s3InputMode") .build()) .endpointInput(EndpointInputProperty.builder() .endpointName("endpointName") .localPath("localPath") // the properties below are optional .s3DataDistributionType("s3DataDistributionType") .s3InputMode("s3InputMode") .build()) .build()) .dataQualityJobOutputConfig(MonitoringOutputConfigProperty.builder() .monitoringOutputs(List.of(MonitoringOutputProperty.builder() .s3Output(S3OutputProperty.builder() .localPath("localPath") .s3Uri("s3Uri") // the properties below are optional .s3UploadMode("s3UploadMode") .build()) .build())) // the properties below are optional .kmsKeyId("kmsKeyId") .build()) .jobResources(MonitoringResourcesProperty.builder() .clusterConfig(ClusterConfigProperty.builder() .instanceCount(123) .instanceType("instanceType") .volumeSizeInGb(123) // the properties below are optional .volumeKmsKeyId("volumeKmsKeyId") .build()) .build()) .roleArn("roleArn") // the properties below are optional .dataQualityBaselineConfig(DataQualityBaselineConfigProperty.builder() .baseliningJobName("baseliningJobName") .constraintsResource(ConstraintsResourceProperty.builder() .s3Uri("s3Uri") .build()) .statisticsResource(StatisticsResourceProperty.builder() .s3Uri("s3Uri") .build()) .build()) .endpointName("endpointName") .jobDefinitionName("jobDefinitionName") .networkConfig(NetworkConfigProperty.builder() .enableInterContainerTrafficEncryption(false) .enableNetworkIsolation(false) .vpcConfig(VpcConfigProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnets(List.of("subnets")) .build()) .build()) .stoppingCondition(StoppingConditionProperty.builder() .maxRuntimeInSeconds(123) .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnDataQualityJobDefinition.BatchTransformInputProperty
Example:
|
static class |
CfnDataQualityJobDefinition.Builder
A fluent builder for
CfnDataQualityJobDefinition . |
static interface |
CfnDataQualityJobDefinition.ClusterConfigProperty
The configuration for the cluster of resources used to run the processing job.
|
static interface |
CfnDataQualityJobDefinition.ConstraintsResourceProperty
The constraints resource for a monitoring job.
|
static interface |
CfnDataQualityJobDefinition.CsvProperty
Example:
|
static interface |
CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty
Information about the container that a data quality monitoring job runs.
|
static interface |
CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty
Configuration for monitoring constraints and monitoring statistics.
|
static interface |
CfnDataQualityJobDefinition.DataQualityJobInputProperty
The input for the data quality monitoring job.
|
static interface |
CfnDataQualityJobDefinition.DatasetFormatProperty
Example:
|
static interface |
CfnDataQualityJobDefinition.EndpointInputProperty
Input object for the endpoint.
|
static interface |
CfnDataQualityJobDefinition.JsonProperty
Example:
|
static interface |
CfnDataQualityJobDefinition.MonitoringOutputConfigProperty
The output configuration for monitoring jobs.
|
static interface |
CfnDataQualityJobDefinition.MonitoringOutputProperty
The output object for a monitoring job.
|
static interface |
CfnDataQualityJobDefinition.MonitoringResourcesProperty
Identifies the resources to deploy for a monitoring job.
|
static interface |
CfnDataQualityJobDefinition.NetworkConfigProperty
Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
|
static interface |
CfnDataQualityJobDefinition.S3OutputProperty
The Amazon S3 storage location where the results of a monitoring job are saved.
|
static interface |
CfnDataQualityJobDefinition.StatisticsResourceProperty
The statistics resource for a monitoring job.
|
static interface |
CfnDataQualityJobDefinition.StoppingConditionProperty
Specifies a limit to how long a model training job or model compilation job can run.
|
static interface |
CfnDataQualityJobDefinition.VpcConfigProperty
Specifies a VPC that your training jobs and hosted models have access to.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDataQualityJobDefinition(Construct scope,
java.lang.String id,
CfnDataQualityJobDefinitionProps props)
Create a new `AWS::SageMaker::DataQualityJobDefinition`.
|
protected |
CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrCreationTime()
The time when the job definition was created.
|
java.lang.String |
getAttrJobDefinitionArn()
The Amazon Resource Name (ARN) of the job definition.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDataQualityAppSpecification()
Specifies the container that runs the monitoring job.
|
java.lang.Object |
getDataQualityBaselineConfig()
Configures the constraints and baselines for the monitoring job.
|
java.lang.Object |
getDataQualityJobInput()
A list of inputs for the monitoring job.
|
java.lang.Object |
getDataQualityJobOutputConfig()
The output configuration for monitoring jobs.
|
java.lang.String |
getEndpointName()
`AWS::SageMaker::DataQualityJobDefinition.EndpointName`.
|
java.lang.String |
getJobDefinitionName()
The name for the monitoring job definition.
|
java.lang.Object |
getJobResources()
Identifies the resources to deploy for a monitoring job.
|
java.lang.Object |
getNetworkConfig()
Specifies networking configuration for the monitoring job.
|
java.lang.String |
getRoleArn()
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
|
java.lang.Object |
getStoppingCondition()
A time limit for how long the monitoring job is allowed to run before stopping.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDataQualityAppSpecification(CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty value)
Specifies the container that runs the monitoring job.
|
void |
setDataQualityAppSpecification(IResolvable value)
Specifies the container that runs the monitoring job.
|
void |
setDataQualityBaselineConfig(CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty value)
Configures the constraints and baselines for the monitoring job.
|
void |
setDataQualityBaselineConfig(IResolvable value)
Configures the constraints and baselines for the monitoring job.
|
void |
setDataQualityJobInput(CfnDataQualityJobDefinition.DataQualityJobInputProperty value)
A list of inputs for the monitoring job.
|
void |
setDataQualityJobInput(IResolvable value)
A list of inputs for the monitoring job.
|
void |
setDataQualityJobOutputConfig(CfnDataQualityJobDefinition.MonitoringOutputConfigProperty value)
The output configuration for monitoring jobs.
|
void |
setDataQualityJobOutputConfig(IResolvable value)
The output configuration for monitoring jobs.
|
void |
setEndpointName(java.lang.String value)
`AWS::SageMaker::DataQualityJobDefinition.EndpointName`.
|
void |
setJobDefinitionName(java.lang.String value)
The name for the monitoring job definition.
|
void |
setJobResources(CfnDataQualityJobDefinition.MonitoringResourcesProperty value)
Identifies the resources to deploy for a monitoring job.
|
void |
setJobResources(IResolvable value)
Identifies the resources to deploy for a monitoring job.
|
void |
setNetworkConfig(CfnDataQualityJobDefinition.NetworkConfigProperty value)
Specifies networking configuration for the monitoring job.
|
void |
setNetworkConfig(IResolvable value)
Specifies networking configuration for the monitoring job.
|
void |
setRoleArn(java.lang.String value)
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
|
void |
setStoppingCondition(CfnDataQualityJobDefinition.StoppingConditionProperty value)
A time limit for how long the monitoring job is allowed to run before stopping.
|
void |
setStoppingCondition(IResolvable value)
A time limit for how long the monitoring job is allowed to run before stopping.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataQualityJobDefinition(Construct scope, java.lang.String id, CfnDataQualityJobDefinitionProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrCreationTime()
public java.lang.String getAttrJobDefinitionArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.Object getDataQualityAppSpecification()
public void setDataQualityAppSpecification(IResolvable value)
public void setDataQualityAppSpecification(CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty value)
public java.lang.Object getDataQualityJobInput()
Currently endpoints are supported as monitoring inputs.
public void setDataQualityJobInput(IResolvable value)
Currently endpoints are supported as monitoring inputs.
public void setDataQualityJobInput(CfnDataQualityJobDefinition.DataQualityJobInputProperty value)
Currently endpoints are supported as monitoring inputs.
public java.lang.Object getDataQualityJobOutputConfig()
public void setDataQualityJobOutputConfig(IResolvable value)
public void setDataQualityJobOutputConfig(CfnDataQualityJobDefinition.MonitoringOutputConfigProperty value)
public java.lang.Object getJobResources()
public void setJobResources(IResolvable value)
public void setJobResources(CfnDataQualityJobDefinition.MonitoringResourcesProperty value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.Object getDataQualityBaselineConfig()
public void setDataQualityBaselineConfig(IResolvable value)
public void setDataQualityBaselineConfig(CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty value)
public java.lang.String getEndpointName()
public void setEndpointName(java.lang.String value)
public java.lang.String getJobDefinitionName()
public void setJobDefinitionName(java.lang.String value)
public java.lang.Object getNetworkConfig()
public void setNetworkConfig(IResolvable value)
public void setNetworkConfig(CfnDataQualityJobDefinition.NetworkConfigProperty value)
public java.lang.Object getStoppingCondition()
public void setStoppingCondition(IResolvable value)
public void setStoppingCondition(CfnDataQualityJobDefinition.StoppingConditionProperty value)