@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.696Z") public class CfnEndpoint extends CfnResource implements IInspectable
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() .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();
Modifier and Type | Class and 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 class |
CfnEndpoint.Builder
A fluent builder for
CfnEndpoint . |
static interface |
CfnEndpoint.CapacitySizeProperty
Specifies the endpoint capacity to activate for production.
|
static interface |
CfnEndpoint.DeploymentConfigProperty
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
|
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEndpoint(Construct scope,
java.lang.String id,
CfnEndpointProps props)
Create a new `AWS::SageMaker::Endpoint`.
|
protected |
CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrEndpointName()
The name of the endpoint, such as `MyEndpoint` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
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.
|
java.lang.String |
getEndpointName()
The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
|
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` .
|
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.
|
java.lang.Object |
getRetainDeploymentConfig()
Specifies whether to reuse the last deployment configuration.
|
TagManager |
getTags()
A list of key-value pairs to apply to this resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDeploymentConfig(CfnEndpoint.DeploymentConfigProperty value)
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
|
void |
setDeploymentConfig(IResolvable value)
The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
|
void |
setEndpointConfigName(java.lang.String value)
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.
|
void |
setEndpointName(java.lang.String value)
The name of the endpoint.The name must be unique within an AWS Region in your AWS account.
|
void |
setExcludeRetainedVariantProperties(IResolvable value)
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` .
|
void |
setExcludeRetainedVariantProperties(java.util.List<java.lang.Object> value)
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` .
|
void |
setRetainAllVariantProperties(java.lang.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(java.lang.Boolean value)
Specifies whether to reuse the last deployment configuration.
|
void |
setRetainDeploymentConfig(IResolvable value)
Specifies whether to reuse the last deployment configuration.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEndpoint(Construct scope, java.lang.String id, CfnEndpointProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrEndpointName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .
public java.lang.String getEndpointConfigName()
public void setEndpointConfigName(java.lang.String value)
public java.lang.Object getDeploymentConfig()
public void setDeploymentConfig(IResolvable value)
public void setDeploymentConfig(CfnEndpoint.DeploymentConfigProperty value)
public java.lang.String getEndpointName()
public void setEndpointName(java.lang.String value)
public java.lang.Object getExcludeRetainedVariantProperties()
public void setExcludeRetainedVariantProperties(IResolvable value)
public void setExcludeRetainedVariantProperties(java.util.List<java.lang.Object> value)
public java.lang.Object getRetainAllVariantProperties()
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.
public void setRetainAllVariantProperties(java.lang.Boolean value)
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.
public void setRetainAllVariantProperties(IResolvable value)
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.
public java.lang.Object getRetainDeploymentConfig()
The default value is false (the configuration is not reused).
public void setRetainDeploymentConfig(java.lang.Boolean value)
The default value is false (the configuration is not reused).
public void setRetainDeploymentConfig(IResolvable value)
The default value is false (the configuration is not reused).