CfnModelBiasJobDefinition

java.lang.Object
- 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.CfnModelBiasJobDefinition

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:18.942Z")
public class CfnModelBiasJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::ModelBiasJobDefinition`.

Creates the definition for a model bias 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;
 CfnModelBiasJobDefinition cfnModelBiasJobDefinition = CfnModelBiasJobDefinition.Builder.create(this, "MyCfnModelBiasJobDefinition")
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .modelBiasAppSpecification(ModelBiasAppSpecificationProperty.builder()
                 .configUri("configUri")
                 .imageUri("imageUri")
                 // the properties below are optional
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .build())
         .modelBiasJobInput(ModelBiasJobInputProperty.builder()
                 .groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 // the properties below are optional
                 .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
                         .endTimeOffset("endTimeOffset")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .endTimeOffset("endTimeOffset")
                         .featuresAttribute("featuresAttribute")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .build())
         .modelBiasJobOutputConfig(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")
         .modelBiasBaselineConfig(ModelBiasBaselineConfigProperty.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 interface`	`CfnModelBiasJobDefinition.BatchTransformInputProperty` Example:
`static class`	`CfnModelBiasJobDefinition.Builder` A fluent builder for `CfnModelBiasJobDefinition`.
`static interface`	`CfnModelBiasJobDefinition.ClusterConfigProperty` The configuration for the cluster resources used to run the processing job.
`static interface`	`CfnModelBiasJobDefinition.ConstraintsResourceProperty` The constraints resource for a monitoring job.
`static interface`	`CfnModelBiasJobDefinition.CsvProperty` Example:
`static interface`	`CfnModelBiasJobDefinition.DatasetFormatProperty` Example:
`static interface`	`CfnModelBiasJobDefinition.EndpointInputProperty` Input object for the endpoint.
`static interface`	`CfnModelBiasJobDefinition.JsonProperty` Example:
`static interface`	`CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty` Docker container image configuration object for the model bias job.
`static interface`	`CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty` The configuration for a baseline model bias job.
`static interface`	`CfnModelBiasJobDefinition.ModelBiasJobInputProperty` Inputs for the model bias job.
`static interface`	`CfnModelBiasJobDefinition.MonitoringGroundTruthS3InputProperty` The ground truth labels for the dataset used for the monitoring job.
`static interface`	`CfnModelBiasJobDefinition.MonitoringOutputConfigProperty` The output configuration for monitoring jobs.
`static interface`	`CfnModelBiasJobDefinition.MonitoringOutputProperty` The output object for a monitoring job.
`static interface`	`CfnModelBiasJobDefinition.MonitoringResourcesProperty` Identifies the resources to deploy for a monitoring job.
`static interface`	`CfnModelBiasJobDefinition.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`	`CfnModelBiasJobDefinition.S3OutputProperty` The Amazon S3 storage location where the results of a monitoring job are saved.
`static interface`	`CfnModelBiasJobDefinition.StoppingConditionProperty` Specifies a limit to how long a model training job or model compilation job can run.
`static interface`	`CfnModelBiasJobDefinition.VpcConfigProperty` Specifies a VPC that your training jobs and hosted models have access to.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnModelBiasJobDefinition(Construct scope, java.lang.String id, CfnModelBiasJobDefinitionProps props)` Create a new `AWS::SageMaker::ModelBiasJobDefinition`.
`protected`	`CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrCreationTime()` The time when the job definition was created.
`java.lang.String`	`getAttrJobDefinitionArn()` The Amazon Resource Name (ARN) of the job definition.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getEndpointName()` `AWS::SageMaker::ModelBiasJobDefinition.EndpointName`.
`java.lang.String`	`getJobDefinitionName()` The name of the bias job definition.
`java.lang.Object`	`getJobResources()` Identifies the resources to deploy for a monitoring job.
`java.lang.Object`	`getModelBiasAppSpecification()` Configures the model bias job to run a specified Docker container image.
`java.lang.Object`	`getModelBiasBaselineConfig()` The baseline configuration for a model bias job.
`java.lang.Object`	`getModelBiasJobInput()` Inputs for the model bias job.
`java.lang.Object`	`getModelBiasJobOutputConfig()` The output configuration for monitoring jobs.
`java.lang.Object`	`getNetworkConfig()` Networking options for a model bias job.
`java.lang.String`	`getRoleArn()` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`java.lang.Object`	`getStoppingCondition()` A time limit for how long the monitoring job is allowed to run before stopping.
`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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setEndpointName(java.lang.String value)` `AWS::SageMaker::ModelBiasJobDefinition.EndpointName`.
`void`	`setJobDefinitionName(java.lang.String value)` The name of the bias job definition.
`void`	`setJobResources(CfnModelBiasJobDefinition.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`	`setModelBiasAppSpecification(CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty value)` Configures the model bias job to run a specified Docker container image.
`void`	`setModelBiasAppSpecification(IResolvable value)` Configures the model bias job to run a specified Docker container image.
`void`	`setModelBiasBaselineConfig(CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty value)` The baseline configuration for a model bias job.
`void`	`setModelBiasBaselineConfig(IResolvable value)` The baseline configuration for a model bias job.
`void`	`setModelBiasJobInput(CfnModelBiasJobDefinition.ModelBiasJobInputProperty value)` Inputs for the model bias job.
`void`	`setModelBiasJobInput(IResolvable value)` Inputs for the model bias job.
`void`	`setModelBiasJobOutputConfig(CfnModelBiasJobDefinition.MonitoringOutputConfigProperty value)` The output configuration for monitoring jobs.
`void`	`setModelBiasJobOutputConfig(IResolvable value)` The output configuration for monitoring jobs.
`void`	`setNetworkConfig(CfnModelBiasJobDefinition.NetworkConfigProperty value)` Networking options for a model bias job.
`void`	`setNetworkConfig(IResolvable value)` Networking options for a model bias job.
`void`	`setRoleArn(java.lang.String value)` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`void`	`setStoppingCondition(CfnModelBiasJobDefinition.StoppingConditionProperty value)` A time limit for how long the monitoring job is allowed to run before stopping.
`void`	`setStoppingCondition(IResolvable value)` A time limit for how long the monitoring job is allowed to run before stopping.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnModelBiasJobDefinition
```
protected CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnModelBiasJobDefinition
```
protected CfnModelBiasJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnModelBiasJobDefinition
```
public CfnModelBiasJobDefinition(Construct scope,
                                 java.lang.String id,
                                 CfnModelBiasJobDefinitionProps props)
```
    Create a new `AWS::SageMaker::ModelBiasJobDefinition`.
    
    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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrCreationTime
```
public java.lang.String getAttrCreationTime()
```
    The time when the job definition was created.
  - getAttrJobDefinitionArn
```
public java.lang.String getAttrJobDefinitionArn()
```
    The Amazon Resource Name (ARN) of the job definition.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - getJobResources
```
public java.lang.Object getJobResources()
```
    Identifies the resources to deploy for a monitoring job.
  - setJobResources
```
public void setJobResources(IResolvable value)
```
    Identifies the resources to deploy for a monitoring job.
  - setJobResources
```
public void setJobResources(CfnModelBiasJobDefinition.MonitoringResourcesProperty value)
```
    Identifies the resources to deploy for a monitoring job.
  - getModelBiasAppSpecification
```
public java.lang.Object getModelBiasAppSpecification()
```
    Configures the model bias job to run a specified Docker container image.
  - setModelBiasAppSpecification
```
public void setModelBiasAppSpecification(IResolvable value)
```
    Configures the model bias job to run a specified Docker container image.
  - setModelBiasAppSpecification
```
public void setModelBiasAppSpecification(CfnModelBiasJobDefinition.ModelBiasAppSpecificationProperty value)
```
    Configures the model bias job to run a specified Docker container image.
  - getModelBiasJobInput
```
public java.lang.Object getModelBiasJobInput()
```
    Inputs for the model bias job.
  - setModelBiasJobInput
```
public void setModelBiasJobInput(IResolvable value)
```
    Inputs for the model bias job.
  - setModelBiasJobInput
```
public void setModelBiasJobInput(CfnModelBiasJobDefinition.ModelBiasJobInputProperty value)
```
    Inputs for the model bias job.
  - getModelBiasJobOutputConfig
```
public java.lang.Object getModelBiasJobOutputConfig()
```
    The output configuration for monitoring jobs.
  - setModelBiasJobOutputConfig
```
public void setModelBiasJobOutputConfig(IResolvable value)
```
    The output configuration for monitoring jobs.
  - setModelBiasJobOutputConfig
```
public void setModelBiasJobOutputConfig(CfnModelBiasJobDefinition.MonitoringOutputConfigProperty value)
```
    The output configuration for monitoring jobs.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
  - getEndpointName
```
public java.lang.String getEndpointName()
```
    `AWS::SageMaker::ModelBiasJobDefinition.EndpointName`.
  - setEndpointName
```
public void setEndpointName(java.lang.String value)
```
    `AWS::SageMaker::ModelBiasJobDefinition.EndpointName`.
  - getJobDefinitionName
```
public java.lang.String getJobDefinitionName()
```
    The name of the bias job definition.
    The name must be unique within an AWS Region in the AWS account.
  - setJobDefinitionName
```
public void setJobDefinitionName(java.lang.String value)
```
    The name of the bias job definition.
    The name must be unique within an AWS Region in the AWS account.
  - getModelBiasBaselineConfig
```
public java.lang.Object getModelBiasBaselineConfig()
```
    The baseline configuration for a model bias job.
  - setModelBiasBaselineConfig
```
public void setModelBiasBaselineConfig(IResolvable value)
```
    The baseline configuration for a model bias job.
  - setModelBiasBaselineConfig
```
public void setModelBiasBaselineConfig(CfnModelBiasJobDefinition.ModelBiasBaselineConfigProperty value)
```
    The baseline configuration for a model bias job.
  - getNetworkConfig
```
public java.lang.Object getNetworkConfig()
```
    Networking options for a model bias job.
  - setNetworkConfig
```
public void setNetworkConfig(IResolvable value)
```
    Networking options for a model bias job.
  - setNetworkConfig
```
public void setNetworkConfig(CfnModelBiasJobDefinition.NetworkConfigProperty value)
```
    Networking options for a model bias job.
  - getStoppingCondition
```
public java.lang.Object getStoppingCondition()
```
    A time limit for how long the monitoring job is allowed to run before stopping.
  - setStoppingCondition
```
public void setStoppingCondition(IResolvable value)
```
    A time limit for how long the monitoring job is allowed to run before stopping.
  - setStoppingCondition
```
public void setStoppingCondition(CfnModelBiasJobDefinition.StoppingConditionProperty value)
```
    A time limit for how long the monitoring job is allowed to run before stopping.

Class CfnModelBiasJobDefinition

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnModelBiasJobDefinition

CfnModelBiasJobDefinition

CfnModelBiasJobDefinition

Method Detail

inspect

renderProperties

getAttrCreationTime

getAttrJobDefinitionArn

getCfnProperties

getTags

getJobResources

setJobResources

setJobResources

getModelBiasAppSpecification

setModelBiasAppSpecification

setModelBiasAppSpecification

getModelBiasJobInput

setModelBiasJobInput

setModelBiasJobInput

getModelBiasJobOutputConfig

setModelBiasJobOutputConfig

setModelBiasJobOutputConfig

getRoleArn

setRoleArn

getEndpointName

setEndpointName

getJobDefinitionName

setJobDefinitionName

getModelBiasBaselineConfig

setModelBiasBaselineConfig

setModelBiasBaselineConfig

getNetworkConfig

setNetworkConfig

setNetworkConfig

getStoppingCondition

setStoppingCondition

setStoppingCondition