software.amazon.awscdk.services.sagemaker

Interface CfnEndpointProps

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.380Z")
public interface CfnEndpointProps

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()
                 .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())
                 // the properties below are optional
                 .autoRollbackConfiguration(AutoRollbackConfigProperty.builder()
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnEndpointProps.Builder	builder()
default java.lang.Object	getDeploymentConfig() The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
java.lang.String	getEndpointConfigName() The name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for the endpoint.
default java.lang.String	getEndpointName() The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
default java.lang.Object	getExcludeRetainedVariantProperties() When you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true` , `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) to override with the values provided by `EndpointConfig` .
default java.lang.Object	getRetainAllVariantProperties() When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
default java.lang.Object	getRetainDeploymentConfig() Specifies whether to reuse the last deployment configuration.
default java.util.List<CfnTag>	getTags() A list of key-value pairs to apply to this resource.

Method Detail

getEndpointConfigName

java.lang.String getEndpointConfigName()

The name of the [AWS::SageMaker::EndpointConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-endpointconfig.html) resource that specifies the configuration for the endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) .

getDeploymentConfig

default java.lang.Object getDeploymentConfig()

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

getEndpointName

default java.lang.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 [](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html) .

getExcludeRetainedVariantProperties

default java.lang.Object getExcludeRetainedVariantProperties()

When you are updating endpoint resources with [RetainAllVariantProperties](https://docs.aws.amazon.com/sagemaker/latest/dg/API_UpdateEndpoint.html#SageMaker-UpdateEndpoint-request-RetainAllVariantProperties) whose value is set to `true` , `ExcludeRetainedVariantProperties` specifies the list of type [VariantProperty](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-variantproperty.html) 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` .

getRetainAllVariantProperties

default java.lang.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.

getRetainDeploymentConfig

default java.lang.Object getRetainDeploymentConfig()

Specifies whether to reuse the last deployment configuration.

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

getTags

default java.util.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 .

builder

static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps