interface IEndpoint
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Sagemaker.Alpha.IEndpoint |
Go | github.com/aws/aws-cdk-go/awscdksagemakeralpha/v2#IEndpoint |
Java | software.amazon.awscdk.services.sagemaker.alpha.IEndpoint |
Python | aws_cdk.aws_sagemaker_alpha.IEndpoint |
TypeScript (source) | @aws-cdk/aws-sagemaker-alpha ยป IEndpoint |
Implemented by
Endpoint
Obtainable from
Endpoint
.fromEndpointArn()
, Endpoint
.fromEndpointAttributes()
, Endpoint
.fromEndpointName()
The Interface for a SageMaker Endpoint resource.
Properties
Name | Type | Description |
---|---|---|
endpoint | string | The ARN of the endpoint. |
endpoint | string | The name of the endpoint. |
env | Resource | 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:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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 |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Permits an IAM principal to invoke this endpoint. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
Invoke(grantee)
grantpublic grantInvoke(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
โ The principal to grant access to.
Returns
Permits an IAM principal to invoke this endpoint.