Package software.amazon.awscdk.services.sagemaker

Class CfnModelBiasJobDefinition

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.CfnModelBiasJobDefinition

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IModelBiasJobDefinitionRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:17.434Z")
@Stability(Stable)
public class CfnModelBiasJobDefinition
extends CfnResource
implements IInspectable, IModelBiasJobDefinitionRef, ITaggable

Creates the definition for a model bias job.

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.*;
 CfnModelBiasJobDefinition cfnModelBiasJobDefinition = CfnModelBiasJobDefinition.Builder.create(this, "MyCfnModelBiasJobDefinition")
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .modelBiasAppSpecification(ModelBiasAppSpecificationProperty.builder()
                 .configUri("configUri")
                 .imageUri("imageUri")
                 // the properties below are optional
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .build())
         .modelBiasJobInput(ModelBiasJobInputProperty.builder()
                 .groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 // the properties below are optional
                 .batchTransformInput(BatchTransformInputProperty.builder()
                         .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
                         .datasetFormat(DatasetFormatProperty.builder()
                                 .csv(CsvProperty.builder()
                                         .header(false)
                                         .build())
                                 .json(JsonProperty.builder()
                                         .line(false)
                                         .build())
                                 .parquet(false)
                                 .build())
                         .localPath("localPath")
                         // the properties below are optional
                         .endTimeOffset("endTimeOffset")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .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")
                         .build())
                 .build())
         .modelBiasJobOutputConfig(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())
         .roleArn("roleArn")
         // the properties below are optional
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .modelBiasBaselineConfig(ModelBiasBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelbiasjobdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnModelBiasJobDefinition.BatchTransformInputProperty	Input object for the batch transform job.
static final class	CfnModelBiasJobDefinition.Builder	A fluent builder for CfnModelBiasJobDefinition.
static interface	CfnModelBiasJobDefinition.ClusterConfigProperty	The configuration for the cluster resources used to run the processing job.
static interface	CfnModelBiasJobDefinition.ConstraintsResourceProperty	The constraints resource for a monitoring job.
static interface	CfnModelBiasJobDefinition.CsvProperty	The CSV format.
static interface	CfnModelBiasJobDefinition.DatasetFormatProperty	The dataset format of the data to monitor.
static interface	CfnModelBiasJobDefinition.EndpointInputProperty	Input object for the endpoint.
static interface	CfnModelBiasJobDefinition.JsonProperty	The Json format.
static interface	CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty	Docker container image configuration object for the model bias job.
static interface	CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty	The configuration for a baseline model bias job.
static interface	CfnModelBiasJobDefinition.ModelBiasJobInputProperty	Inputs for the model bias job.
static interface	CfnModelBiasJobDefinition.MonitoringGroundTruthS3InputProperty	The ground truth labels for the dataset used for the monitoring job.
static interface	CfnModelBiasJobDefinition.MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
static interface	CfnModelBiasJobDefinition.MonitoringOutputProperty	The output object for a monitoring job.
static interface	CfnModelBiasJobDefinition.MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
static interface	CfnModelBiasJobDefinition.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	CfnModelBiasJobDefinition.S3OutputProperty	The Amazon S3 storage location where the results of a monitoring job are saved.
static interface	CfnModelBiasJobDefinition.StoppingConditionProperty	Specifies a limit to how long a job can run.
static interface	CfnModelBiasJobDefinition.VpcConfigProperty	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.sagemaker.IModelBiasJobDefinitionRef

IModelBiasJobDefinitionRef.Jsii$Default, IModelBiasJobDefinitionRef.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	CfnModelBiasJobDefinition(software.constructs.Construct scope, String id, CfnModelBiasJobDefinitionProps props)	Create a new AWS::SageMaker::ModelBiasJobDefinition.

Method Summary

Modifier and Type	Method	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()
String	getEndpointName()	The name of the endpoint used to run the monitoring job.
String	getJobDefinitionName()	The name of the bias job definition.
Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
Object	getModelBiasAppSpecification()	Configures the model bias job to run a specified Docker container image.
Object	getModelBiasBaselineConfig()	The baseline configuration for a model bias job.
ModelBiasJobDefinitionReference	getModelBiasJobDefinitionRef()	A reference to a ModelBiasJobDefinition resource.
Object	getModelBiasJobInput()	Inputs for the model bias job.
Object	getModelBiasJobOutputConfig()	The output configuration for monitoring jobs.
Object	getNetworkConfig()	Networking options for a model bias 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()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnModelBiasJobDefinition(Object x)	Checks whether the given object is a CfnModelBiasJobDefinition.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEndpointName(String value)	The name of the endpoint used to run the monitoring job.
void	setJobDefinitionName(String value)	The name of the bias job definition.
void	setJobResources(IResolvable value)	Identifies the resources to deploy for a monitoring job.
void	setJobResources(CfnModelBiasJobDefinition.MonitoringResourcesProperty value)	Identifies the resources to deploy for a monitoring job.
void	setModelBiasAppSpecification(IResolvable value)	Configures the model bias job to run a specified Docker container image.
void	setModelBiasAppSpecification(CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty value)	Configures the model bias job to run a specified Docker container image.
void	setModelBiasBaselineConfig(IResolvable value)	The baseline configuration for a model bias job.
void	setModelBiasBaselineConfig(CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty value)	The baseline configuration for a model bias job.
void	setModelBiasJobInput(IResolvable value)	Inputs for the model bias job.
void	setModelBiasJobInput(CfnModelBiasJobDefinition.ModelBiasJobInputProperty value)	Inputs for the model bias job.
void	setModelBiasJobOutputConfig(IResolvable value)	The output configuration for monitoring jobs.
void	setModelBiasJobOutputConfig(CfnModelBiasJobDefinition.MonitoringOutputConfigProperty value)	The output configuration for monitoring jobs.
void	setNetworkConfig(IResolvable value)	Networking options for a model bias job.
void	setNetworkConfig(CfnModelBiasJobDefinition.NetworkConfigProperty value)	Networking options for a model bias 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(IResolvable value)	A time limit for how long the monitoring job is allowed to run before stopping.
void	setStoppingCondition(CfnModelBiasJobDefinition.StoppingConditionProperty value)	A time limit for how long the monitoring job is allowed to run before stopping.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnModelBiasJobDefinition

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

CfnModelBiasJobDefinition

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

CfnModelBiasJobDefinition

@Stability(Stable)
public CfnModelBiasJobDefinition(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnModelBiasJobDefinitionProps props)

Create a new AWS::SageMaker::ModelBiasJobDefinition.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnModelBiasJobDefinition

@Stability(Stable)
@NotNull
public static Boolean isCfnModelBiasJobDefinition(@NotNull
 Object x)

Checks whether the given object is a CfnModelBiasJobDefinition.

Parameters:

x - This parameter is required.

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrCreationTime()

The time when the job definition was created.

getAttrJobDefinitionArn

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

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getModelBiasJobDefinitionRef

@Stability(Stable)
@NotNull
public ModelBiasJobDefinitionReference getModelBiasJobDefinitionRef()

A reference to a ModelBiasJobDefinition resource.

Specified by:

getModelBiasJobDefinitionRef in interface IModelBiasJobDefinitionRef

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getJobResources

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

Identifies the resources to deploy for a monitoring job.

Returns union: either IResolvable or CfnModelBiasJobDefinition.MonitoringResourcesProperty

setJobResources

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

Identifies the resources to deploy for a monitoring job.

setJobResources

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

Identifies the resources to deploy for a monitoring job.

getModelBiasAppSpecification

@Stability(Stable)
@NotNull
public Object getModelBiasAppSpecification()

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

Returns union: either IResolvable or CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty

setModelBiasAppSpecification

@Stability(Stable)
public void setModelBiasAppSpecification(@NotNull
 IResolvable value)

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

setModelBiasAppSpecification

@Stability(Stable)
public void setModelBiasAppSpecification(@NotNull
 CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty value)

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

getModelBiasJobInput

@Stability(Stable)
@NotNull
public Object getModelBiasJobInput()

Inputs for the model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinition.ModelBiasJobInputProperty

setModelBiasJobInput

@Stability(Stable)
public void setModelBiasJobInput(@NotNull
 IResolvable value)

Inputs for the model bias job.

setModelBiasJobInput

@Stability(Stable)
public void setModelBiasJobInput(@NotNull
 CfnModelBiasJobDefinition.ModelBiasJobInputProperty value)

Inputs for the model bias job.

getModelBiasJobOutputConfig

@Stability(Stable)
@NotNull
public Object getModelBiasJobOutputConfig()

The output configuration for monitoring jobs.

Returns union: either IResolvable or CfnModelBiasJobDefinition.MonitoringOutputConfigProperty

setModelBiasJobOutputConfig

@Stability(Stable)
public void setModelBiasJobOutputConfig(@NotNull
 IResolvable value)

The output configuration for monitoring jobs.

setModelBiasJobOutputConfig

@Stability(Stable)
public void setModelBiasJobOutputConfig(@NotNull
 CfnModelBiasJobDefinition.MonitoringOutputConfigProperty value)

The output configuration for monitoring jobs.

getRoleArn

@Stability(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(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.

getEndpointName

@Stability(Stable)
@Nullable
public String getEndpointName()

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

setEndpointName

@Stability(Stable)
public void setEndpointName(@Nullable
 String value)

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

getJobDefinitionName

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

The name of the bias job definition.

setJobDefinitionName

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

The name of the bias job definition.

getModelBiasBaselineConfig

@Stability(Stable)
@Nullable
public Object getModelBiasBaselineConfig()

The baseline configuration for a model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty

setModelBiasBaselineConfig

@Stability(Stable)
public void setModelBiasBaselineConfig(@Nullable
 IResolvable value)

The baseline configuration for a model bias job.

setModelBiasBaselineConfig

@Stability(Stable)
public void setModelBiasBaselineConfig(@Nullable
 CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty value)

The baseline configuration for a model bias job.

getNetworkConfig

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

Networking options for a model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinition.NetworkConfigProperty

setNetworkConfig

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

Networking options for a model bias job.

setNetworkConfig

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

Networking options for a model bias job.

getStoppingCondition

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

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

Returns union: either IResolvable or CfnModelBiasJobDefinition.StoppingConditionProperty

setStoppingCondition

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

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

setStoppingCondition

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

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

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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