MonitoringSchedule class

Provides a SageMaker AI monitoring schedule resource.

Example Usage

Basic usage:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.sagemaker.MonitoringSchedule("test", {
    monitoringScheduleConfig: {
        monitoringJobDefinitionName: testAwsSagemakerDataQualityJobDefinition.name,
        monitoringType: "DataQuality",
    },
    name: "my-monitoring-schedule",
});
import pulumi
import pulumi_aws as aws

test = aws.sagemaker.MonitoringSchedule("test",
    monitoring_schedule_config={
        "monitoring_job_definition_name": test_aws_sagemaker_data_quality_job_definition["name"],
        "monitoring_type": "DataQuality",
    },
    name="my-monitoring-schedule")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Sagemaker.MonitoringSchedule("test", new()
    {
        MonitoringScheduleConfig = new Aws.Sagemaker.Inputs.MonitoringScheduleMonitoringScheduleConfigArgs
        {
            MonitoringJobDefinitionName = testAwsSagemakerDataQualityJobDefinition.Name,
            MonitoringType = "DataQuality",
        },
        Name = "my-monitoring-schedule",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sagemaker.NewMonitoringSchedule(ctx, "test", &sagemaker.MonitoringScheduleArgs{
			MonitoringScheduleConfig: &sagemaker.MonitoringScheduleMonitoringScheduleConfigArgs{
				MonitoringJobDefinitionName: pulumi.Any(testAwsSagemakerDataQualityJobDefinition.Name),
				MonitoringType:              pulumi.String("DataQuality"),
			},
			Name: pulumi.String("my-monitoring-schedule"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sagemaker_monitoringschedule" "test" {
  monitoring_schedule_config = {
    monitoring_job_definition_name = testAwsSagemakerDataQualityJobDefinition.name
    monitoring_type                = "DataQuality"
  }
  name = "my-monitoring-schedule"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.MonitoringSchedule;
import com.pulumi.aws.sagemaker.MonitoringScheduleArgs;
import com.pulumi.aws.sagemaker.inputs.MonitoringScheduleMonitoringScheduleConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new MonitoringSchedule("test", MonitoringScheduleArgs.builder()
            .monitoringScheduleConfig(MonitoringScheduleMonitoringScheduleConfigArgs.builder()
                .monitoringJobDefinitionName(testAwsSagemakerDataQualityJobDefinition.name())
                .monitoringType("DataQuality")
                .build())
            .name("my-monitoring-schedule")
            .build());

    }
}
resources:
  test:
    type: aws:sagemaker:MonitoringSchedule
    properties:
      monitoringScheduleConfig:
        monitoringJobDefinitionName: ${testAwsSagemakerDataQualityJobDefinition.name}
        monitoringType: DataQuality
      name: my-monitoring-schedule

Import

Using pulumi import, import monitoring schedules using the name. For example:

$ pulumi import aws:sagemaker/monitoringSchedule:MonitoringSchedule test_monitoring_schedule monitoring-schedule-foo

Constructors

MonitoringSchedule(String name, {MonitoringScheduleArgs? args, CustomResourceOptions? options})
Creates a new MonitoringSchedule. name The Pulumi resource name. args Arguments used to configure this MonitoringSchedule. The set of arguments for MonitoringSchedule. options Resource options controlling this resource's behavior.
MonitoringSchedule.reference(String urn)
Creates a typed reference to an existing MonitoringSchedule resource.

Properties

arn ↔ Output<String>
ARN assigned by AWS to this monitoring schedule.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
monitoringScheduleConfig ↔ Output<MonitoringScheduleMonitoringScheduleConfig>
The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
latefinal
name ↔ Output<String>
The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account. If omitted, the provider will assign a random, unique name.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A mapping of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {MonitoringScheduleState? state, CustomResourceOptions? options}) → MonitoringSchedule
Gets an existing MonitoringSchedule resource's state with the given name and id.