Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sagemaker
  5. MonitoringSchedule
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.sagemaker.MonitoringSchedule

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a SageMaker 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", {
    name: "my-monitoring-schedule",
    monitoringScheduleConfig: {
        monitoringJobDefinitionName: testAwsSagemakerDataQualityJobDefinition.name,
        monitoringType: "DataQuality",
    },
});

    import pulumi
import pulumi_aws as aws

test = aws.sagemaker.MonitoringSchedule("test",
    name="my-monitoring-schedule",
    monitoring_schedule_config={
        "monitoring_job_definition_name": test_aws_sagemaker_data_quality_job_definition["name"],
        "monitoring_type": "DataQuality",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name: pulumi.String("my-monitoring-schedule"),
			MonitoringScheduleConfig: &sagemaker.MonitoringScheduleMonitoringScheduleConfigArgs{
				MonitoringJobDefinitionName: pulumi.Any(testAwsSagemakerDataQualityJobDefinition.Name),
				MonitoringType:              pulumi.String("DataQuality"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Name = "my-monitoring-schedule",
        MonitoringScheduleConfig = new Aws.Sagemaker.Inputs.MonitoringScheduleMonitoringScheduleConfigArgs
        {
            MonitoringJobDefinitionName = testAwsSagemakerDataQualityJobDefinition.Name,
            MonitoringType = "DataQuality",
        },
    });

});

    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.List;
import java.util.ArrayList;
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()
            .name("my-monitoring-schedule")
            .monitoringScheduleConfig(MonitoringScheduleMonitoringScheduleConfigArgs.builder()
                .monitoringJobDefinitionName(testAwsSagemakerDataQualityJobDefinition.name())
                .monitoringType("DataQuality")
                .build())
            .build());

    }
}

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

    Create MonitoringSchedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MonitoringSchedule(name: string, args: MonitoringScheduleArgs, opts?: CustomResourceOptions);
    @overload
def MonitoringSchedule(resource_name: str,
                       args: MonitoringScheduleArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def MonitoringSchedule(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       monitoring_schedule_config: Optional[MonitoringScheduleMonitoringScheduleConfigArgs] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewMonitoringSchedule(ctx *Context, name string, args MonitoringScheduleArgs, opts ...ResourceOption) (*MonitoringSchedule, error)
    public MonitoringSchedule(string name, MonitoringScheduleArgs args, CustomResourceOptions? opts = null)
    public MonitoringSchedule(String name, MonitoringScheduleArgs args)
public MonitoringSchedule(String name, MonitoringScheduleArgs args, CustomResourceOptions options)

    type: aws:sagemaker:MonitoringSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MonitoringScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MonitoringScheduleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MonitoringScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitoringScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitoringScheduleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var monitoringScheduleResource = new Aws.Sagemaker.MonitoringSchedule("monitoringScheduleResource", new()
{
    MonitoringScheduleConfig = new Aws.Sagemaker.Inputs.MonitoringScheduleMonitoringScheduleConfigArgs
    {
        MonitoringJobDefinitionName = "string",
        MonitoringType = "string",
        ScheduleConfig = new Aws.Sagemaker.Inputs.MonitoringScheduleMonitoringScheduleConfigScheduleConfigArgs
        {
            ScheduleExpression = "string",
        },
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := sagemaker.NewMonitoringSchedule(ctx, "monitoringScheduleResource", &sagemaker.MonitoringScheduleArgs{
	MonitoringScheduleConfig: &sagemaker.MonitoringScheduleMonitoringScheduleConfigArgs{
		MonitoringJobDefinitionName: pulumi.String("string"),
		MonitoringType:              pulumi.String("string"),
		ScheduleConfig: &sagemaker.MonitoringScheduleMonitoringScheduleConfigScheduleConfigArgs{
			ScheduleExpression: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var monitoringScheduleResource = new MonitoringSchedule("monitoringScheduleResource", MonitoringScheduleArgs.builder()
    .monitoringScheduleConfig(MonitoringScheduleMonitoringScheduleConfigArgs.builder()
        .monitoringJobDefinitionName("string")
        .monitoringType("string")
        .scheduleConfig(MonitoringScheduleMonitoringScheduleConfigScheduleConfigArgs.builder()
            .scheduleExpression("string")
            .build())
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    monitoring_schedule_resource = aws.sagemaker.MonitoringSchedule("monitoringScheduleResource",
    monitoring_schedule_config={
        "monitoring_job_definition_name": "string",
        "monitoring_type": "string",
        "schedule_config": {
            "schedule_expression": "string",
        },
    },
    name="string",
    tags={
        "string": "string",
    })

    const monitoringScheduleResource = new aws.sagemaker.MonitoringSchedule("monitoringScheduleResource", {
    monitoringScheduleConfig: {
        monitoringJobDefinitionName: "string",
        monitoringType: "string",
        scheduleConfig: {
            scheduleExpression: "string",
        },
    },
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:sagemaker:MonitoringSchedule
properties:
    monitoringScheduleConfig:
        monitoringJobDefinitionName: string
        monitoringType: string
        scheduleConfig:
            scheduleExpression: string
    name: string
    tags:
        string: string

    MonitoringSchedule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MonitoringSchedule resource accepts the following input properties:

    MonitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    Name 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.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    MonitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfigArgs
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    Name 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.
    Tags map[string]string
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    monitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags Map<String,String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    monitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    monitoring_schedule_config MonitoringScheduleMonitoringScheduleConfigArgs
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name str
    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.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    monitoringScheduleConfig Property Map
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags Map<String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MonitoringSchedule resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing MonitoringSchedule Resource

    Get an existing MonitoringSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MonitoringScheduleState, opts?: CustomResourceOptions): MonitoringSchedule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        monitoring_schedule_config: Optional[MonitoringScheduleMonitoringScheduleConfigArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> MonitoringSchedule
    func GetMonitoringSchedule(ctx *Context, name string, id IDInput, state *MonitoringScheduleState, opts ...ResourceOption) (*MonitoringSchedule, error)
    public static MonitoringSchedule Get(string name, Input<string> id, MonitoringScheduleState? state, CustomResourceOptions? opts = null)
    public static MonitoringSchedule get(String name, Output<String> id, MonitoringScheduleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    MonitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    Name 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.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    MonitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfigArgs
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    Name 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.
    Tags map[string]string
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    monitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags Map<String,String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    monitoringScheduleConfig MonitoringScheduleMonitoringScheduleConfig
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    monitoring_schedule_config MonitoringScheduleMonitoringScheduleConfigArgs
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name str
    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.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name (ARN) assigned by AWS to this monitoring schedule.
    monitoringScheduleConfig Property Map
    The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below.
    name 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.
    tags Map<String>
    A mapping of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    MonitoringScheduleMonitoringScheduleConfig, MonitoringScheduleMonitoringScheduleConfigArgs

    MonitoringJobDefinitionName string
    The name of the monitoring job definition to schedule.
    MonitoringType string
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    ScheduleConfig MonitoringScheduleMonitoringScheduleConfigScheduleConfig
    Configures the monitoring schedule. Fields are documented below.
    MonitoringJobDefinitionName string
    The name of the monitoring job definition to schedule.
    MonitoringType string
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    ScheduleConfig MonitoringScheduleMonitoringScheduleConfigScheduleConfig
    Configures the monitoring schedule. Fields are documented below.
    monitoringJobDefinitionName String
    The name of the monitoring job definition to schedule.
    monitoringType String
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    scheduleConfig MonitoringScheduleMonitoringScheduleConfigScheduleConfig
    Configures the monitoring schedule. Fields are documented below.
    monitoringJobDefinitionName string
    The name of the monitoring job definition to schedule.
    monitoringType string
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    scheduleConfig MonitoringScheduleMonitoringScheduleConfigScheduleConfig
    Configures the monitoring schedule. Fields are documented below.
    monitoring_job_definition_name str
    The name of the monitoring job definition to schedule.
    monitoring_type str
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    schedule_config MonitoringScheduleMonitoringScheduleConfigScheduleConfig
    Configures the monitoring schedule. Fields are documented below.
    monitoringJobDefinitionName String
    The name of the monitoring job definition to schedule.
    monitoringType String
    The type of the monitoring job definition to schedule. Valid values are DataQuality, ModelQuality, ModelBias or ModelExplainability
    scheduleConfig Property Map
    Configures the monitoring schedule. Fields are documented below.

    MonitoringScheduleMonitoringScheduleConfigScheduleConfig, MonitoringScheduleMonitoringScheduleConfigScheduleConfigArgs

    ScheduleExpression string
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).
    ScheduleExpression string
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).
    scheduleExpression String
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).
    scheduleExpression string
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).
    schedule_expression str
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).
    scheduleExpression String
    A cron expression that describes details about the monitoring schedule. For example, and hourly schedule would be cron(0 * ? * * *).

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws