Class Endpoint

(experimental) Defines a SageMaker endpoint.

Inheritance

System.Object

Resource

Endpoint

Implements

IEndpoint

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Sagemaker.Alpha

Assembly: Amazon.CDK.AWS.Sagemaker.Alpha.dll

Syntax (csharp)

public class Endpoint : Resource, IEndpoint, IEndpoint, IResource

Syntax (vb)

Public Class Endpoint
    Inherits Resource
    Implements IEndpoint, IEndpoint, IResource

Remarks

Stability: Experimental

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Sagemaker.Alpha;

EndpointConfig endpointConfig;


var endpoint = new Endpoint(this, "Endpoint", new EndpointProps { EndpointConfig = endpointConfig });
var productionVariant = endpoint.FindInstanceProductionVariant("my-variant");
productionVariant.MetricModelLatency().CreateAlarm(this, "ModelLatencyAlarm", new CreateAlarmOptions {
    Threshold = 100000,
    EvaluationPeriods = 3
});

Synopsis

Constructors

Endpoint(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Endpoint(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Endpoint(Construct, String, IEndpointProps)

Properties

EndpointArn	(experimental) The ARN of the endpoint.
EndpointName	(experimental) The name of the endpoint.
InstanceProductionVariants	(experimental) Get instance production variants associated with endpoint.

Methods

FindInstanceProductionVariant(String)	(experimental) Find instance production variant based on variant name.
FromEndpointArn(Construct, String, String)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
FromEndpointAttributes(Construct, String, IEndpointAttributes)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
FromEndpointName(Construct, String, String)	(experimental) Imports an Endpoint defined either outside the CDK or in a different CDK stack.
GrantInvoke(IGrantable)	(experimental) Permits an IAM principal to invoke this endpoint.

Constructors

Endpoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Endpoint(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

Endpoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Endpoint(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Endpoint(Construct, String, IEndpointProps)

public Endpoint(Construct scope, string id, IEndpointProps props)

Parameters

scope Constructs.Construct
id System.String
props IEndpointProps

Remarks

Stability: Experimental

Properties

EndpointArn

(experimental) The ARN of the endpoint.

public virtual string EndpointArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

EndpointName

(experimental) The name of the endpoint.

public virtual string EndpointName { get; }

Property Value

System.String

Remarks

Stability: Experimental

Attribute: true

InstanceProductionVariants

(experimental) Get instance production variants associated with endpoint.

public virtual IEndpointInstanceProductionVariant[] InstanceProductionVariants { get; }

Property Value

IEndpointInstanceProductionVariant[]

Remarks

Stability: Experimental

Methods

FindInstanceProductionVariant(String)

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

public virtual IEndpointInstanceProductionVariant FindInstanceProductionVariant(string name)

Parameters

name System.String: Variant name from production variant.

Returns

IEndpointInstanceProductionVariant

Remarks

Stability: Experimental

FromEndpointArn(Construct, String, String)

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

public static IEndpoint FromEndpointArn(Construct scope, string id, string endpointArn)

Parameters

scope Constructs.Construct: the Construct scope.
id System.String: the resource id.
endpointArn System.String: the ARN of the endpoint.

Returns

IEndpoint

Remarks

Stability: Experimental

FromEndpointAttributes(Construct, String, IEndpointAttributes)

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

public static IEndpoint FromEndpointAttributes(Construct scope, string id, IEndpointAttributes attrs)

Parameters

scope Constructs.Construct: the Construct scope.
id System.String: the resource id.
attrs IEndpointAttributes: the attributes of the endpoint to import.

Returns

IEndpoint

Remarks

Stability: Experimental

FromEndpointName(Construct, String, String)

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

public static IEndpoint FromEndpointName(Construct scope, string id, string endpointName)

Parameters

scope Constructs.Construct: the Construct scope.
id System.String: the resource id.
endpointName System.String: the name of the endpoint.

Returns

IEndpoint

Remarks

Stability: Experimental

GrantInvoke(IGrantable)

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

public virtual Grant GrantInvoke(IGrantable grantee)

Parameters

grantee IGrantable: The principal to grant access to.

Returns

Grant

Remarks

Stability: Experimental

Implements

IEndpoint

IResource

Constructs.IConstruct

Constructs.IDependable