CfnEndpointProps

class aws_cdk.aws_sagemaker.CfnEndpointProps(*, endpoint_config_name, deployment_config=None, endpoint_name=None, exclude_retained_variant_properties=None, retain_all_variant_properties=None, retain_deployment_config=None, tags=None)

Bases: object

Properties for defining a CfnEndpoint.

Parameters:

endpoint_config_name (str) – The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .
deployment_config (Union[IResolvable, DeploymentConfigProperty, Dict[str, Any], None]) – The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
endpoint_name (Optional[str]) – The name of the endpoint. The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .
exclude_retained_variant_properties (Union[IResolvable, Sequence[Union[IResolvable, VariantPropertyProperty, Dict[str, Any]]], None]) – When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don’t specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don’t use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .
retain_all_variant_properties (Union[bool, IResolvable, None]) – When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.
retain_deployment_config (Union[bool, IResolvable, None]) – Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of key-value pairs to apply to this resource. For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpoint.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_endpoint_props = sagemaker.CfnEndpointProps(
    endpoint_config_name="endpointConfigName",

    # the properties below are optional
    deployment_config=sagemaker.CfnEndpoint.DeploymentConfigProperty(
        auto_rollback_configuration=sagemaker.CfnEndpoint.AutoRollbackConfigProperty(
            alarms=[sagemaker.CfnEndpoint.AlarmProperty(
                alarm_name="alarmName"
            )]
        ),
        blue_green_update_policy=sagemaker.CfnEndpoint.BlueGreenUpdatePolicyProperty(
            traffic_routing_configuration=sagemaker.CfnEndpoint.TrafficRoutingConfigProperty(
                type="type",

                # the properties below are optional
                canary_size=sagemaker.CfnEndpoint.CapacitySizeProperty(
                    type="type",
                    value=123
                ),
                linear_step_size=sagemaker.CfnEndpoint.CapacitySizeProperty(
                    type="type",
                    value=123
                ),
                wait_interval_in_seconds=123
            ),

            # the properties below are optional
            maximum_execution_timeout_in_seconds=123,
            termination_wait_in_seconds=123
        ),
        rolling_update_policy=sagemaker.CfnEndpoint.RollingUpdatePolicyProperty(
            maximum_batch_size=sagemaker.CfnEndpoint.CapacitySizeProperty(
                type="type",
                value=123
            ),
            wait_interval_in_seconds=123,

            # the properties below are optional
            maximum_execution_timeout_in_seconds=123,
            rollback_maximum_batch_size=sagemaker.CfnEndpoint.CapacitySizeProperty(
                type="type",
                value=123
            )
        )
    ),
    endpoint_name="endpointName",
    exclude_retained_variant_properties=[sagemaker.CfnEndpoint.VariantPropertyProperty(
        variant_property_type="variantPropertyType"
    )],
    retain_all_variant_properties=False,
    retain_deployment_config=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

deployment_config

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

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

endpoint_config_name

The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .

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

endpoint_name

The name of the endpoint.

The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in ` <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html>`_ .

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

exclude_retained_variant_properties

When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don’t specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don’t use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

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

retain_all_variant_properties

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

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

retain_deployment_config

Specifies whether to reuse the last deployment configuration.

The default value is false (the configuration is not reused).

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

tags

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .

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