Package software.amazon.awscdk.services.sagemaker

Class CfnMonitoringSchedule

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.CfnMonitoringSchedule

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:09.484Z")
@Stability(Stable)
public class CfnMonitoringSchedule
extends CfnResource
implements IInspectable, ITaggable

The AWS::SageMaker::MonitoringSchedule resource is an Amazon SageMaker resource type that regularly starts SageMaker processing Jobs to monitor the data captured for a SageMaker endpoint.

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.*;
 CfnMonitoringSchedule cfnMonitoringSchedule = CfnMonitoringSchedule.Builder.create(this, "MyCfnMonitoringSchedule")
         .monitoringScheduleConfig(MonitoringScheduleConfigProperty.builder()
                 .monitoringJobDefinition(MonitoringJobDefinitionProperty.builder()
                         .monitoringAppSpecification(MonitoringAppSpecificationProperty.builder()
                                 .imageUri("imageUri")
                                 // the properties below are optional
                                 .containerArguments(List.of("containerArguments"))
                                 .containerEntrypoint(List.of("containerEntrypoint"))
                                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                                 .build())
                         .monitoringInputs(List.of(MonitoringInputProperty.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
                                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                                         .s3DataDistributionType("s3DataDistributionType")
                                         .s3InputMode("s3InputMode")
                                         .build())
                                 .endpointInput(EndpointInputProperty.builder()
                                         .endpointName("endpointName")
                                         .localPath("localPath")
                                         // the properties below are optional
                                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                                         .s3DataDistributionType("s3DataDistributionType")
                                         .s3InputMode("s3InputMode")
                                         .build())
                                 .build()))
                         .monitoringOutputConfig(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())
                         .monitoringResources(MonitoringResourcesProperty.builder()
                                 .clusterConfig(ClusterConfigProperty.builder()
                                         .instanceCount(123)
                                         .instanceType("instanceType")
                                         .volumeSizeInGb(123)
                                         // the properties below are optional
                                         .volumeKmsKeyId("volumeKmsKeyId")
                                         .build())
                                 .build())
                         .roleArn("roleArn")
                         // the properties below are optional
                         .baselineConfig(BaselineConfigProperty.builder()
                                 .constraintsResource(ConstraintsResourceProperty.builder()
                                         .s3Uri("s3Uri")
                                         .build())
                                 .statisticsResource(StatisticsResourceProperty.builder()
                                         .s3Uri("s3Uri")
                                         .build())
                                 .build())
                         .environment(Map.of(
                                 "environmentKey", "environment"))
                         .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())
                         .build())
                 .monitoringJobDefinitionName("monitoringJobDefinitionName")
                 .monitoringType("monitoringType")
                 .scheduleConfig(ScheduleConfigProperty.builder()
                         .scheduleExpression("scheduleExpression")
                         // the properties below are optional
                         .dataAnalysisEndTime("dataAnalysisEndTime")
                         .dataAnalysisStartTime("dataAnalysisStartTime")
                         .build())
                 .build())
         .monitoringScheduleName("monitoringScheduleName")
         // the properties below are optional
         .endpointName("endpointName")
         .failureReason("failureReason")
         .lastMonitoringExecutionSummary(MonitoringExecutionSummaryProperty.builder()
                 .creationTime("creationTime")
                 .lastModifiedTime("lastModifiedTime")
                 .monitoringExecutionStatus("monitoringExecutionStatus")
                 .monitoringScheduleName("monitoringScheduleName")
                 .scheduledTime("scheduledTime")
                 // the properties below are optional
                 .endpointName("endpointName")
                 .failureReason("failureReason")
                 .processingJobArn("processingJobArn")
                 .build())
         .monitoringScheduleStatus("monitoringScheduleStatus")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnMonitoringSchedule.BaselineConfigProperty	Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
static interface	CfnMonitoringSchedule.BatchTransformInputProperty	Input object for the batch transform job.
static final class	CfnMonitoringSchedule.Builder	A fluent builder for CfnMonitoringSchedule.
static interface	CfnMonitoringSchedule.ClusterConfigProperty	Configuration for the cluster used to run model monitoring jobs.
static interface	CfnMonitoringSchedule.ConstraintsResourceProperty	The Amazon S3 URI for the constraints resource.
static interface	CfnMonitoringSchedule.CsvProperty	The CSV format.
static interface	CfnMonitoringSchedule.DatasetFormatProperty	The dataset format of the data to monitor.
static interface	CfnMonitoringSchedule.EndpointInputProperty	Input object for the endpoint.
static interface	CfnMonitoringSchedule.JsonProperty	The Json format.
static interface	CfnMonitoringSchedule.MonitoringAppSpecificationProperty	Container image configuration object for the monitoring job.
static interface	CfnMonitoringSchedule.MonitoringExecutionSummaryProperty	Summary of information about the last monitoring job to run.
static interface	CfnMonitoringSchedule.MonitoringInputProperty	The inputs for a monitoring job.
static interface	CfnMonitoringSchedule.MonitoringJobDefinitionProperty	Defines the monitoring job.
static interface	CfnMonitoringSchedule.MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
static interface	CfnMonitoringSchedule.MonitoringOutputProperty	The output object for a monitoring job.
static interface	CfnMonitoringSchedule.MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
static interface	CfnMonitoringSchedule.MonitoringScheduleConfigProperty	Configures the monitoring schedule and defines the monitoring job.
static interface	CfnMonitoringSchedule.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	CfnMonitoringSchedule.S3OutputProperty	Information about where and how you want to store the results of a monitoring job.
static interface	CfnMonitoringSchedule.ScheduleConfigProperty	Configuration details about the monitoring schedule.
static interface	CfnMonitoringSchedule.StatisticsResourceProperty	The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
static interface	CfnMonitoringSchedule.StoppingConditionProperty	Specifies a limit to how long a model training job or model compilation job can run.
static interface	CfnMonitoringSchedule.VpcConfigProperty	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

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnMonitoringSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMonitoringSchedule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnMonitoringSchedule(software.constructs.Construct scope, String id, CfnMonitoringScheduleProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreationTime()	The time when the monitoring schedule was created.
String	getAttrLastModifiedTime()	The last time that the monitoring schedule was modified.
String	getAttrMonitoringScheduleArn()	The Amazon Resource Name (ARN) of the monitoring schedule.
protected Map<String,Object>	getCfnProperties()
String	getEndpointName()	The name of the endpoint using the monitoring schedule.
String	getFailureReason()	Contains the reason a monitoring job failed, if it failed.
Object	getLastMonitoringExecutionSummary()	Describes metadata on the last execution to run, if there was one.
Object	getMonitoringScheduleConfig()	The configuration object that specifies the monitoring schedule and defines the monitoring job.
String	getMonitoringScheduleName()	The name of the monitoring schedule.
String	getMonitoringScheduleStatus()	The status of the monitoring schedule.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEndpointName(String value)	The name of the endpoint using the monitoring schedule.
void	setFailureReason(String value)	Contains the reason a monitoring job failed, if it failed.
void	setLastMonitoringExecutionSummary(IResolvable value)	Describes metadata on the last execution to run, if there was one.
void	setLastMonitoringExecutionSummary(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty value)	Describes metadata on the last execution to run, if there was one.
void	setMonitoringScheduleConfig(IResolvable value)	The configuration object that specifies the monitoring schedule and defines the monitoring job.
void	setMonitoringScheduleConfig(CfnMonitoringSchedule.MonitoringScheduleConfigProperty value)	The configuration object that specifies the monitoring schedule and defines the monitoring job.
void	setMonitoringScheduleName(String value)	The name of the monitoring schedule.
void	setMonitoringScheduleStatus(String value)	The status of the monitoring schedule.
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

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnMonitoringSchedule

protected CfnMonitoringSchedule(software.amazon.jsii.JsiiObjectRef objRef)

CfnMonitoringSchedule

protected CfnMonitoringSchedule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMonitoringSchedule

@Stability(Stable)
public CfnMonitoringSchedule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnMonitoringScheduleProps 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

@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 monitoring schedule was created.

getAttrLastModifiedTime

@Stability(Stable)
@NotNull
public String getAttrLastModifiedTime()

The last time that the monitoring schedule was modified.

getAttrMonitoringScheduleArn

@Stability(Stable)
@NotNull
public String getAttrMonitoringScheduleArn()

The Amazon Resource Name (ARN) of the monitoring schedule.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getMonitoringScheduleConfig

@Stability(Stable)
@NotNull
public Object getMonitoringScheduleConfig()

The configuration object that specifies the monitoring schedule and defines the monitoring job.

setMonitoringScheduleConfig

@Stability(Stable)
public void setMonitoringScheduleConfig(@NotNull
 IResolvable value)

The configuration object that specifies the monitoring schedule and defines the monitoring job.

setMonitoringScheduleConfig

@Stability(Stable)
public void setMonitoringScheduleConfig(@NotNull
 CfnMonitoringSchedule.MonitoringScheduleConfigProperty value)

The configuration object that specifies the monitoring schedule and defines the monitoring job.

getMonitoringScheduleName

@Stability(Stable)
@NotNull
public String getMonitoringScheduleName()

The name of the monitoring schedule.

setMonitoringScheduleName

@Stability(Stable)
public void setMonitoringScheduleName(@NotNull
 String value)

The name of the monitoring schedule.

getEndpointName

@Stability(Stable)
@Nullable
public String getEndpointName()

The name of the endpoint using the monitoring schedule.

setEndpointName

@Stability(Stable)
public void setEndpointName(@Nullable
 String value)

The name of the endpoint using the monitoring schedule.

getFailureReason

@Stability(Stable)
@Nullable
public String getFailureReason()

Contains the reason a monitoring job failed, if it failed.

setFailureReason

@Stability(Stable)
public void setFailureReason(@Nullable
 String value)

Contains the reason a monitoring job failed, if it failed.

getLastMonitoringExecutionSummary

@Stability(Stable)
@Nullable
public Object getLastMonitoringExecutionSummary()

Describes metadata on the last execution to run, if there was one.

setLastMonitoringExecutionSummary

@Stability(Stable)
public void setLastMonitoringExecutionSummary(@Nullable
 IResolvable value)

Describes metadata on the last execution to run, if there was one.

setLastMonitoringExecutionSummary

@Stability(Stable)
public void setLastMonitoringExecutionSummary(@Nullable
 CfnMonitoringSchedule.MonitoringExecutionSummaryProperty value)

Describes metadata on the last execution to run, if there was one.

getMonitoringScheduleStatus

@Stability(Stable)
@Nullable
public String getMonitoringScheduleStatus()

The status of the monitoring schedule.

setMonitoringScheduleStatus

@Stability(Stable)
public void setMonitoringScheduleStatus(@Nullable
 String value)

The status of the monitoring schedule.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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