EndpointConfig

class aws_cdk.aws_sagemaker_alpha.EndpointConfig(scope, id, *, encryption_key=None, endpoint_config_name=None, instance_production_variants=None)

Bases: Resource

(experimental) Defines a SageMaker EndpointConfig.

Stability:: experimental
ExampleMetadata:: infused

Example:

import aws_cdk.aws_sagemaker_alpha as sagemaker

# model_a: sagemaker.Model
# model_b: sagemaker.Model


endpoint_config = sagemaker.EndpointConfig(self, "EndpointConfig",
    instance_production_variants=[sagemaker.InstanceProductionVariantProps(
        model=model_a,
        variant_name="modelA",
        initial_variant_weight=2
    ), sagemaker.InstanceProductionVariantProps(
        model=model_b,
        variant_name="variantB",
        initial_variant_weight=1
    )
    ]
)

Parameters:

scope (Construct) –
id (str) –
encryption_key (Optional[IKey]) – (experimental) Optional KMS encryption key associated with this stream. Default: - none
endpoint_config_name (Optional[str]) – (experimental) Name of the endpoint configuration. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the endpoint configuration’s name.
instance_production_variants (Optional[Sequence[Union[InstanceProductionVariantProps, Dict[str, Any]]]]) – (experimental) A list of instance production variants. You can always add more variants later by calling EndpointConfig#addInstanceProductionVariant. Default: - none

Stability:

experimental

Methods

add_instance_production_variant(*, model, variant_name, accelerator_type=None, initial_instance_count=None, initial_variant_weight=None, instance_type=None)

(experimental) Add production variant to the endpoint configuration.

Parameters:

model (IModel) – (experimental) The model to host.
variant_name (str) – (experimental) Name of the production variant.
accelerator_type (Optional[AcceleratorType]) – (experimental) The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. Default: - none
initial_instance_count (Union[int, float, None]) – (experimental) Number of instances to launch initially. Default: 1
initial_variant_weight (Union[int, float, None]) – (experimental) Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the variant weight to the sum of all variant weight values across all production variants. Default: 1.0
instance_type (Optional[InstanceType]) – (experimental) Instance type of the production variant. Default: InstanceType.T2_MEDIUM

Stability:

experimental

Return type:

None

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

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

endpoint_config_arn

(experimental) The ARN of the endpoint configuration.

Stability:: experimental

endpoint_config_name

(experimental) The name of the endpoint configuration.

Stability:: experimental

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.

node: The tree node.

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

Static Methods

classmethod from_endpoint_config_arn(scope, id, endpoint_config_arn)

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

Parameters:

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

Stability:

experimental

Return type:

IEndpointConfig

classmethod from_endpoint_config_name(scope, id, endpoint_config_name)

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

Parameters:

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

Stability:

experimental

Return type:

IEndpointConfig

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