io.cloudshiftdev.awscdk.services.sagemaker.CfnMonitoringScheduleProps.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.sagemaker
import io.cloudshiftdev.awscdk.CfnTag
import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Any
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Properties for defining a `CfnMonitoringSchedule`.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import io.cloudshiftdev.awscdk.services.sagemaker.*;
* CfnMonitoringScheduleProps cfnMonitoringScheduleProps = CfnMonitoringScheduleProps.builder()
* .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();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html)
*/
public interface CfnMonitoringScheduleProps {
/**
* The name of the endpoint using the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-endpointname)
*/
public fun endpointName(): String? = unwrap(this).getEndpointName()
/**
* Contains the reason a monitoring job failed, if it failed.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-failurereason)
*/
public fun failureReason(): String? = unwrap(this).getFailureReason()
/**
* Describes metadata on the last execution to run, if there was one.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmonitoringexecutionsummary)
*/
public fun lastMonitoringExecutionSummary(): Any? =
unwrap(this).getLastMonitoringExecutionSummary()
/**
* The configuration object that specifies the monitoring schedule and defines the monitoring job.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig)
*/
public fun monitoringScheduleConfig(): Any
/**
* The name of the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulename)
*/
public fun monitoringScheduleName(): String
/**
* The status of the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulestatus)
*/
public fun monitoringScheduleStatus(): String? = unwrap(this).getMonitoringScheduleStatus()
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-tags)
*/
public fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
/**
* A builder for [CfnMonitoringScheduleProps]
*/
@CdkDslMarker
public interface Builder {
/**
* @param endpointName The name of the endpoint using the monitoring schedule.
*/
public fun endpointName(endpointName: String)
/**
* @param failureReason Contains the reason a monitoring job failed, if it failed.
*/
public fun failureReason(failureReason: String)
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
public fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: IResolvable)
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
public
fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: CfnMonitoringSchedule.MonitoringExecutionSummaryProperty)
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("c2d08bb4c8aa064d223e516318fba4d25788aa648ec443915bbe4229e9e5cd83")
public
fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: CfnMonitoringSchedule.MonitoringExecutionSummaryProperty.Builder.() -> Unit)
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
public fun monitoringScheduleConfig(monitoringScheduleConfig: IResolvable)
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
public
fun monitoringScheduleConfig(monitoringScheduleConfig: CfnMonitoringSchedule.MonitoringScheduleConfigProperty)
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("165b14835ca4d684e02d832ac339b397888bb75b493586caa3a70ac6ce8e399a")
public
fun monitoringScheduleConfig(monitoringScheduleConfig: CfnMonitoringSchedule.MonitoringScheduleConfigProperty.Builder.() -> Unit)
/**
* @param monitoringScheduleName The name of the monitoring schedule.
*/
public fun monitoringScheduleName(monitoringScheduleName: String)
/**
* @param monitoringScheduleStatus The status of the monitoring schedule.
*/
public fun monitoringScheduleStatus(monitoringScheduleStatus: String)
/**
* @param tags An array of key-value pairs to apply to this resource.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
public fun tags(tags: List)
/**
* @param tags An array of key-value pairs to apply to this resource.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
public fun tags(vararg tags: CfnTag)
}
private class BuilderImpl : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps.Builder =
software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps.builder()
/**
* @param endpointName The name of the endpoint using the monitoring schedule.
*/
override fun endpointName(endpointName: String) {
cdkBuilder.endpointName(endpointName)
}
/**
* @param failureReason Contains the reason a monitoring job failed, if it failed.
*/
override fun failureReason(failureReason: String) {
cdkBuilder.failureReason(failureReason)
}
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
override fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: IResolvable) {
cdkBuilder.lastMonitoringExecutionSummary(lastMonitoringExecutionSummary.let(IResolvable.Companion::unwrap))
}
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
override
fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: CfnMonitoringSchedule.MonitoringExecutionSummaryProperty) {
cdkBuilder.lastMonitoringExecutionSummary(lastMonitoringExecutionSummary.let(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty.Companion::unwrap))
}
/**
* @param lastMonitoringExecutionSummary Describes metadata on the last execution to run, if
* there was one.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("c2d08bb4c8aa064d223e516318fba4d25788aa648ec443915bbe4229e9e5cd83")
override
fun lastMonitoringExecutionSummary(lastMonitoringExecutionSummary: CfnMonitoringSchedule.MonitoringExecutionSummaryProperty.Builder.() -> Unit):
Unit =
lastMonitoringExecutionSummary(CfnMonitoringSchedule.MonitoringExecutionSummaryProperty(lastMonitoringExecutionSummary))
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
override fun monitoringScheduleConfig(monitoringScheduleConfig: IResolvable) {
cdkBuilder.monitoringScheduleConfig(monitoringScheduleConfig.let(IResolvable.Companion::unwrap))
}
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
override
fun monitoringScheduleConfig(monitoringScheduleConfig: CfnMonitoringSchedule.MonitoringScheduleConfigProperty) {
cdkBuilder.monitoringScheduleConfig(monitoringScheduleConfig.let(CfnMonitoringSchedule.MonitoringScheduleConfigProperty.Companion::unwrap))
}
/**
* @param monitoringScheduleConfig The configuration object that specifies the monitoring
* schedule and defines the monitoring job.
*/
@kotlin.Suppress("INAPPLICABLE_JVM_NAME")
@JvmName("165b14835ca4d684e02d832ac339b397888bb75b493586caa3a70ac6ce8e399a")
override
fun monitoringScheduleConfig(monitoringScheduleConfig: CfnMonitoringSchedule.MonitoringScheduleConfigProperty.Builder.() -> Unit):
Unit =
monitoringScheduleConfig(CfnMonitoringSchedule.MonitoringScheduleConfigProperty(monitoringScheduleConfig))
/**
* @param monitoringScheduleName The name of the monitoring schedule.
*/
override fun monitoringScheduleName(monitoringScheduleName: String) {
cdkBuilder.monitoringScheduleName(monitoringScheduleName)
}
/**
* @param monitoringScheduleStatus The status of the monitoring schedule.
*/
override fun monitoringScheduleStatus(monitoringScheduleStatus: String) {
cdkBuilder.monitoringScheduleStatus(monitoringScheduleStatus)
}
/**
* @param tags An array of key-value pairs to apply to this resource.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
override fun tags(tags: List) {
cdkBuilder.tags(tags.map(CfnTag.Companion::unwrap))
}
/**
* @param tags An array of key-value pairs to apply to this resource.
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*/
override fun tags(vararg tags: CfnTag): Unit = tags(tags.toList())
public fun build(): software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps =
cdkBuilder.build()
}
private class Wrapper(
cdkObject: software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps,
) : CdkObject(cdkObject),
CfnMonitoringScheduleProps {
/**
* The name of the endpoint using the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-endpointname)
*/
override fun endpointName(): String? = unwrap(this).getEndpointName()
/**
* Contains the reason a monitoring job failed, if it failed.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-failurereason)
*/
override fun failureReason(): String? = unwrap(this).getFailureReason()
/**
* Describes metadata on the last execution to run, if there was one.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmonitoringexecutionsummary)
*/
override fun lastMonitoringExecutionSummary(): Any? =
unwrap(this).getLastMonitoringExecutionSummary()
/**
* The configuration object that specifies the monitoring schedule and defines the monitoring
* job.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig)
*/
override fun monitoringScheduleConfig(): Any = unwrap(this).getMonitoringScheduleConfig()
/**
* The name of the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulename)
*/
override fun monitoringScheduleName(): String = unwrap(this).getMonitoringScheduleName()
/**
* The status of the monitoring schedule.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulestatus)
*/
override fun monitoringScheduleStatus(): String? = unwrap(this).getMonitoringScheduleStatus()
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-tags)
*/
override fun tags(): List = unwrap(this).getTags()?.map(CfnTag::wrap) ?: emptyList()
}
public companion object {
public operator fun invoke(block: Builder.() -> Unit = {}): CfnMonitoringScheduleProps {
val builderImpl = BuilderImpl()
return Wrapper(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps):
CfnMonitoringScheduleProps = CdkObjectWrappers.wrap(cdkObject) as?
CfnMonitoringScheduleProps ?: Wrapper(cdkObject)
internal fun unwrap(wrapped: CfnMonitoringScheduleProps):
software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps = (wrapped as
CdkObject).cdkObject as software.amazon.awscdk.services.sagemaker.CfnMonitoringScheduleProps
}
}