CfnMonitoringScheduleProps

class aws_cdk.aws_sagemaker.CfnMonitoringScheduleProps(*, monitoring_schedule_config, monitoring_schedule_name, endpoint_name=None, failure_reason=None, last_monitoring_execution_summary=None, monitoring_schedule_status=None, tags=None)

Bases: object

Properties for defining a CfnMonitoringSchedule.

Parameters:

monitoring_schedule_config (Union[IResolvable, MonitoringScheduleConfigProperty, Dict[str, Any]]) – The configuration object that specifies the monitoring schedule and defines the monitoring job.
monitoring_schedule_name (str) – The name of the monitoring schedule.
endpoint_name (Optional[str]) – The name of the endpoint using the monitoring schedule.
failure_reason (Optional[str]) – Contains the reason a monitoring job failed, if it failed.
last_monitoring_execution_summary (Union[IResolvable, MonitoringExecutionSummaryProperty, Dict[str, Any], None]) – Describes metadata on the last execution to run, if there was one.
monitoring_schedule_status (Optional[str]) – The status of the monitoring schedule.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_monitoring_schedule_props = sagemaker.CfnMonitoringScheduleProps(
    monitoring_schedule_config=sagemaker.CfnMonitoringSchedule.MonitoringScheduleConfigProperty(
        monitoring_job_definition=sagemaker.CfnMonitoringSchedule.MonitoringJobDefinitionProperty(
            monitoring_app_specification=sagemaker.CfnMonitoringSchedule.MonitoringAppSpecificationProperty(
                image_uri="imageUri",

                # the properties below are optional
                container_arguments=["containerArguments"],
                container_entrypoint=["containerEntrypoint"],
                post_analytics_processor_source_uri="postAnalyticsProcessorSourceUri",
                record_preprocessor_source_uri="recordPreprocessorSourceUri"
            ),
            monitoring_inputs=[sagemaker.CfnMonitoringSchedule.MonitoringInputProperty(
                batch_transform_input=sagemaker.CfnMonitoringSchedule.BatchTransformInputProperty(
                    data_captured_destination_s3_uri="dataCapturedDestinationS3Uri",
                    dataset_format=sagemaker.CfnMonitoringSchedule.DatasetFormatProperty(
                        csv=sagemaker.CfnMonitoringSchedule.CsvProperty(
                            header=False
                        ),
                        json=sagemaker.CfnMonitoringSchedule.JsonProperty(
                            line=False
                        ),
                        parquet=False
                    ),
                    local_path="localPath",

                    # the properties below are optional
                    exclude_features_attribute="excludeFeaturesAttribute",
                    s3_data_distribution_type="s3DataDistributionType",
                    s3_input_mode="s3InputMode"
                ),
                endpoint_input=sagemaker.CfnMonitoringSchedule.EndpointInputProperty(
                    endpoint_name="endpointName",
                    local_path="localPath",

                    # the properties below are optional
                    exclude_features_attribute="excludeFeaturesAttribute",
                    s3_data_distribution_type="s3DataDistributionType",
                    s3_input_mode="s3InputMode"
                )
            )],
            monitoring_output_config=sagemaker.CfnMonitoringSchedule.MonitoringOutputConfigProperty(
                monitoring_outputs=[sagemaker.CfnMonitoringSchedule.MonitoringOutputProperty(
                    s3_output=sagemaker.CfnMonitoringSchedule.S3OutputProperty(
                        local_path="localPath",
                        s3_uri="s3Uri",

                        # the properties below are optional
                        s3_upload_mode="s3UploadMode"
                    )
                )],

                # the properties below are optional
                kms_key_id="kmsKeyId"
            ),
            monitoring_resources=sagemaker.CfnMonitoringSchedule.MonitoringResourcesProperty(
                cluster_config=sagemaker.CfnMonitoringSchedule.ClusterConfigProperty(
                    instance_count=123,
                    instance_type="instanceType",
                    volume_size_in_gb=123,

                    # the properties below are optional
                    volume_kms_key_id="volumeKmsKeyId"
                )
            ),
            role_arn="roleArn",

            # the properties below are optional
            baseline_config=sagemaker.CfnMonitoringSchedule.BaselineConfigProperty(
                constraints_resource=sagemaker.CfnMonitoringSchedule.ConstraintsResourceProperty(
                    s3_uri="s3Uri"
                ),
                statistics_resource=sagemaker.CfnMonitoringSchedule.StatisticsResourceProperty(
                    s3_uri="s3Uri"
                )
            ),
            environment={
                "environment_key": "environment"
            },
            network_config=sagemaker.CfnMonitoringSchedule.NetworkConfigProperty(
                enable_inter_container_traffic_encryption=False,
                enable_network_isolation=False,
                vpc_config=sagemaker.CfnMonitoringSchedule.VpcConfigProperty(
                    security_group_ids=["securityGroupIds"],
                    subnets=["subnets"]
                )
            ),
            stopping_condition=sagemaker.CfnMonitoringSchedule.StoppingConditionProperty(
                max_runtime_in_seconds=123
            )
        ),
        monitoring_job_definition_name="monitoringJobDefinitionName",
        monitoring_type="monitoringType",
        schedule_config=sagemaker.CfnMonitoringSchedule.ScheduleConfigProperty(
            schedule_expression="scheduleExpression",

            # the properties below are optional
            data_analysis_end_time="dataAnalysisEndTime",
            data_analysis_start_time="dataAnalysisStartTime"
        )
    ),
    monitoring_schedule_name="monitoringScheduleName",

    # the properties below are optional
    endpoint_name="endpointName",
    failure_reason="failureReason",
    last_monitoring_execution_summary=sagemaker.CfnMonitoringSchedule.MonitoringExecutionSummaryProperty(
        creation_time="creationTime",
        last_modified_time="lastModifiedTime",
        monitoring_execution_status="monitoringExecutionStatus",
        monitoring_schedule_name="monitoringScheduleName",
        scheduled_time="scheduledTime",

        # the properties below are optional
        endpoint_name="endpointName",
        failure_reason="failureReason",
        processing_job_arn="processingJobArn"
    ),
    monitoring_schedule_status="monitoringScheduleStatus",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)