Endpoint

class aws_cdk.aws_sagemaker_alpha.Endpoint(scope, id, *, endpoint_config, endpoint_name=None)

Bases: Resource

(experimental) Defines a SageMaker endpoint.

Stability:: experimental
ExampleMetadata:: infused

Example:

import aws_cdk.aws_sagemaker_alpha as sagemaker

# endpoint_config: sagemaker.EndpointConfig


endpoint = sagemaker.Endpoint(self, "Endpoint", endpoint_config=endpoint_config)
production_variant = endpoint.find_instance_production_variant("my-variant")
production_variant.metric_model_latency().create_alarm(self, "ModelLatencyAlarm",
    threshold=100000,
    evaluation_periods=3
)

Parameters:

scope (Construct) –
id (str) –
endpoint_config (IEndpointConfig) – (experimental) The endpoint configuration to use for this endpoint.
endpoint_name (Optional[str]) – (experimental) Name of the endpoint. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the endpoint’s name.

Stability:

experimental

Methods

apply_removal_policy(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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

find_instance_production_variant(name)

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

Parameters:: name (str) – Variant name from production variant.
Stability:: experimental
Return type:: IEndpointInstanceProductionVariant

grant_invoke(grantee)

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

Parameters:: grantee (IGrantable) – The principal to grant access to.
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

endpoint_arn

(experimental) The ARN of the endpoint.

Stability:: experimental
Attribute:: true

endpoint_name

(experimental) The name of the endpoint.

Stability:: experimental
Attribute:: true

env

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.

instance_production_variants

(experimental) Get instance production variants associated with endpoint.

Stability:: experimental

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_endpoint_arn(scope, id, endpoint_arn)

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

Parameters:

scope (Construct) – the Construct scope.
id (str) – the resource id.
endpoint_arn (str) – the ARN of the endpoint.

Stability:

experimental

Return type:

IEndpoint

classmethod from_endpoint_attributes(scope, id, *, endpoint_arn)

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

Parameters:

scope (Construct) – the Construct scope.
id (str) – the resource id.
endpoint_arn (str) – (experimental) The ARN of this endpoint.

Stability:

experimental

Return type:

IEndpoint

classmethod from_endpoint_name(scope, id, endpoint_name)

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

Parameters:

scope (Construct) – the Construct scope.
id (str) – the resource id.
endpoint_name (str) – the name of the endpoint.

Stability:

experimental

Return type:

IEndpoint

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool