class CfnModelExplainabilityJobDefinition (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnModelExplainabilityJobDefinition
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnModelExplainabilityJobDefinition
Java	software.amazon.awscdk.services.sagemaker.CfnModelExplainabilityJobDefinition
Python	aws_cdk.aws_sagemaker.CfnModelExplainabilityJobDefinition
TypeScript	aws-cdk-lib » aws_sagemaker » CfnModelExplainabilityJobDefinition

Implements IConstruct, IDependable, IInspectable, ITaggable

Creates the definition for a model explainability job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnModelExplainabilityJobDefinition = new sagemaker.CfnModelExplainabilityJobDefinition(this, 'MyCfnModelExplainabilityJobDefinition', {
  jobResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeSizeInGb: 123,

      // the properties below are optional
      volumeKmsKeyId: 'volumeKmsKeyId',
    },
  },
  modelExplainabilityAppSpecification: {
    configUri: 'configUri',
    imageUri: 'imageUri',

    // the properties below are optional
    environment: {
      environmentKey: 'environment',
    },
  },
  modelExplainabilityJobInput: {
    batchTransformInput: {
      dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
      datasetFormat: {
        csv: {
          header: false,
        },
        json: {
          line: false,
        },
        parquet: false,
      },
      localPath: 'localPath',

      // the properties below are optional
      featuresAttribute: 'featuresAttribute',
      inferenceAttribute: 'inferenceAttribute',
      probabilityAttribute: 'probabilityAttribute',
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
    endpointInput: {
      endpointName: 'endpointName',
      localPath: 'localPath',

      // the properties below are optional
      featuresAttribute: 'featuresAttribute',
      inferenceAttribute: 'inferenceAttribute',
      probabilityAttribute: 'probabilityAttribute',
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
  },
  modelExplainabilityJobOutputConfig: {
    monitoringOutputs: [{
      s3Output: {
        localPath: 'localPath',
        s3Uri: 's3Uri',

        // the properties below are optional
        s3UploadMode: 's3UploadMode',
      },
    }],

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  roleArn: 'roleArn',

  // the properties below are optional
  endpointName: 'endpointName',
  jobDefinitionName: 'jobDefinitionName',
  modelExplainabilityBaselineConfig: {
    baseliningJobName: 'baseliningJobName',
    constraintsResource: {
      s3Uri: 's3Uri',
    },
  },
  networkConfig: {
    enableInterContainerTrafficEncryption: false,
    enableNetworkIsolation: false,
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  stoppingCondition: {
    maxRuntimeInSeconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnModelExplainabilityJobDefinition(scope: Construct, id: string, props: CfnModelExplainabilityJobDefinitionProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnModelExplainabilityJobDefinitionProps — Resource properties.

Construct Props

Name	Type	Description
jobResources	IResolvable | MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecification	IResolvable | ModelExplainabilityAppSpecificationProperty	Configures the model explainability job to run a specified Docker container image.
modelExplainabilityJobInput	IResolvable | ModelExplainabilityJobInputProperty	Inputs for the model explainability job.
modelExplainabilityJobOutputConfig	IResolvable | MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
roleArn	string	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
endpointName?	string	The name of the endpoint used to run the monitoring job.
jobDefinitionName?	string	The name of the model explainability job definition.
modelExplainabilityBaselineConfig?	IResolvable | ModelExplainabilityBaselineConfigProperty	The baseline configuration for a model explainability job.
networkConfig?	IResolvable | NetworkConfigProperty	Networking options for a model explainability job.
stoppingCondition?	IResolvable | StoppingConditionProperty	A time limit for how long the monitoring job is allowed to run before stopping.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

jobResources

Type: IResolvable | MonitoringResourcesProperty

Identifies the resources to deploy for a monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobresources

---

modelExplainabilityAppSpecification

Type: IResolvable | ModelExplainabilityAppSpecificationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityappspecification

---

modelExplainabilityJobInput

Type: IResolvable | ModelExplainabilityJobInputProperty

Inputs for the model explainability job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjobinput

---

modelExplainabilityJobOutputConfig

Type: IResolvable | MonitoringOutputConfigProperty

The output configuration for monitoring jobs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilityjoboutputconfig

---

roleArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-rolearn

---

endpointName?

Type: string (optional)

The name of the endpoint used to run the monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointname

---

jobDefinitionName?

Type: string (optional)

The name of the model explainability job definition.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobdefinitionname

---

modelExplainabilityBaselineConfig?

Type: IResolvable | ModelExplainabilityBaselineConfigProperty (optional)

The baseline configuration for a model explainability job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-modelexplainabilitybaselineconfig

---

networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Networking options for a model explainability job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-networkconfig

---

stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

A time limit for how long the monitoring job is allowed to run before stopping.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-stoppingcondition

---

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags

Properties

Name	Type	Description
attrCreationTime	string	The time when the job definition was created.
attrJobDefinitionArn	string	The Amazon Resource Name (ARN) of the job definition.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
jobResources	IResolvable | MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
logicalId	string	The logical ID for this CloudFormation stack element.
modelExplainabilityAppSpecification	IResolvable | ModelExplainabilityAppSpecificationProperty	Configures the model explainability job to run a specified Docker container image.
modelExplainabilityJobInput	IResolvable | ModelExplainabilityJobInputProperty	Inputs for the model explainability job.
modelExplainabilityJobOutputConfig	IResolvable | MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
roleArn	string	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
endpointName?	string	The name of the endpoint used to run the monitoring job.
jobDefinitionName?	string	The name of the model explainability job definition.
modelExplainabilityBaselineConfig?	IResolvable | ModelExplainabilityBaselineConfigProperty	The baseline configuration for a model explainability job.
networkConfig?	IResolvable | NetworkConfigProperty	Networking options for a model explainability job.
stoppingCondition?	IResolvable | StoppingConditionProperty	A time limit for how long the monitoring job is allowed to run before stopping.
tagsRaw?	CfnTag[]	An array of key-value pairs to apply to this resource.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrCreationTime

Type: string

The time when the job definition was created.

---

attrJobDefinitionArn

Type: string

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

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

jobResources

Type: IResolvable | MonitoringResourcesProperty

Identifies the resources to deploy for a monitoring job.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

modelExplainabilityAppSpecification

Type: IResolvable | ModelExplainabilityAppSpecificationProperty

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

---

modelExplainabilityJobInput

Type: IResolvable | ModelExplainabilityJobInputProperty

Inputs for the model explainability job.

---

modelExplainabilityJobOutputConfig

Type: IResolvable | MonitoringOutputConfigProperty

The output configuration for monitoring jobs.

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

roleArn

Type: string

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

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

endpointName?

Type: string (optional)

The name of the endpoint used to run the monitoring job.

---

jobDefinitionName?

Type: string (optional)

The name of the model explainability job definition.

---

modelExplainabilityBaselineConfig?

Type: IResolvable | ModelExplainabilityBaselineConfigProperty (optional)

The baseline configuration for a model explainability job.

---

networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Networking options for a model explainability job.

---

stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

A time limit for how long the monitoring job is allowed to run before stopping.

---

tagsRaw?

Type: CfnTag[] (optional)

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

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }