Class CfnMonitoringSchedule

A CloudFormation AWS::SageMaker::MonitoringSchedule.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnMonitoringSchedule

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.AWS.Sagemaker.dll

Syntax (csharp)

public class CfnMonitoringSchedule : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnMonitoringSchedule
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

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.

CloudformationResource: AWS::SageMaker::MonitoringSchedule

Link: 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;

CfnMonitoringSchedule cfnMonitoringSchedule = new CfnMonitoringSchedule(this, "MyCfnMonitoringSchedule", 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 {
                EndpointInput = new EndpointInputProperty {
                    EndpointName = "endpointName",
                    LocalPath = "localPath",

                    // the properties below are optional
                    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"
        }
    },
    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

CfnMonitoringSchedule(Construct, String, ICfnMonitoringScheduleProps)	Create a new `AWS::SageMaker::MonitoringSchedule`.
CfnMonitoringSchedule(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnMonitoringSchedule(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrCreationTime	The time when the monitoring schedule was created.
AttrLastModifiedTime	The last time that the monitoring schedule was modified.
AttrMonitoringScheduleArn	The Amazon Resource Name (ARN) of the monitoring schedule.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnMonitoringSchedule(Construct, String, ICfnMonitoringScheduleProps)

Create a new AWS::SageMaker::MonitoringSchedule.

public CfnMonitoringSchedule(Construct scope, string id, ICfnMonitoringScheduleProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnMonitoringScheduleProps

resource properties.

CfnMonitoringSchedule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnMonitoringSchedule(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnMonitoringSchedule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnMonitoringSchedule(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrCreationTime

The time when the monitoring schedule was created.

public virtual string AttrCreationTime { get; }

Property Value

System.String

Remarks

CloudformationAttribute: CreationTime

AttrLastModifiedTime

The last time that the monitoring schedule was modified.

public virtual string AttrLastModifiedTime { get; }

Property Value

System.String

Remarks

CloudformationAttribute: LastModifiedTime

AttrMonitoringScheduleArn

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

public virtual string AttrMonitoringScheduleArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: MonitoringScheduleArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

EndpointName

The name of the endpoint using the monitoring schedule.

public virtual string EndpointName { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual string FailureReason { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual object LastMonitoringExecutionSummary { get; set; }

Property Value

System.Object

Remarks

Link: 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 virtual object MonitoringScheduleConfig { get; set; }

Property Value

System.Object

Remarks

Link: 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 virtual string MonitoringScheduleName { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual string MonitoringScheduleStatus { get; set; }

Property Value

System.String

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable