generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / CustomSageMakerEndpoint

Class: CustomSageMakerEndpoint

Extends

Implements

Constructors

new CustomSageMakerEndpoint()

new CustomSageMakerEndpoint(scope, id, props): CustomSageMakerEndpoint

Parameters

scope

Construct

id

string

props

CustomSageMakerEndpointProps

Returns

CustomSageMakerEndpoint

Overrides

SageMakerEndpointBase.constructor

Properties

cfnEndpoint

readonly cfnEndpoint: CfnEndpoint

cfnEndpointConfig

readonly cfnEndpointConfig: CfnEndpointConfig

cfnModel

readonly cfnModel: CfnModel

constructUsageMetric

readonly constructUsageMetric: "uksb-1tupboc45" = 'uksb-1tupboc45'

construct usage metric , added in template description

Inherited from

SageMakerEndpointBase.constructUsageMetric

enablexray

enablexray: boolean = true

enable disable xray tracing

Default

- True

Inherited from

SageMakerEndpointBase.enablexray

endpointArn

readonly endpointArn: string

errorTopic?

readonly optional errorTopic: Topic

fieldLogLevel

fieldLogLevel: FieldLogLevel = appsync.FieldLogLevel.ALL

Default log config for all constructs

Inherited from

SageMakerEndpointBase.fieldLogLevel

grantPrincipal

readonly grantPrincipal: IPrincipal

The principal to grant permissions to

Implementation of

iam.IGrantable.grantPrincipal

instanceCount

readonly instanceCount: number

instanceType?

readonly optional instanceType: SageMakerInstanceType

lambdaTracing

lambdaTracing: Tracing = lambda.Tracing.ACTIVE

enable disable lambda tracing

Default

- Active

Inherited from

SageMakerEndpointBase.lambdaTracing

modelDataDownloadTimeoutInSeconds

readonly modelDataDownloadTimeoutInSeconds: number

modelDataUrl

readonly modelDataUrl: string

modelId

readonly modelId: string

node

readonly node: Node

The tree node.

Inherited from

SageMakerEndpointBase.node

retention

retention: RetentionDays = logs.RetentionDays.TEN_YEARS

Default log retention config for all constructs

Inherited from

SageMakerEndpointBase.retention

role

readonly role: Role

scalingPolicy

readonly scalingPolicy: StepScalingPolicy

stage

stage: string

Value will be appended to resources name.

Default

- _dev

Inherited from

SageMakerEndpointBase.stage

successTopic?

readonly optional successTopic: Topic

usageMetricMap

protected static usageMetricMap: Record<string, number>

Record<string, number> , maps construct name with number of deployments

Inherited from

SageMakerEndpointBase.usageMetricMap

Methods

addObservabilityToConstruct()

protected addObservabilityToConstruct(props): void

Parameters

props

BaseClassProps

Returns

void

Inherited from

SageMakerEndpointBase.addObservabilityToConstruct

addToRolePolicy()

addToRolePolicy(statement): void

Parameters

statement

PolicyStatement

Returns

void

createSageMakerRole()

protected createSageMakerRole(): Role

Returns

Role

Inherited from

SageMakerEndpointBase.createSageMakerRole

grantInvoke()

grantInvoke(grantee): Grant

Parameters

grantee

IGrantable

Returns

Grant

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

SageMakerEndpointBase.toString

updateConstructUsageMetricCode()

protected updateConstructUsageMetricCode(props, scope, lambdaFunctions): void

Parameters

props

BaseClassProps

scope

Construct

lambdaFunctions

DockerImageFunction[]

Returns

void

Inherited from

SageMakerEndpointBase.updateConstructUsageMetricCode

updateEnvSuffix()

protected updateEnvSuffix(props): void

Parameters

props

BaseClassProps

Returns

void

Inherited from

SageMakerEndpointBase.updateEnvSuffix

isConstruct()

static isConstruct(x): x is Construct

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

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

SageMakerEndpointBase.isConstruct

This site is open source. Improve this page.