Package software.amazon.awscdk.services.sagemaker

Class CfnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnEndpoint

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:06.821Z")
@Stability(Stable)
public class CfnEndpoint
extends CfnResource
implements IInspectable, ITaggable

Use the AWS::SageMaker::Endpoint resource to create an endpoint using the specified configuration in the request.

Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the AWS::SageMaker::EndpointConfig resource. For more information, see Deploy a Model on Amazon SageMaker Hosting Services in the Amazon SageMaker Developer Guide .

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.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .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	Class	Description
static interface	CfnEndpoint.AlarmProperty	An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
static interface	CfnEndpoint.AutoRollbackConfigProperty	Automatic rollback configuration for handling endpoint deployment failures and recovery.
static interface	CfnEndpoint.BlueGreenUpdatePolicyProperty	Update policy for a blue/green deployment.
static final class	CfnEndpoint.Builder	A fluent builder for CfnEndpoint.
static interface	CfnEndpoint.CapacitySizeProperty	Specifies the type and size of the endpoint capacity to activate for a blue/green deployment, a rolling deployment, or a rollback strategy.
static interface	CfnEndpoint.DeploymentConfigProperty	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
static interface	CfnEndpoint.RollingUpdatePolicyProperty	Specifies a rolling deployment strategy for updating a SageMaker endpoint.
static interface	CfnEndpoint.TrafficRoutingConfigProperty	Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.
static interface	CfnEndpoint.VariantPropertyProperty	Specifies a production variant property type for an Endpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEndpoint(software.constructs.Construct scope, String id, CfnEndpointProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrEndpointArn()	The Amazon Resource Name (ARN) of the endpoint.
String	getAttrEndpointName()	The name of the endpoint, such as MyEndpoint .
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
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.
String	getEndpointName()	The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
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 .
Object	getRetainAllVariantProperties()	When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
Object	getRetainDeploymentConfig()	Specifies whether to reuse the last deployment configuration.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	A list of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeploymentConfig(IResolvable value)	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
void	setDeploymentConfig(CfnEndpoint.DeploymentConfigProperty value)	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
void	setEndpointConfigName(String value)	The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint.
void	setEndpointName(String value)	The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
void	setExcludeRetainedVariantProperties(List<Object> value)	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 .
void	setExcludeRetainedVariantProperties(IResolvable value)	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 .
void	setRetainAllVariantProperties(Boolean value)	When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
void	setRetainAllVariantProperties(IResolvable value)	When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.
void	setRetainDeploymentConfig(Boolean value)	Specifies whether to reuse the last deployment configuration.
void	setRetainDeploymentConfig(IResolvable value)	Specifies whether to reuse the last deployment configuration.
void	setTagsRaw(List<CfnTag> value)	A list of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpoint

protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpoint

@Stability(Stable)
public CfnEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEndpointProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpointArn

@Stability(Stable)
@NotNull
public String getAttrEndpointArn()

The Amazon Resource Name (ARN) of the endpoint.

getAttrEndpointName

@Stability(Stable)
@NotNull
public String getAttrEndpointName()

The name of the endpoint, such as MyEndpoint .

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getEndpointConfigName

@Stability(Stable)
@NotNull
public String getEndpointConfigName()

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

setEndpointConfigName

@Stability(Stable)
public void setEndpointConfigName(@NotNull
 String value)

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

getDeploymentConfig

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

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

setDeploymentConfig

@Stability(Stable)
public void setDeploymentConfig(@Nullable
 IResolvable value)

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

setDeploymentConfig

@Stability(Stable)
public void setDeploymentConfig(@Nullable
 CfnEndpoint.DeploymentConfigProperty value)

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

getEndpointName

@Stability(Stable)
@Nullable
public 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 .

setEndpointName

@Stability(Stable)
public void setEndpointName(@Nullable
 String value)

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 .

getExcludeRetainedVariantProperties

@Stability(Stable)
@Nullable
public 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 .

setExcludeRetainedVariantProperties

@Stability(Stable)
public void setExcludeRetainedVariantProperties(@Nullable
 IResolvable value)

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 .

setExcludeRetainedVariantProperties

@Stability(Stable)
public void setExcludeRetainedVariantProperties(@Nullable
 List<Object> value)

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 .

getRetainAllVariantProperties

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

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

setRetainAllVariantProperties

@Stability(Stable)
public void setRetainAllVariantProperties(@Nullable
 Boolean value)

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

setRetainAllVariantProperties

@Stability(Stable)
public void setRetainAllVariantProperties(@Nullable
 IResolvable value)

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

getRetainDeploymentConfig

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

Specifies whether to reuse the last deployment configuration.

setRetainDeploymentConfig

@Stability(Stable)
public void setRetainDeploymentConfig(@Nullable
 Boolean value)

Specifies whether to reuse the last deployment configuration.

setRetainDeploymentConfig

@Stability(Stable)
public void setRetainDeploymentConfig(@Nullable
 IResolvable value)

Specifies whether to reuse the last deployment configuration.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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