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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.837Z")
 @Stability(value=Stable)
public class CfnMonitoringSchedule
extends CfnResource
implements IInspectable

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

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()
                                 .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 Example:
static class	CfnMonitoringSchedule.Builder A fluent builder for CfnMonitoringSchedule.
static interface	CfnMonitoringSchedule.ClusterConfigProperty Example:
static interface	CfnMonitoringSchedule.ConstraintsResourceProperty Example:
static interface	CfnMonitoringSchedule.EndpointInputProperty Example:
static interface	CfnMonitoringSchedule.MonitoringAppSpecificationProperty Example:
static interface	CfnMonitoringSchedule.MonitoringExecutionSummaryProperty Example:
static interface	CfnMonitoringSchedule.MonitoringInputProperty Example:
static interface	CfnMonitoringSchedule.MonitoringJobDefinitionProperty Example:
static interface	CfnMonitoringSchedule.MonitoringOutputConfigProperty Example:
static interface	CfnMonitoringSchedule.MonitoringOutputProperty Example:
static interface	CfnMonitoringSchedule.MonitoringResourcesProperty Example:
static interface	CfnMonitoringSchedule.MonitoringScheduleConfigProperty Example:
static interface	CfnMonitoringSchedule.NetworkConfigProperty Example:
static interface	CfnMonitoringSchedule.S3OutputProperty Example:
static interface	CfnMonitoringSchedule.ScheduleConfigProperty Example:
static interface	CfnMonitoringSchedule.StatisticsResourceProperty Example:
static interface	CfnMonitoringSchedule.StoppingConditionProperty Example:
static interface	CfnMonitoringSchedule.VpcConfigProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMonitoringSchedule(software.constructs.Construct scope, 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
String	getAttrCreationTime()
String	getAttrLastModifiedTime()
String	getAttrMonitoringScheduleArn()
protected Map<String,Object>	getCfnProperties()
String	getEndpointName() `AWS::SageMaker::MonitoringSchedule.EndpointName`.
String	getFailureReason() `AWS::SageMaker::MonitoringSchedule.FailureReason`.
Object	getLastMonitoringExecutionSummary() `AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.
Object	getMonitoringScheduleConfig() `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.
String	getMonitoringScheduleName() `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleName`.
String	getMonitoringScheduleStatus() `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleStatus`.
TagManager	getTags() `AWS::SageMaker::MonitoringSchedule.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEndpointName(String value) `AWS::SageMaker::MonitoringSchedule.EndpointName`.
void	setFailureReason(String value) `AWS::SageMaker::MonitoringSchedule.FailureReason`.
void	setLastMonitoringExecutionSummary(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty value) `AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.
void	setLastMonitoringExecutionSummary(IResolvable value) `AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.
void	setMonitoringScheduleConfig(CfnMonitoringSchedule.MonitoringScheduleConfigProperty value) `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.
void	setMonitoringScheduleConfig(IResolvable value) `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.
void	setMonitoringScheduleName(String value) `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleName`.
void	setMonitoringScheduleStatus(String value) `AWS::SageMaker::MonitoringSchedule.MonitoringScheduleStatus`.

Methods inherited from class software.amazon.awscdk.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.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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCreationTime()

getAttrLastModifiedTime

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

getAttrMonitoringScheduleArn

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getEndpointName

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

`AWS::SageMaker::MonitoringSchedule.EndpointName`.

setEndpointName

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

`AWS::SageMaker::MonitoringSchedule.EndpointName`.

getFailureReason

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

`AWS::SageMaker::MonitoringSchedule.FailureReason`.

setFailureReason

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

`AWS::SageMaker::MonitoringSchedule.FailureReason`.

getLastMonitoringExecutionSummary

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

`AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.

setLastMonitoringExecutionSummary

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

`AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.

setLastMonitoringExecutionSummary

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

`AWS::SageMaker::MonitoringSchedule.LastMonitoringExecutionSummary`.

getMonitoringScheduleConfig

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.

setMonitoringScheduleConfig

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.

setMonitoringScheduleConfig

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleConfig`.

getMonitoringScheduleName

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleName`.

setMonitoringScheduleName

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleName`.

getMonitoringScheduleStatus

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleStatus`.

setMonitoringScheduleStatus

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

`AWS::SageMaker::MonitoringSchedule.MonitoringScheduleStatus`.

getTags

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

`AWS::SageMaker::MonitoringSchedule.Tags`.