Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:38.842Z")
@Stability(Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder()
         .endpointConfigName("endpointConfigName")
         // the properties below are optional
         .deploymentConfig(DeploymentConfigProperty.builder()
                 .autoRollbackConfiguration(AutoRollbackConfigProperty.builder()
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 .build()))
                         .build())
                 .blueGreenUpdatePolicy(BlueGreenUpdatePolicyProperty.builder()
                         .trafficRoutingConfiguration(TrafficRoutingConfigProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .canarySize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .linearStepSize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .waitIntervalInSeconds(123)
                                 .build())
                         // the properties below are optional
                         .maximumExecutionTimeoutInSeconds(123)
                         .terminationWaitInSeconds(123)
                         .build())
                 .rollingUpdatePolicy(RollingUpdatePolicyProperty.builder()
                         .maximumBatchSize(CapacitySizeProperty.builder()
                                 .type("type")
                                 .value(123)
                                 .build())
                         .waitIntervalInSeconds(123)
                         // the properties below are optional
                         .maximumExecutionTimeoutInSeconds(123)
                         .rollbackMaximumBatchSize(CapacitySizeProperty.builder()
                                 .type("type")
                                 .value(123)
                                 .build())
                         .build())
                 .build())
         .endpointName("endpointName")
         .excludeRetainedVariantProperties(List.of(VariantPropertyProperty.builder()
                 .variantPropertyType("variantPropertyType")
                 .build()))
         .retainAllVariantProperties(false)
         .retainDeploymentConfig(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointProps.Builder	A builder for CfnEndpointProps
static final class	CfnEndpointProps.Jsii$Proxy	An implementation for CfnEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnEndpointProps.Builder	builder()
default Object	getDeploymentConfig()	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
String	getEndpointConfigName()	The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint.
default String	getEndpointName()	The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
default Object	getExcludeRetainedVariantProperties()	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 .
default Object	getRetainAllVariantProperties()	When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
default Object	getRetainDeploymentConfig()	Specifies whether to reuse the last deployment configuration.
default List<CfnTag>	getTags()	A list of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointConfigName

@Stability(Stable)
@NotNull
String getEndpointConfigName()

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

See Also:

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

getDeploymentConfig

@Stability(Stable)
@Nullable
default Object getDeploymentConfig()

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

See Also:

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

getEndpointName

@Stability(Stable)
@Nullable
default String getEndpointName()

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 .

See Also:

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

getExcludeRetainedVariantProperties

@Stability(Stable)
@Nullable
default Object getExcludeRetainedVariantProperties()

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 Also:

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

getRetainAllVariantProperties

@Stability(Stable)
@Nullable
default Object getRetainAllVariantProperties()

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 Also:

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

getRetainDeploymentConfig

@Stability(Stable)
@Nullable
default Object getRetainDeploymentConfig()

Specifies whether to reuse the last deployment configuration.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps