software.amazon.awscdk.services.sagemaker

Interface CfnModelExplainabilityJobDefinitionProps

All Known Implementing Classes:

CfnModelExplainabilityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-27T16:27:57.335Z")
public interface CfnModelExplainabilityJobDefinitionProps

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 java.lang.String	getJobDefinitionName() The name of the model explainability job definition.
java.lang.Object	getJobResources() Identifies the resources to deploy for a monitoring job.
java.lang.Object	getModelExplainabilityAppSpecification() Configures the model explainability job to run a specified Docker container image.
default java.lang.Object	getModelExplainabilityBaselineConfig() The baseline configuration for a model explainability job.
java.lang.Object	getModelExplainabilityJobInput() Inputs for the model explainability job.
java.lang.Object	getModelExplainabilityJobOutputConfig() The output configuration for monitoring jobs.
default java.lang.Object	getNetworkConfig() Networking options for a model explainability job.
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
default java.lang.Object	getStoppingCondition() `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.
default java.util.List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.

Method Detail

getJobResources

java.lang.Object getJobResources()

Identifies the resources to deploy for a monitoring job.

getModelExplainabilityAppSpecification

java.lang.Object getModelExplainabilityAppSpecification()

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

getModelExplainabilityJobInput

java.lang.Object getModelExplainabilityJobInput()

Inputs for the model explainability job.

getModelExplainabilityJobOutputConfig

java.lang.Object getModelExplainabilityJobOutputConfig()

The output configuration for monitoring jobs.

getRoleArn

java.lang.String getRoleArn()

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

getJobDefinitionName

default java.lang.String getJobDefinitionName()

The name of the model explainability job definition.

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

getModelExplainabilityBaselineConfig

default java.lang.Object getModelExplainabilityBaselineConfig()

The baseline configuration for a model explainability job.

getNetworkConfig

default java.lang.Object getNetworkConfig()

Networking options for a model explainability job.

getStoppingCondition

default java.lang.Object getStoppingCondition()

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

getTags

default java.util.List<CfnTag> getTags()

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

For more information, see Tag .

builder

static CfnModelExplainabilityJobDefinitionProps.Builder builder()

Returns:

a CfnModelExplainabilityJobDefinitionProps.Builder of CfnModelExplainabilityJobDefinitionProps