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.103.1 (build bef2dea)",
date="2024-09-24T10:56:39.532Z")
@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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.static interface
Automatic rollback configuration for handling endpoint deployment failures and recovery.static interface
Update policy for a blue/green deployment.static final class
A fluent builder forCfnEndpoint
.static interface
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
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.static interface
Specifies a rolling deployment strategy for updating a SageMaker endpoint.static interface
Defines the traffic routing strategy during an endpoint deployment to shift traffic from the old fleet to the new fleet.static interface
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe name of the endpoint, such asMyEndpoint
.The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint.The name of the endpoint.The name must be unique within an AWS Region in your AWS account.When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
.When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.Specifies whether to reuse the last deployment configuration.getTags()
Tag Manager which manages the tags for this resource.A list of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
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
When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
.void
When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
.void
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.void
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
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrEndpointName
The name of the endpoint, such asMyEndpoint
. -
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getEndpointConfigName
The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig . -
setEndpointConfigName
The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig . -
getDeploymentConfig
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. -
setDeploymentConfig
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
-
setEndpointName
-
getExcludeRetainedVariantProperties
When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
. If you don't specify a value forExcludeAllVariantProperties
, no variant properties are overridden. Don't use this property when creating new endpoint resources or whenRetainAllVariantProperties
is set tofalse
. -
setExcludeRetainedVariantProperties
When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
. If you don't specify a value forExcludeAllVariantProperties
, no variant properties are overridden. Don't use this property when creating new endpoint resources or whenRetainAllVariantProperties
is set tofalse
. -
setExcludeRetainedVariantProperties
When you are updating endpoint resources with RetainAllVariantProperties whose value is set totrue
,ExcludeRetainedVariantProperties
specifies the list of type VariantProperty to override with the values provided byEndpointConfig
. If you don't specify a value forExcludeAllVariantProperties
, no variant properties are overridden. Don't use this property when creating new endpoint resources or whenRetainAllVariantProperties
is set tofalse
. -
getRetainAllVariantProperties
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. -
setRetainAllVariantProperties
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. -
setRetainAllVariantProperties
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. -
getRetainDeploymentConfig
Specifies whether to reuse the last deployment configuration. -
setRetainDeploymentConfig
Specifies whether to reuse the last deployment configuration. -
setRetainDeploymentConfig
Specifies whether to reuse the last deployment configuration. -
getTagsRaw
A list of key-value pairs to apply to this resource. -
setTagsRaw
A list of key-value pairs to apply to this resource.
-