Package software.amazon.awscdk.services.sagemaker.alpha

Class Endpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sagemaker.alpha.Endpoint

All Implemented Interfaces:

IResource, IEndpoint, IEndpoint, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:29.516Z")
@Stability(Experimental)
public class Endpoint
extends Resource
implements IEndpoint

(experimental) Defines a SageMaker endpoint.

Example:

 import software.amazon.awscdk.services.sagemaker.alpha.*;
 EndpointConfig endpointConfig;
 Endpoint endpoint = Endpoint.Builder.create(this, "Endpoint").endpointConfig(endpointConfig).build();
 IEndpointInstanceProductionVariant productionVariant = endpoint.findInstanceProductionVariant("my-variant");
 productionVariant.metricModelLatency().createAlarm(this, "ModelLatencyAlarm", CreateAlarmOptions.builder()
         .threshold(100000)
         .evaluationPeriods(3)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Endpoint.Builder	(experimental) A fluent builder for 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.services.sagemaker.alpha.IEndpoint

IEndpoint.Jsii$Default, IEndpoint.Jsii$Proxy

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IEndpointInstanceProductionVariant	findInstanceProductionVariant(String name)	(experimental) Find instance production variant based on variant name.
static IEndpoint	fromEndpointArn(software.constructs.Construct scope, String id, String endpointArn)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
static IEndpoint	fromEndpointAttributes(software.constructs.Construct scope, String id, EndpointAttributes attrs)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
static IEndpoint	fromEndpointName(software.constructs.Construct scope, String id, String endpointName)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
String	getEndpointArn()	(experimental) The ARN of the endpoint.
String	getEndpointName()	(experimental) The name of the endpoint.
List<IEndpointInstanceProductionVariant>	getInstanceProductionVariants()	(experimental) Get instance production variants associated with endpoint.
Grant	grantInvoke(IGrantable grantee)	(experimental) Permits an IAM principal to invoke this endpoint.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Endpoint

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

Endpoint

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

Endpoint

@Stability(Experimental)
public Endpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EndpointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromEndpointArn

@Stability(Experimental)
@NotNull
public static IEndpoint fromEndpointArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String endpointArn)

(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.

Parameters:

scope - the Construct scope. This parameter is required.

id - the resource id. This parameter is required.

endpointArn - the ARN of the endpoint. This parameter is required.

fromEndpointAttributes

@Stability(Experimental)
@NotNull
public static IEndpoint fromEndpointAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EndpointAttributes attrs)

(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.

Parameters:

scope - the Construct scope. This parameter is required.

id - the resource id. This parameter is required.

attrs - the attributes of the endpoint to import. This parameter is required.

fromEndpointName

@Stability(Experimental)
@NotNull
public static IEndpoint fromEndpointName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String endpointName)

(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.

Parameters:

scope - the Construct scope. This parameter is required.

id - the resource id. This parameter is required.

endpointName - the name of the endpoint. This parameter is required.

findInstanceProductionVariant

@Stability(Experimental)
@NotNull
public IEndpointInstanceProductionVariant findInstanceProductionVariant(@NotNull
 String name)

(experimental) Find instance production variant based on variant name.

Parameters:

name - Variant name from production variant. This parameter is required.

grantInvoke

@Stability(Experimental)
@NotNull
public Grant grantInvoke(@NotNull
 IGrantable grantee)

(experimental) Permits an IAM principal to invoke this endpoint.

Specified by:

grantInvoke in interface IEndpoint

Parameters:

grantee - The principal to grant access to. This parameter is required.

getEndpointArn

@Stability(Experimental)
@NotNull
public String getEndpointArn()

(experimental) The ARN of the endpoint.

Specified by:

getEndpointArn in interface IEndpoint

getEndpointName

@Stability(Experimental)
@NotNull
public String getEndpointName()

(experimental) The name of the endpoint.

Specified by:

getEndpointName in interface IEndpoint

getInstanceProductionVariants

@Stability(Experimental)
@NotNull
public List<IEndpointInstanceProductionVariant> getInstanceProductionVariants()

(experimental) Get instance production variants associated with endpoint.