Package software.amazon.awscdk.mixins.preview.services.sagemaker.mixins

Interface CfnModelBiasJobDefinitionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelBiasJobDefinitionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:31.810Z")
@Stability(Stable)
public interface CfnModelBiasJobDefinitionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnModelBiasJobDefinitionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.*;
 CfnModelBiasJobDefinitionMixinProps cfnModelBiasJobDefinitionMixinProps = CfnModelBiasJobDefinitionMixinProps.builder()
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .volumeSizeInGb(123)
                         .build())
                 .build())
         .modelBiasAppSpecification(ModelBiasAppSpecificationProperty.builder()
                 .configUri("configUri")
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .imageUri("imageUri")
                 .build())
         .modelBiasBaselineConfig(ModelBiasBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .modelBiasJobInput(ModelBiasJobInputProperty.builder()
                 .batchTransformInput(BatchTransformInputProperty.builder()
                         .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
                         .datasetFormat(DatasetFormatProperty.builder()
                                 .csv(CsvProperty.builder()
                                         .header(false)
                                         .build())
                                 .json(JsonProperty.builder()
                                         .line(false)
                                         .build())
                                 .parquet(false)
                                 .build())
                         .endTimeOffset("endTimeOffset")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .localPath("localPath")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .endTimeOffset("endTimeOffset")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .localPath("localPath")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .modelBiasJobOutputConfig(MonitoringOutputConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .monitoringOutputs(List.of(MonitoringOutputProperty.builder()
                         .s3Output(S3OutputProperty.builder()
                                 .localPath("localPath")
                                 .s3UploadMode("s3UploadMode")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .build())
         .networkConfig(NetworkConfigProperty.builder()
                 .enableInterContainerTrafficEncryption(false)
                 .enableNetworkIsolation(false)
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .roleArn("roleArn")
         .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	Interface	Description
static final class	CfnModelBiasJobDefinitionMixinProps.Builder	A builder for CfnModelBiasJobDefinitionMixinProps
static final class	CfnModelBiasJobDefinitionMixinProps.Jsii$Proxy	An implementation for CfnModelBiasJobDefinitionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnModelBiasJobDefinitionMixinProps.Builder	builder()
default String	getEndpointName()	The name of the endpoint used to run the monitoring job.
default String	getJobDefinitionName()	The name of the bias job definition.
default Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
default Object	getModelBiasAppSpecification()	Configures the model bias job to run a specified Docker container image.
default Object	getModelBiasBaselineConfig()	The baseline configuration for a model bias job.
default Object	getModelBiasJobInput()	Inputs for the model bias job.
default Object	getModelBiasJobOutputConfig()	The output configuration for monitoring jobs.
default Object	getNetworkConfig()	Networking options for a model bias job.
default String	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
default Object	getStoppingCondition()	A time limit for how long the monitoring job is allowed to run before stopping.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointName

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

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

See Also:

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

getJobDefinitionName

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

The name of the bias job definition.

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

See Also:

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

getJobResources

@Stability(Stable)
@Nullable
default Object getJobResources()

Identifies the resources to deploy for a monitoring job.

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.MonitoringResourcesProperty

See Also:

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

getModelBiasAppSpecification

@Stability(Stable)
@Nullable
default Object getModelBiasAppSpecification()

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

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.ModelBiasAppSpecificationProperty

See Also:

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

getModelBiasBaselineConfig

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

The baseline configuration for a model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.ModelBiasBaselineConfigProperty

See Also:

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

getModelBiasJobInput

@Stability(Stable)
@Nullable
default Object getModelBiasJobInput()

Inputs for the model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.ModelBiasJobInputProperty

See Also:

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

getModelBiasJobOutputConfig

@Stability(Stable)
@Nullable
default Object getModelBiasJobOutputConfig()

The output configuration for monitoring jobs.

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.MonitoringOutputConfigProperty

See Also:

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

getNetworkConfig

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

Networking options for a model bias job.

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.NetworkConfigProperty

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

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

getStoppingCondition

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

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

Returns union: either IResolvable or CfnModelBiasJobDefinitionPropsMixin.StoppingConditionProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnModelBiasJobDefinitionMixinProps.Builder builder()

Returns:

a CfnModelBiasJobDefinitionMixinProps.Builder of CfnModelBiasJobDefinitionMixinProps