Class CfnMonitoringScheduleProps

Properties for defining a CfnMonitoringSchedule.

Inheritance

object

CfnMonitoringScheduleProps

Implements

ICfnMonitoringScheduleProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMonitoringScheduleProps : ICfnMonitoringScheduleProps

Syntax (vb)

Public Class CfnMonitoringScheduleProps Implements ICfnMonitoringScheduleProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var cfnMonitoringScheduleProps = new CfnMonitoringScheduleProps {
                 MonitoringScheduleConfig = new MonitoringScheduleConfigProperty {
                     MonitoringJobDefinition = new MonitoringJobDefinitionProperty {
                         MonitoringAppSpecification = new MonitoringAppSpecificationProperty {
                             ImageUri = "imageUri",

                             // the properties below are optional
                             ContainerArguments = new [] { "containerArguments" },
                             ContainerEntrypoint = new [] { "containerEntrypoint" },
                             PostAnalyticsProcessorSourceUri = "postAnalyticsProcessorSourceUri",
                             RecordPreprocessorSourceUri = "recordPreprocessorSourceUri"
                         },
                         MonitoringInputs = new [] { new MonitoringInputProperty {
                             BatchTransformInput = new BatchTransformInputProperty {
                                 DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                                 DatasetFormat = new DatasetFormatProperty {
                                     Csv = new CsvProperty {
                                         Header = false
                                     },
                                     Json = new JsonProperty {
                                         Line = false
                                     },
                                     Parquet = false
                                 },
                                 LocalPath = "localPath",

                                 // the properties below are optional
                                 ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
                                 S3DataDistributionType = "s3DataDistributionType",
                                 S3InputMode = "s3InputMode"
                             },
                             EndpointInput = new EndpointInputProperty {
                                 EndpointName = "endpointName",
                                 LocalPath = "localPath",

                                 // the properties below are optional
                                 ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
                                 S3DataDistributionType = "s3DataDistributionType",
                                 S3InputMode = "s3InputMode"
                             }
                         } },
                         MonitoringOutputConfig = new MonitoringOutputConfigProperty {
                             MonitoringOutputs = new [] { new MonitoringOutputProperty {
                                 S3Output = new S3OutputProperty {
                                     LocalPath = "localPath",
                                     S3Uri = "s3Uri",

                                     // the properties below are optional
                                     S3UploadMode = "s3UploadMode"
                                 }
                             } },

                             // the properties below are optional
                             KmsKeyId = "kmsKeyId"
                         },
                         MonitoringResources = new MonitoringResourcesProperty {
                             ClusterConfig = new ClusterConfigProperty {
                                 InstanceCount = 123,
                                 InstanceType = "instanceType",
                                 VolumeSizeInGb = 123,

                                 // the properties below are optional
                                 VolumeKmsKeyId = "volumeKmsKeyId"
                             }
                         },
                         RoleArn = "roleArn",

                         // the properties below are optional
                         BaselineConfig = new BaselineConfigProperty {
                             ConstraintsResource = new ConstraintsResourceProperty {
                                 S3Uri = "s3Uri"
                             },
                             StatisticsResource = new StatisticsResourceProperty {
                                 S3Uri = "s3Uri"
                             }
                         },
                         Environment = new Dictionary<string, string> {
                             { "environmentKey", "environment" }
                         },
                         NetworkConfig = new NetworkConfigProperty {
                             EnableInterContainerTrafficEncryption = false,
                             EnableNetworkIsolation = false,
                             VpcConfig = new VpcConfigProperty {
                                 SecurityGroupIds = new [] { "securityGroupIds" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         StoppingCondition = new StoppingConditionProperty {
                             MaxRuntimeInSeconds = 123
                         }
                     },
                     MonitoringJobDefinitionName = "monitoringJobDefinitionName",
                     MonitoringType = "monitoringType",
                     ScheduleConfig = new ScheduleConfigProperty {
                         ScheduleExpression = "scheduleExpression",

                         // the properties below are optional
                         DataAnalysisEndTime = "dataAnalysisEndTime",
                         DataAnalysisStartTime = "dataAnalysisStartTime"
                     }
                 },
                 MonitoringScheduleName = "monitoringScheduleName",

                 // the properties below are optional
                 EndpointName = "endpointName",
                 FailureReason = "failureReason",
                 LastMonitoringExecutionSummary = new MonitoringExecutionSummaryProperty {
                     CreationTime = "creationTime",
                     LastModifiedTime = "lastModifiedTime",
                     MonitoringExecutionStatus = "monitoringExecutionStatus",
                     MonitoringScheduleName = "monitoringScheduleName",
                     ScheduledTime = "scheduledTime",

                     // the properties below are optional
                     EndpointName = "endpointName",
                     FailureReason = "failureReason",
                     ProcessingJobArn = "processingJobArn"
                 },
                 MonitoringScheduleStatus = "monitoringScheduleStatus",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnMonitoringScheduleProps()

Properties for defining a CfnMonitoringSchedule.

Properties

EndpointName	The name of the endpoint using the monitoring schedule.
FailureReason	Contains the reason a monitoring job failed, if it failed.
LastMonitoringExecutionSummary	Describes metadata on the last execution to run, if there was one.
MonitoringScheduleConfig	The configuration object that specifies the monitoring schedule and defines the monitoring job.
MonitoringScheduleName	The name of the monitoring schedule.
MonitoringScheduleStatus	The status of the monitoring schedule.
Tags	An array of key-value pairs to apply to this resource.

Constructors

CfnMonitoringScheduleProps()

Properties for defining a CfnMonitoringSchedule.

public CfnMonitoringScheduleProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Sagemaker;

             var cfnMonitoringScheduleProps = new CfnMonitoringScheduleProps {
                 MonitoringScheduleConfig = new MonitoringScheduleConfigProperty {
                     MonitoringJobDefinition = new MonitoringJobDefinitionProperty {
                         MonitoringAppSpecification = new MonitoringAppSpecificationProperty {
                             ImageUri = "imageUri",

                             // the properties below are optional
                             ContainerArguments = new [] { "containerArguments" },
                             ContainerEntrypoint = new [] { "containerEntrypoint" },
                             PostAnalyticsProcessorSourceUri = "postAnalyticsProcessorSourceUri",
                             RecordPreprocessorSourceUri = "recordPreprocessorSourceUri"
                         },
                         MonitoringInputs = new [] { new MonitoringInputProperty {
                             BatchTransformInput = new BatchTransformInputProperty {
                                 DataCapturedDestinationS3Uri = "dataCapturedDestinationS3Uri",
                                 DatasetFormat = new DatasetFormatProperty {
                                     Csv = new CsvProperty {
                                         Header = false
                                     },
                                     Json = new JsonProperty {
                                         Line = false
                                     },
                                     Parquet = false
                                 },
                                 LocalPath = "localPath",

                                 // the properties below are optional
                                 ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
                                 S3DataDistributionType = "s3DataDistributionType",
                                 S3InputMode = "s3InputMode"
                             },
                             EndpointInput = new EndpointInputProperty {
                                 EndpointName = "endpointName",
                                 LocalPath = "localPath",

                                 // the properties below are optional
                                 ExcludeFeaturesAttribute = "excludeFeaturesAttribute",
                                 S3DataDistributionType = "s3DataDistributionType",
                                 S3InputMode = "s3InputMode"
                             }
                         } },
                         MonitoringOutputConfig = new MonitoringOutputConfigProperty {
                             MonitoringOutputs = new [] { new MonitoringOutputProperty {
                                 S3Output = new S3OutputProperty {
                                     LocalPath = "localPath",
                                     S3Uri = "s3Uri",

                                     // the properties below are optional
                                     S3UploadMode = "s3UploadMode"
                                 }
                             } },

                             // the properties below are optional
                             KmsKeyId = "kmsKeyId"
                         },
                         MonitoringResources = new MonitoringResourcesProperty {
                             ClusterConfig = new ClusterConfigProperty {
                                 InstanceCount = 123,
                                 InstanceType = "instanceType",
                                 VolumeSizeInGb = 123,

                                 // the properties below are optional
                                 VolumeKmsKeyId = "volumeKmsKeyId"
                             }
                         },
                         RoleArn = "roleArn",

                         // the properties below are optional
                         BaselineConfig = new BaselineConfigProperty {
                             ConstraintsResource = new ConstraintsResourceProperty {
                                 S3Uri = "s3Uri"
                             },
                             StatisticsResource = new StatisticsResourceProperty {
                                 S3Uri = "s3Uri"
                             }
                         },
                         Environment = new Dictionary<string, string> {
                             { "environmentKey", "environment" }
                         },
                         NetworkConfig = new NetworkConfigProperty {
                             EnableInterContainerTrafficEncryption = false,
                             EnableNetworkIsolation = false,
                             VpcConfig = new VpcConfigProperty {
                                 SecurityGroupIds = new [] { "securityGroupIds" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         StoppingCondition = new StoppingConditionProperty {
                             MaxRuntimeInSeconds = 123
                         }
                     },
                     MonitoringJobDefinitionName = "monitoringJobDefinitionName",
                     MonitoringType = "monitoringType",
                     ScheduleConfig = new ScheduleConfigProperty {
                         ScheduleExpression = "scheduleExpression",

                         // the properties below are optional
                         DataAnalysisEndTime = "dataAnalysisEndTime",
                         DataAnalysisStartTime = "dataAnalysisStartTime"
                     }
                 },
                 MonitoringScheduleName = "monitoringScheduleName",

                 // the properties below are optional
                 EndpointName = "endpointName",
                 FailureReason = "failureReason",
                 LastMonitoringExecutionSummary = new MonitoringExecutionSummaryProperty {
                     CreationTime = "creationTime",
                     LastModifiedTime = "lastModifiedTime",
                     MonitoringExecutionStatus = "monitoringExecutionStatus",
                     MonitoringScheduleName = "monitoringScheduleName",
                     ScheduledTime = "scheduledTime",

                     // the properties below are optional
                     EndpointName = "endpointName",
                     FailureReason = "failureReason",
                     ProcessingJobArn = "processingJobArn"
                 },
                 MonitoringScheduleStatus = "monitoringScheduleStatus",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

EndpointName

The name of the endpoint using the monitoring schedule.

public string? EndpointName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-endpointname

FailureReason

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

public string? FailureReason { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-failurereason

LastMonitoringExecutionSummary

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

public object? LastMonitoringExecutionSummary { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-lastmonitoringexecutionsummary

MonitoringScheduleConfig

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

public object MonitoringScheduleConfig { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringscheduleconfig

MonitoringScheduleName

The name of the monitoring schedule.

public string MonitoringScheduleName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-monitoringschedule.html#cfn-sagemaker-monitoringschedule-monitoringschedulename

MonitoringScheduleStatus

The status of the monitoring schedule.

public string? MonitoringScheduleStatus { get; set; }