Package software.amazon.awscdk.services.sagemaker

Interface CfnModelBiasJobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelBiasJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:09.693Z")
@Stability(Stable)
public interface CfnModelBiasJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnModelBiasJobDefinition.

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.*;
 CfnModelBiasJobDefinitionProps cfnModelBiasJobDefinitionProps = CfnModelBiasJobDefinitionProps.builder()
         .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	Interface	Description
static final class	CfnModelBiasJobDefinitionProps.Builder	A builder for CfnModelBiasJobDefinitionProps
static final class	CfnModelBiasJobDefinitionProps.Jsii$Proxy	An implementation for CfnModelBiasJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnModelBiasJobDefinitionProps.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.
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.
default Object	getModelBiasBaselineConfig()	The baseline configuration for a model bias job.
Object	getModelBiasJobInput()	Inputs for the model bias job.
Object	getModelBiasJobOutputConfig()	The output configuration for monitoring jobs.
default 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.
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

getJobResources

@Stability(Stable)
@NotNull
Object getJobResources()

Identifies the resources to deploy for a monitoring job.

See Also:

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

getModelBiasAppSpecification

@Stability(Stable)
@NotNull
Object getModelBiasAppSpecification()

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

See Also:

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

getModelBiasJobInput

@Stability(Stable)
@NotNull
Object getModelBiasJobInput()

Inputs for the model bias job.

See Also:

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

getModelBiasJobOutputConfig

@Stability(Stable)
@NotNull
Object getModelBiasJobOutputConfig()

The output configuration for monitoring jobs.

See Also:

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

getRoleArn

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

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

getModelBiasBaselineConfig

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

The baseline configuration for a model bias job.

See Also:

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

getNetworkConfig

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

Networking options for a model bias job.

See Also:

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

getStoppingCondition

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

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

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 CfnModelBiasJobDefinitionProps.Builder builder()

Returns:

a CfnModelBiasJobDefinitionProps.Builder of CfnModelBiasJobDefinitionProps