software.amazon.awscdk.services.sagemaker

Interface CfnModelExplainabilityJobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelExplainabilityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.917Z")
 @Stability(value=Stable)
public interface CfnModelExplainabilityJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnModelExplainabilityJobDefinition`.

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.*;
 CfnModelExplainabilityJobDefinitionProps cfnModelExplainabilityJobDefinitionProps = CfnModelExplainabilityJobDefinitionProps.builder()
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .modelExplainabilityAppSpecification(ModelExplainabilityAppSpecificationProperty.builder()
                 .configUri("configUri")
                 .imageUri("imageUri")
                 // the properties below are optional
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .build())
         .modelExplainabilityJobInput(ModelExplainabilityJobInputProperty.builder()
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build())
         .modelExplainabilityJobOutputConfig(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
         .jobDefinitionName("jobDefinitionName")
         .modelExplainabilityBaselineConfig(ModelExplainabilityBaselineConfigProperty.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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnModelExplainabilityJobDefinitionProps.Builder	builder()
default String	getJobDefinitionName() The name of the model explainability job definition.
Object	getJobResources() Identifies the resources to deploy for a monitoring job.
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.
Object	getModelExplainabilityJobInput() Inputs for the model explainability job.
Object	getModelExplainabilityJobOutputConfig() The output configuration for monitoring jobs.
default Object	getNetworkConfig() Networking options for a model explainability 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() `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.
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 Detail

getJobResources

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

Identifies the resources to deploy for a monitoring job.

getModelExplainabilityAppSpecification

@Stability(value=Stable)
 @NotNull
Object getModelExplainabilityAppSpecification()

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

getModelExplainabilityJobInput

@Stability(value=Stable)
 @NotNull
Object getModelExplainabilityJobInput()

Inputs for the model explainability job.

getModelExplainabilityJobOutputConfig

@Stability(value=Stable)
 @NotNull
Object getModelExplainabilityJobOutputConfig()

The output configuration for monitoring jobs.

getRoleArn

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

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

getJobDefinitionName

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

getModelExplainabilityBaselineConfig

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

The baseline configuration for a model explainability job.

getNetworkConfig

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

Networking options for a model explainability job.

getStoppingCondition

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

`AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.

getTags

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

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

For more information, see Tag .

builder

@Stability(value=Stable)
static CfnModelExplainabilityJobDefinitionProps.Builder builder()

Returns:

a CfnModelExplainabilityJobDefinitionProps.Builder of CfnModelExplainabilityJobDefinitionProps