interface IEndpoint

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.IEndpoint
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#IEndpoint
Java	software.amazon.awscdk.services.sagemaker.IEndpoint
Python	aws_cdk.aws_sagemaker.IEndpoint
TypeScript (source)	aws-cdk-lib » aws_sagemaker » IEndpoint

Implemented by Endpoint

The interface for a SageMaker Endpoint resource.

Properties

Name	Type	Description
endpointArn	string	The ARN of the endpoint.
endpointName	string	The name of the endpoint.
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

endpointArn

Type: string

The ARN of the endpoint.

---

endpointName

Type: string

The name of the endpoint.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantInvoke(grantee)	Permits an IAM principal to invoke this endpoint.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantInvoke(grantee)

public grantInvoke(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal to grant access to.

Returns

• Grant

Permits an IAM principal to invoke this endpoint.