software.amazon.awscdk.services.sagemaker

Class CfnModelExplainabilityJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnModelExplainabilityJobDefinition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.913Z")
 @Stability(value=Stable)
public class CfnModelExplainabilityJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::ModelExplainabilityJobDefinition`.

Creates the definition for a model explainability job.

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.*;
 CfnModelExplainabilityJobDefinition cfnModelExplainabilityJobDefinition = CfnModelExplainabilityJobDefinition.Builder.create(this, "MyCfnModelExplainabilityJobDefinition")
         .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	Class and Description
static class	CfnModelExplainabilityJobDefinition.Builder A fluent builder for CfnModelExplainabilityJobDefinition.
static interface	CfnModelExplainabilityJobDefinition.ClusterConfigProperty The configuration for the cluster resources used to run the processing job.
static interface	CfnModelExplainabilityJobDefinition.ConstraintsResourceProperty The constraints resource for a monitoring job.
static interface	CfnModelExplainabilityJobDefinition.EndpointInputProperty Input object for the endpoint.
static interface	CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty Docker container image configuration object for the model explainability job.
static interface	CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty The configuration for a baseline model explainability job.
static interface	CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty Inputs for the model explainability job.
static interface	CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty The output configuration for monitoring jobs.
static interface	CfnModelExplainabilityJobDefinition.MonitoringOutputProperty The output object for a monitoring job.
static interface	CfnModelExplainabilityJobDefinition.MonitoringResourcesProperty Identifies the resources to deploy for a monitoring job.
static interface	CfnModelExplainabilityJobDefinition.NetworkConfigProperty Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
static interface	CfnModelExplainabilityJobDefinition.S3OutputProperty The Amazon S3 storage location where the results of a monitoring job are saved.
static interface	CfnModelExplainabilityJobDefinition.StoppingConditionProperty Specifies a limit to how long a model training job or model compilation job can run.
static interface	CfnModelExplainabilityJobDefinition.VpcConfigProperty Specifies a VPC that your training jobs and hosted models have access to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnModelExplainabilityJobDefinition(software.constructs.Construct scope, String id, CfnModelExplainabilityJobDefinitionProps props) Create a new `AWS::SageMaker::ModelExplainabilityJobDefinition`.
protected	CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCreationTime() The time when the job definition was created.
String	getAttrJobDefinitionArn() The Amazon Resource Name (ARN) of the job definition.
protected Map<String,Object>	getCfnProperties()
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.
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.
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.
Object	getStoppingCondition() `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setJobDefinitionName(String value) The name of the model explainability job definition.
void	setJobResources(CfnModelExplainabilityJobDefinition.MonitoringResourcesProperty value) Identifies the resources to deploy for a monitoring job.
void	setJobResources(IResolvable value) Identifies the resources to deploy for a monitoring job.
void	setModelExplainabilityAppSpecification(CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty value) Configures the model explainability job to run a specified Docker container image.
void	setModelExplainabilityAppSpecification(IResolvable value) Configures the model explainability job to run a specified Docker container image.
void	setModelExplainabilityBaselineConfig(CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty value) The baseline configuration for a model explainability job.
void	setModelExplainabilityBaselineConfig(IResolvable value) The baseline configuration for a model explainability job.
void	setModelExplainabilityJobInput(CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty value) Inputs for the model explainability job.
void	setModelExplainabilityJobInput(IResolvable value) Inputs for the model explainability job.
void	setModelExplainabilityJobOutputConfig(CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty value) The output configuration for monitoring jobs.
void	setModelExplainabilityJobOutputConfig(IResolvable value) The output configuration for monitoring jobs.
void	setNetworkConfig(CfnModelExplainabilityJobDefinition.NetworkConfigProperty value) Networking options for a model explainability job.
void	setNetworkConfig(IResolvable value) Networking options for a model explainability job.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
void	setStoppingCondition(CfnModelExplainabilityJobDefinition.StoppingConditionProperty value) `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.
void	setStoppingCondition(IResolvable value) `AWS::SageMaker::ModelExplainabilityJobDefinition.StoppingCondition`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnModelExplainabilityJobDefinition

protected CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnModelExplainabilityJobDefinition

protected CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnModelExplainabilityJobDefinition

@Stability(value=Stable)
public CfnModelExplainabilityJobDefinition(@NotNull
                                                                    software.constructs.Construct scope,
                                                                    @NotNull
                                                                    String id,
                                                                    @NotNull
                                                                    CfnModelExplainabilityJobDefinitionProps props)

Create a new `AWS::SageMaker::ModelExplainabilityJobDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationTime()

The time when the job definition was created.

getAttrJobDefinitionArn

@Stability(value=Stable)
 @NotNull
public String getAttrJobDefinitionArn()

The Amazon Resource Name (ARN) of the job definition.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getJobResources

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

Identifies the resources to deploy for a monitoring job.

setJobResources

@Stability(value=Stable)
public void setJobResources(@NotNull
                                                     CfnModelExplainabilityJobDefinition.MonitoringResourcesProperty value)

Identifies the resources to deploy for a monitoring job.

setJobResources

@Stability(value=Stable)
public void setJobResources(@NotNull
                                                     IResolvable value)

Identifies the resources to deploy for a monitoring job.

getModelExplainabilityAppSpecification

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

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

setModelExplainabilityAppSpecification

@Stability(value=Stable)
public void setModelExplainabilityAppSpecification(@NotNull
                                                                            CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty value)

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

setModelExplainabilityAppSpecification

@Stability(value=Stable)
public void setModelExplainabilityAppSpecification(@NotNull
                                                                            IResolvable value)

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

getModelExplainabilityJobInput

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

Inputs for the model explainability job.

setModelExplainabilityJobInput

@Stability(value=Stable)
public void setModelExplainabilityJobInput(@NotNull
                                                                    CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty value)

Inputs for the model explainability job.

setModelExplainabilityJobInput

@Stability(value=Stable)
public void setModelExplainabilityJobInput(@NotNull
                                                                    IResolvable value)

Inputs for the model explainability job.

getModelExplainabilityJobOutputConfig

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

The output configuration for monitoring jobs.

setModelExplainabilityJobOutputConfig

@Stability(value=Stable)
public void setModelExplainabilityJobOutputConfig(@NotNull
                                                                           CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty value)

The output configuration for monitoring jobs.

setModelExplainabilityJobOutputConfig

@Stability(value=Stable)
public void setModelExplainabilityJobOutputConfig(@NotNull
                                                                           IResolvable value)

The output configuration for monitoring jobs.

getRoleArn

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

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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
public String getJobDefinitionName()

The name of the model explainability job definition.

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

setJobDefinitionName

@Stability(value=Stable)
public void setJobDefinitionName(@Nullable
                                                          String value)

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
public Object getModelExplainabilityBaselineConfig()

The baseline configuration for a model explainability job.

setModelExplainabilityBaselineConfig

@Stability(value=Stable)
public void setModelExplainabilityBaselineConfig(@Nullable
                                                                          CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty value)

The baseline configuration for a model explainability job.

setModelExplainabilityBaselineConfig

@Stability(value=Stable)
public void setModelExplainabilityBaselineConfig(@Nullable
                                                                          IResolvable value)

The baseline configuration for a model explainability job.

getNetworkConfig

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

Networking options for a model explainability job.

setNetworkConfig

@Stability(value=Stable)
public void setNetworkConfig(@Nullable
                                                      CfnModelExplainabilityJobDefinition.NetworkConfigProperty value)

Networking options for a model explainability job.

setNetworkConfig

@Stability(value=Stable)
public void setNetworkConfig(@Nullable
                                                      IResolvable value)

Networking options for a model explainability job.

getStoppingCondition

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

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

setStoppingCondition

@Stability(value=Stable)
public void setStoppingCondition(@Nullable
                                                          CfnModelExplainabilityJobDefinition.StoppingConditionProperty value)

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

setStoppingCondition

@Stability(value=Stable)
public void setStoppingCondition(@Nullable
                                                          IResolvable value)

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