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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-11T23:26:40.929Z")
@Stability(Stable)
public class CfnModelExplainabilityJobDefinition
extends CfnResource
implements IInspectable, ITaggable
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() .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 .featuresAttribute("featuresAttribute") .inferenceAttribute("inferenceAttribute") .probabilityAttribute("probabilityAttribute") .s3DataDistributionType("s3DataDistributionType") .s3InputMode("s3InputMode") .build()) .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 .endpointName("endpointName") .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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Input object for the batch transform job.static final class
A fluent builder forCfnModelExplainabilityJobDefinition
.static interface
The configuration for the cluster resources used to run the processing job.static interface
Input object for the endpoint.static interface
The CSV format.static interface
The dataset format of the data to monitor.static interface
Input object for the endpoint.static interface
The Json format.static interface
Docker container image configuration object for the model explainability job.static interface
The configuration for a baseline model explainability job.static interface
Inputs for the model explainability job.static interface
The output configuration for monitoring jobs.static interface
The output object for a monitoring job.static interface
Identifies the resources to deploy for a monitoring job.static interface
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
The Amazon S3 storage location where the results of a monitoring job are saved.static interface
Specifies a limit to how long a job can run.static interface
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources 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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnModelExplainabilityJobDefinition
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnModelExplainabilityJobDefinition
(software.amazon.jsii.JsiiObjectRef objRef) CfnModelExplainabilityJobDefinition
(software.constructs.Construct scope, String id, CfnModelExplainabilityJobDefinitionProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe time when the job definition was created.The Amazon Resource Name (ARN) of the job definition.The name of the endpoint used to run the monitoring job.The name of the model explainability job definition.Identifies the resources to deploy for a monitoring job.Configures the model explainability job to run a specified Docker container image.The baseline configuration for a model explainability job.Inputs for the model explainability job.The output configuration for monitoring jobs.Networking options for a model explainability job.The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.A time limit for how long the monitoring job is allowed to run before stopping.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setEndpointName
(String value) The name of the endpoint used to run the monitoring job.void
setJobDefinitionName
(String value) The name of the model explainability job definition.void
setJobResources
(IResolvable value) Identifies the resources to deploy for a monitoring job.void
Identifies the resources to deploy for a monitoring job.void
Configures the model explainability job to run a specified Docker container image.void
setModelExplainabilityAppSpecification
(CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty value) Configures the model explainability job to run a specified Docker container image.void
The baseline configuration for a model explainability job.void
setModelExplainabilityBaselineConfig
(CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty value) The baseline configuration for a model explainability job.void
Inputs for the model explainability job.void
setModelExplainabilityJobInput
(CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty value) Inputs for the model explainability job.void
The output configuration for monitoring jobs.void
setModelExplainabilityJobOutputConfig
(CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty value) The output configuration for monitoring jobs.void
setNetworkConfig
(IResolvable value) Networking options for a model explainability job.void
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
(IResolvable value) A time limit for how long the monitoring job is allowed to run before stopping.void
A time limit for how long the monitoring job is allowed to run before stopping.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnModelExplainabilityJobDefinition
protected CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef) -
CfnModelExplainabilityJobDefinition
protected CfnModelExplainabilityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnModelExplainabilityJobDefinition
@Stability(Stable) public CfnModelExplainabilityJobDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnModelExplainabilityJobDefinitionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreationTime
The time when the job definition was created. -
getAttrJobDefinitionArn
The Amazon Resource Name (ARN) of the job definition. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getJobResources
Identifies the resources to deploy for a monitoring job. -
setJobResources
Identifies the resources to deploy for a monitoring job. -
setJobResources
@Stability(Stable) public void setJobResources(@NotNull CfnModelExplainabilityJobDefinition.MonitoringResourcesProperty value) Identifies the resources to deploy for a monitoring job. -
getModelExplainabilityAppSpecification
Configures the model explainability job to run a specified Docker container image. -
setModelExplainabilityAppSpecification
Configures the model explainability job to run a specified Docker container image. -
setModelExplainabilityAppSpecification
@Stability(Stable) public void setModelExplainabilityAppSpecification(@NotNull CfnModelExplainabilityJobDefinition.ModelExplainabilityAppSpecificationProperty value) Configures the model explainability job to run a specified Docker container image. -
getModelExplainabilityJobInput
Inputs for the model explainability job. -
setModelExplainabilityJobInput
Inputs for the model explainability job. -
setModelExplainabilityJobInput
@Stability(Stable) public void setModelExplainabilityJobInput(@NotNull CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty value) Inputs for the model explainability job. -
getModelExplainabilityJobOutputConfig
The output configuration for monitoring jobs. -
setModelExplainabilityJobOutputConfig
The output configuration for monitoring jobs. -
setModelExplainabilityJobOutputConfig
@Stability(Stable) public void setModelExplainabilityJobOutputConfig(@NotNull CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty value) The output configuration for monitoring jobs. -
getRoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. -
setRoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. -
getEndpointName
The name of the endpoint used to run the monitoring job. -
setEndpointName
The name of the endpoint used to run the monitoring job. -
getJobDefinitionName
The name of the model explainability job definition. -
setJobDefinitionName
The name of the model explainability job definition. -
getModelExplainabilityBaselineConfig
The baseline configuration for a model explainability job. -
setModelExplainabilityBaselineConfig
The baseline configuration for a model explainability job. -
setModelExplainabilityBaselineConfig
@Stability(Stable) public void setModelExplainabilityBaselineConfig(@Nullable CfnModelExplainabilityJobDefinition.ModelExplainabilityBaselineConfigProperty value) The baseline configuration for a model explainability job. -
getNetworkConfig
Networking options for a model explainability job. -
setNetworkConfig
Networking options for a model explainability job. -
setNetworkConfig
@Stability(Stable) public void setNetworkConfig(@Nullable CfnModelExplainabilityJobDefinition.NetworkConfigProperty value) Networking options for a model explainability job. -
getStoppingCondition
A time limit for how long the monitoring job is allowed to run before stopping. -
setStoppingCondition
A time limit for how long the monitoring job is allowed to run before stopping. -
setStoppingCondition
@Stability(Stable) public void setStoppingCondition(@Nullable CfnModelExplainabilityJobDefinition.StoppingConditionProperty value) A time limit for how long the monitoring job is allowed to run before stopping. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-