Package software.amazon.awscdk.services.sagemaker

Class CfnModelExplainabilityJobDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnModelExplainabilityJobDefinition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.327Z") @Stability(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.*;
 Object json;
 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(json)
                                 .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrCreationTime()
      The time when the job definition was created.

    • getAttrJobDefinitionArn

      @Stability(Stable) @NotNull public String getAttrJobDefinitionArn()
      The Amazon Resource Name (ARN) of the job definition.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getJobResources

      @Stability(Stable) @NotNull public Object getJobResources()
      Identifies the resources to deploy for a monitoring job.

    • setJobResources

      @Stability(Stable) public void setJobResources(@NotNull IResolvable value)
      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

      @Stability(Stable) @NotNull public Object getModelExplainabilityAppSpecification()
      Configures the model explainability job to run a specified Docker container image.

    • setModelExplainabilityAppSpecification

      @Stability(Stable) public void setModelExplainabilityAppSpecification(@NotNull IResolvable value)
      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

      @Stability(Stable) @NotNull public Object getModelExplainabilityJobInput()
      Inputs for the model explainability job.

    • setModelExplainabilityJobInput

      @Stability(Stable) public void setModelExplainabilityJobInput(@NotNull IResolvable value)
      Inputs for the model explainability job.

    • setModelExplainabilityJobInput

      @Stability(Stable) public void setModelExplainabilityJobInput(@NotNull CfnModelExplainabilityJobDefinition.ModelExplainabilityJobInputProperty value)
      Inputs for the model explainability job.

    • getModelExplainabilityJobOutputConfig

      @Stability(Stable) @NotNull public Object getModelExplainabilityJobOutputConfig()
      The output configuration for monitoring jobs.

    • setModelExplainabilityJobOutputConfig

      @Stability(Stable) public void setModelExplainabilityJobOutputConfig(@NotNull IResolvable value)
      The output configuration for monitoring jobs.

    • setModelExplainabilityJobOutputConfig

      @Stability(Stable) public void setModelExplainabilityJobOutputConfig(@NotNull CfnModelExplainabilityJobDefinition.MonitoringOutputConfigProperty value)
      The output configuration for monitoring jobs.

    • getRoleArn

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

    • getEndpointName

      @Stability(Stable) @Nullable public String getEndpointName()
      AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@Nullable String value)
      AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName.

    • getJobDefinitionName

      @Stability(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(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(Stable) @Nullable public Object getModelExplainabilityBaselineConfig()
      The baseline configuration for a model explainability job.

    • setModelExplainabilityBaselineConfig

      @Stability(Stable) public void setModelExplainabilityBaselineConfig(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getNetworkConfig()
      Networking options for a model explainability job.

    • setNetworkConfig

      @Stability(Stable) public void setNetworkConfig(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getStoppingCondition()
      A time limit for how long the monitoring job is allowed to run before stopping.

    • setStoppingCondition

      @Stability(Stable) public void setStoppingCondition(@Nullable IResolvable value)
      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.