software.amazon.awscdk.services.sagemaker

Class CfnMonitoringSchedule

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.923Z")
public class CfnMonitoringSchedule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::MonitoringSchedule`.

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.*;
 Object json;
 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(json)
                                                 .parquet(false)
                                                 .build())
                                         .localPath("localPath")
                                         // the properties below are optional
                                         .s3DataDistributionType("s3DataDistributionType")
                                         .s3InputMode("s3InputMode")
                                         .build())
                                 .endpointInput(EndpointInputProperty.builder()
                                         .endpointName("endpointName")
                                         .localPath("localPath")
                                         // the properties below are optional
                                         .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")
                         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnMonitoringSchedule.BaselineConfigProperty Baseline configuration used to validate that the data conforms to the specified constraints and statistics.
static interface	CfnMonitoringSchedule.BatchTransformInputProperty Example:
static 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 Example:
static interface	CfnMonitoringSchedule.DatasetFormatProperty Example:
static interface	CfnMonitoringSchedule.EndpointInputProperty Input object for the endpoint.
static interface	CfnMonitoringSchedule.JsonProperty Example:
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 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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrCreationTime() The time when the monitoring schedule was created.
java.lang.String	getAttrLastModifiedTime() The last time that the monitoring schedule was modified.
java.lang.String	getAttrMonitoringScheduleArn() The Amazon Resource Name (ARN) of the monitoring schedule.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEndpointName() The name of the endpoint using the monitoring schedule.
java.lang.String	getFailureReason() Contains the reason a monitoring job failed, if it failed.
java.lang.Object	getLastMonitoringExecutionSummary() Describes metadata on the last execution to run, if there was one.
java.lang.Object	getMonitoringScheduleConfig() The configuration object that specifies the monitoring schedule and defines the monitoring job.
java.lang.String	getMonitoringScheduleName() The name of the monitoring schedule.
java.lang.String	getMonitoringScheduleStatus() The status of the monitoring schedule.
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) The name of the endpoint using the monitoring schedule.
void	setFailureReason(java.lang.String value) Contains the reason a monitoring job failed, if it failed.
void	setLastMonitoringExecutionSummary(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty value) Describes metadata on the last execution to run, if there was one.
void	setLastMonitoringExecutionSummary(IResolvable value) Describes metadata on the last execution to run, if there was one.
void	setMonitoringScheduleConfig(CfnMonitoringSchedule.MonitoringScheduleConfigProperty value) The configuration object that specifies the monitoring schedule and defines the monitoring job.
void	setMonitoringScheduleConfig(IResolvable value) The configuration object that specifies the monitoring schedule and defines the monitoring job.
void	setMonitoringScheduleName(java.lang.String value) The name of the monitoring schedule.
void	setMonitoringScheduleStatus(java.lang.String value) The status of the monitoring schedule.

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

CfnMonitoringSchedule

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

CfnMonitoringSchedule

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

CfnMonitoringSchedule

public CfnMonitoringSchedule(Construct scope,
                             java.lang.String id,
                             CfnMonitoringScheduleProps props)

Create a new `AWS::SageMaker::MonitoringSchedule`.

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

getAttrLastModifiedTime

public java.lang.String getAttrLastModifiedTime()

The last time that the monitoring schedule was modified.

getAttrMonitoringScheduleArn

public java.lang.String getAttrMonitoringScheduleArn()

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

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 .

getMonitoringScheduleConfig

public java.lang.Object getMonitoringScheduleConfig()

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

setMonitoringScheduleConfig

public void setMonitoringScheduleConfig(IResolvable value)

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

setMonitoringScheduleConfig

public void setMonitoringScheduleConfig(CfnMonitoringSchedule.MonitoringScheduleConfigProperty value)

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

getMonitoringScheduleName

public java.lang.String getMonitoringScheduleName()

The name of the monitoring schedule.

setMonitoringScheduleName

public void setMonitoringScheduleName(java.lang.String value)

The name of the monitoring schedule.

getEndpointName

public java.lang.String getEndpointName()

The name of the endpoint using the monitoring schedule.

setEndpointName

public void setEndpointName(java.lang.String value)

The name of the endpoint using the monitoring schedule.

getFailureReason

public java.lang.String getFailureReason()

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

setFailureReason

public void setFailureReason(java.lang.String value)

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

getLastMonitoringExecutionSummary

public java.lang.Object getLastMonitoringExecutionSummary()

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

setLastMonitoringExecutionSummary

public void setLastMonitoringExecutionSummary(IResolvable value)

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

setLastMonitoringExecutionSummary

public void setLastMonitoringExecutionSummary(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty value)

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

getMonitoringScheduleStatus

public java.lang.String getMonitoringScheduleStatus()

The status of the monitoring schedule.

setMonitoringScheduleStatus

public void setMonitoringScheduleStatus(java.lang.String value)

The status of the monitoring schedule.