software.amazon.awscdk.services.sagemaker

Class CfnDataQualityJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnDataQualityJobDefinition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.858Z")
 @Stability(value=Stable)
public class CfnDataQualityJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::DataQualityJobDefinition`.

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.*;
 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()
                 .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())
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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.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.EndpointInputProperty Input object for the endpoint.
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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDataQualityJobDefinition(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreationTime() The time when the job definition was created.
String	getAttrJobDefinitionArn() The Amazon Resource Name (ARN) of the job definition.
protected Map<String,Object>	getCfnProperties()
Object	getDataQualityAppSpecification() Specifies the container that runs the monitoring job.
Object	getDataQualityBaselineConfig() Configures the constraints and baselines for the monitoring job.
Object	getDataQualityJobInput() A list of inputs for the monitoring job.
Object	getDataQualityJobOutputConfig() The output configuration for monitoring jobs.
String	getJobDefinitionName() The name for the monitoring job definition.
Object	getJobResources() Identifies the resources to deploy for a monitoring job.
Object	getNetworkConfig() Specifies networking configuration for the monitoring job.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
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 Map<String,Object>	renderProperties(Map<String,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	setJobDefinitionName(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(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDataQualityJobDefinition

protected CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataQualityJobDefinition

protected CfnDataQualityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataQualityJobDefinition

@Stability(value=Stable)
public CfnDataQualityJobDefinition(@NotNull
                                                            software.constructs.Construct scope,
                                                            @NotNull
                                                            String id,
                                                            @NotNull
                                                            CfnDataQualityJobDefinitionProps props)

Create a new `AWS::SageMaker::DataQualityJobDefinition`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTime()

The time when the job definition was created.

getAttrJobDefinitionArn

@Stability(value=Stable)
 @NotNull
public String getAttrJobDefinitionArn()

The Amazon Resource Name (ARN) of the job definition.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDataQualityAppSpecification

@Stability(value=Stable)
 @NotNull
public Object getDataQualityAppSpecification()

Specifies the container that runs the monitoring job.

setDataQualityAppSpecification

@Stability(value=Stable)
public void setDataQualityAppSpecification(@NotNull
                                                                    CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty value)

Specifies the container that runs the monitoring job.

setDataQualityAppSpecification

@Stability(value=Stable)
public void setDataQualityAppSpecification(@NotNull
                                                                    IResolvable value)

Specifies the container that runs the monitoring job.

getDataQualityJobInput

@Stability(value=Stable)
 @NotNull
public Object getDataQualityJobInput()

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

setDataQualityJobInput

@Stability(value=Stable)
public void setDataQualityJobInput(@NotNull
                                                            CfnDataQualityJobDefinition.DataQualityJobInputProperty value)

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

setDataQualityJobInput

@Stability(value=Stable)
public void setDataQualityJobInput(@NotNull
                                                            IResolvable value)

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

getDataQualityJobOutputConfig

@Stability(value=Stable)
 @NotNull
public Object getDataQualityJobOutputConfig()

The output configuration for monitoring jobs.

setDataQualityJobOutputConfig

@Stability(value=Stable)
public void setDataQualityJobOutputConfig(@NotNull
                                                                   CfnDataQualityJobDefinition.MonitoringOutputConfigProperty value)

The output configuration for monitoring jobs.

setDataQualityJobOutputConfig

@Stability(value=Stable)
public void setDataQualityJobOutputConfig(@NotNull
                                                                   IResolvable value)

The output configuration for monitoring jobs.

getJobResources

@Stability(value=Stable)
 @NotNull
public Object getJobResources()

Identifies the resources to deploy for a monitoring job.

setJobResources

@Stability(value=Stable)
public void setJobResources(@NotNull
                                                     CfnDataQualityJobDefinition.MonitoringResourcesProperty value)

Identifies the resources to deploy for a monitoring job.

setJobResources

@Stability(value=Stable)
public void setJobResources(@NotNull
                                                     IResolvable value)

Identifies the resources to deploy for a monitoring job.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getDataQualityBaselineConfig

@Stability(value=Stable)
 @Nullable
public Object getDataQualityBaselineConfig()

Configures the constraints and baselines for the monitoring job.

setDataQualityBaselineConfig

@Stability(value=Stable)
public void setDataQualityBaselineConfig(@Nullable
                                                                  CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty value)

Configures the constraints and baselines for the monitoring job.

setDataQualityBaselineConfig

@Stability(value=Stable)
public void setDataQualityBaselineConfig(@Nullable
                                                                  IResolvable value)

Configures the constraints and baselines for the monitoring job.

getJobDefinitionName

@Stability(value=Stable)
 @Nullable
public String getJobDefinitionName()

The name for the monitoring job definition.

setJobDefinitionName

@Stability(value=Stable)
public void setJobDefinitionName(@Nullable
                                                          String value)

The name for the monitoring job definition.

getNetworkConfig

@Stability(value=Stable)
 @Nullable
public Object getNetworkConfig()

Specifies networking configuration for the monitoring job.

setNetworkConfig

@Stability(value=Stable)
public void setNetworkConfig(@Nullable
                                                      CfnDataQualityJobDefinition.NetworkConfigProperty value)

Specifies networking configuration for the monitoring job.

setNetworkConfig

@Stability(value=Stable)
public void setNetworkConfig(@Nullable
                                                      IResolvable value)

Specifies networking configuration for the monitoring job.

getStoppingCondition

@Stability(value=Stable)
 @Nullable
public Object getStoppingCondition()

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

setStoppingCondition

@Stability(value=Stable)
public void setStoppingCondition(@Nullable
                                                          CfnDataQualityJobDefinition.StoppingConditionProperty value)

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

setStoppingCondition

@Stability(value=Stable)
public void setStoppingCondition(@Nullable
                                                          IResolvable value)

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