Class CfnModelExplainabilityJobDefinition
A CloudFormation AWS::SageMaker::ModelExplainabilityJobDefinition
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnModelExplainabilityJobDefinition : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnModelExplainabilityJobDefinition
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates the definition for a model explainability job.
CloudformationResource: AWS::SageMaker::ModelExplainabilityJobDefinition
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var json;
var cfnModelExplainabilityJobDefinition = new CfnModelExplainabilityJobDefinition(this, "MyCfnModelExplainabilityJobDefinition", new CfnModelExplainabilityJobDefinitionProps {
JobResources = new MonitoringResourcesProperty {
ClusterConfig = new ClusterConfigProperty {
InstanceCount = 123,
InstanceType = "instanceType",
VolumeSizeInGb = 123,
// the properties below are optional
VolumeKmsKeyId = "volumeKmsKeyId"
}
},
ModelExplainabilityAppSpecification = new ModelExplainabilityAppSpecificationProperty {
ConfigUri = "configUri",
ImageUri = "imageUri",
// the properties below are optional
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
}
},
ModelExplainabilityJobInput = new ModelExplainabilityJobInputProperty {
BatchTransformInput = new BatchTransformInputProperty {
DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
DatasetFormat = new DatasetFormatProperty {
Csv = new CsvProperty {
Header = false
},
Json = json,
Parquet = false
},
LocalPath = "localPath",
// the properties below are optional
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
},
EndpointInput = new EndpointInputProperty {
EndpointName = "endpointName",
LocalPath = "localPath",
// the properties below are optional
FeaturesAttribute = "featuresAttribute",
InferenceAttribute = "inferenceAttribute",
ProbabilityAttribute = "probabilityAttribute",
S3DataDistributionType = "s3DataDistributionType",
S3InputMode = "s3InputMode"
}
},
ModelExplainabilityJobOutputConfig = new MonitoringOutputConfigProperty {
MonitoringOutputs = new [] { new MonitoringOutputProperty {
S3Output = new S3OutputProperty {
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 = new ModelExplainabilityBaselineConfigProperty {
BaseliningJobName = "baseliningJobName",
ConstraintsResource = new ConstraintsResourceProperty {
S3Uri = "s3Uri"
}
},
NetworkConfig = new NetworkConfigProperty {
EnableInterContainerTrafficEncryption = false,
EnableNetworkIsolation = false,
VpcConfig = new VpcConfigProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
Subnets = new [] { "subnets" }
}
},
StoppingCondition = new StoppingConditionProperty {
MaxRuntimeInSeconds = 123
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnModelExplainabilityJobDefinition(Construct, String, ICfnModelExplainabilityJobDefinitionProps) | Create a new |
CfnModelExplainabilityJobDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnModelExplainabilityJobDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrCreationTime | The time when the job definition was created. |
AttrJobDefinitionArn | The Amazon Resource Name (ARN) of the job definition. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EndpointName |
|
JobDefinitionName | The name of the model explainability job definition. |
JobResources | Identifies the resources to deploy for a monitoring job. |
ModelExplainabilityAppSpecification | Configures the model explainability job to run a specified Docker container image. |
ModelExplainabilityBaselineConfig | The baseline configuration for a model explainability job. |
ModelExplainabilityJobInput | Inputs for the model explainability job. |
ModelExplainabilityJobOutputConfig | The output configuration for monitoring jobs. |
NetworkConfig | Networking options for a model explainability job. |
RoleArn | The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf. |
StoppingCondition | A time limit for how long the monitoring job is allowed to run before stopping. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnModelExplainabilityJobDefinition(Construct, String, ICfnModelExplainabilityJobDefinitionProps)
Create a new AWS::SageMaker::ModelExplainabilityJobDefinition
.
public CfnModelExplainabilityJobDefinition(Construct scope, string id, ICfnModelExplainabilityJobDefinitionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnModelExplainabilityJobDefinitionProps
- resource properties.
CfnModelExplainabilityJobDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnModelExplainabilityJobDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnModelExplainabilityJobDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnModelExplainabilityJobDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrCreationTime
The time when the job definition was created.
public virtual string AttrCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationTime
AttrJobDefinitionArn
The Amazon Resource Name (ARN) of the job definition.
public virtual string AttrJobDefinitionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: JobDefinitionArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EndpointName
AWS::SageMaker::ModelExplainabilityJobDefinition.EndpointName
.
public virtual string EndpointName { get; set; }
Property Value
System.String
Remarks
JobDefinitionName
The name of the model explainability job definition.
public virtual string JobDefinitionName { get; set; }
Property Value
System.String
Remarks
The name must be unique within an AWS Region in the AWS account.
JobResources
Identifies the resources to deploy for a monitoring job.
public virtual object JobResources { get; set; }
Property Value
System.Object
Remarks
ModelExplainabilityAppSpecification
Configures the model explainability job to run a specified Docker container image.
public virtual object ModelExplainabilityAppSpecification { get; set; }
Property Value
System.Object
Remarks
ModelExplainabilityBaselineConfig
The baseline configuration for a model explainability job.
public virtual object ModelExplainabilityBaselineConfig { get; set; }
Property Value
System.Object
Remarks
ModelExplainabilityJobInput
Inputs for the model explainability job.
public virtual object ModelExplainabilityJobInput { get; set; }
Property Value
System.Object
Remarks
ModelExplainabilityJobOutputConfig
The output configuration for monitoring jobs.
public virtual object ModelExplainabilityJobOutputConfig { get; set; }
Property Value
System.Object
Remarks
NetworkConfig
Networking options for a model explainability job.
public virtual object NetworkConfig { get; set; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
StoppingCondition
A time limit for how long the monitoring job is allowed to run before stopping.
public virtual object StoppingCondition { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>