Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnModelExplainabilityJobDefinitionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelExplainabilityJobDefinitionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.038Z")
@Stability(Stable)
public interface CfnModelExplainabilityJobDefinitionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnModelExplainabilityJobDefinitionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 CfnModelExplainabilityJobDefinitionMixinProps cfnModelExplainabilityJobDefinitionMixinProps = CfnModelExplainabilityJobDefinitionMixinProps.builder()
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .volumeSizeInGb(123)
                         .build())
                 .build())
         .modelExplainabilityAppSpecification(ModelExplainabilityAppSpecificationProperty.builder()
                 .configUri("configUri")
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .imageUri("imageUri")
                 .build())
         .modelExplainabilityBaselineConfig(ModelExplainabilityBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .modelExplainabilityJobInput(ModelExplainabilityJobInputProperty.builder()
                 .batchTransformInput(BatchTransformInputProperty.builder()
                         .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
                         .datasetFormat(DatasetFormatProperty.builder()
                                 .csv(CsvProperty.builder()
                                         .header(false)
                                         .build())
                                 .json(JsonProperty.builder()
                                         .line(false)
                                         .build())
                                 .parquet(false)
                                 .build())
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .localPath("localPath")
                         .probabilityAttribute("probabilityAttribute")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .localPath("localPath")
                         .probabilityAttribute("probabilityAttribute")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build())
         .modelExplainabilityJobOutputConfig(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-modelexplainabilityjobdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelExplainabilityJobDefinitionMixinProps.Builder	A builder for CfnModelExplainabilityJobDefinitionMixinProps
static final class	CfnModelExplainabilityJobDefinitionMixinProps.Jsii$Proxy	An implementation for CfnModelExplainabilityJobDefinitionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnModelExplainabilityJobDefinitionMixinProps.Builder	builder()
default String	getEndpointName()	The name of the endpoint used to run the monitoring job.
default String	getJobDefinitionName()	The name of the model explainability job definition.
default Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
default Object	getModelExplainabilityAppSpecification()	Configures the model explainability job to run a specified Docker container image.
default Object	getModelExplainabilityBaselineConfig()	The baseline configuration for a model explainability job.
default Object	getModelExplainabilityJobInput()	Inputs for the model explainability job.
default Object	getModelExplainabilityJobOutputConfig()	The output configuration for monitoring jobs.
default Object	getNetworkConfig()	Networking options for a model explainability job.
default Object	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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointname

getJobDefinitionName

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

The name of the model explainability 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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobdefinitionname

getJobResources

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

Identifies the resources to deploy for a monitoring job.

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.MonitoringResourcesProperty

See Also:

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

getModelExplainabilityAppSpecification

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

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

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.ModelExplainabilityAppSpecificationProperty

See Also:

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

getModelExplainabilityBaselineConfig

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

The baseline configuration for a model explainability job.

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.ModelExplainabilityBaselineConfigProperty

See Also:

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

getModelExplainabilityJobInput

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

Inputs for the model explainability job.

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.ModelExplainabilityJobInputProperty

See Also:

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

getModelExplainabilityJobOutputConfig

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

The output configuration for monitoring jobs.

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.MonitoringOutputConfigProperty

See Also:

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

getNetworkConfig

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

Networking options for a model explainability job.

Returns union: either IResolvable or CfnModelExplainabilityJobDefinitionPropsMixin.NetworkConfigProperty

See Also:

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

getRoleArn

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

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

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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 CfnModelExplainabilityJobDefinitionPropsMixin.StoppingConditionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags

builder

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

Returns:

a CfnModelExplainabilityJobDefinitionMixinProps.Builder of CfnModelExplainabilityJobDefinitionMixinProps