software.amazon.awscdk.services.sagemaker

Class CfnEndpointConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnEndpointConfig

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.877Z")
 @Stability(value=Stable)
public class CfnEndpointConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::EndpointConfig`.

The AWS::SageMaker::EndpointConfig resource creates a configuration for an Amazon SageMaker endpoint. For more information, see CreateEndpointConfig in the SageMaker Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnEndpointConfig cfnEndpointConfig = CfnEndpointConfig.Builder.create(this, "MyCfnEndpointConfig")
         .productionVariants(List.of(ProductionVariantProperty.builder()
                 .initialVariantWeight(123)
                 .modelName("modelName")
                 .variantName("variantName")
                 // the properties below are optional
                 .acceleratorType("acceleratorType")
                 .initialInstanceCount(123)
                 .instanceType("instanceType")
                 .serverlessConfig(ServerlessConfigProperty.builder()
                         .maxConcurrency(123)
                         .memorySizeInMb(123)
                         .build())
                 .build()))
         // the properties below are optional
         .asyncInferenceConfig(AsyncInferenceConfigProperty.builder()
                 .outputConfig(AsyncInferenceOutputConfigProperty.builder()
                         .s3OutputPath("s3OutputPath")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .notificationConfig(AsyncInferenceNotificationConfigProperty.builder()
                                 .errorTopic("errorTopic")
                                 .successTopic("successTopic")
                                 .build())
                         .build())
                 // the properties below are optional
                 .clientConfig(AsyncInferenceClientConfigProperty.builder()
                         .maxConcurrentInvocationsPerInstance(123)
                         .build())
                 .build())
         .dataCaptureConfig(DataCaptureConfigProperty.builder()
                 .captureOptions(List.of(CaptureOptionProperty.builder()
                         .captureMode("captureMode")
                         .build()))
                 .destinationS3Uri("destinationS3Uri")
                 .initialSamplingPercentage(123)
                 // the properties below are optional
                 .captureContentTypeHeader(CaptureContentTypeHeaderProperty.builder()
                         .csvContentTypes(List.of("csvContentTypes"))
                         .jsonContentTypes(List.of("jsonContentTypes"))
                         .build())
                 .enableCapture(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .endpointConfigName("endpointConfigName")
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnEndpointConfig.AsyncInferenceClientConfigProperty Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
static interface	CfnEndpointConfig.AsyncInferenceConfigProperty Specifies configuration for how an endpoint performs asynchronous inference.
static interface	CfnEndpointConfig.AsyncInferenceNotificationConfigProperty Specifies the configuration for notifications of inference results for asynchronous inference.
static interface	CfnEndpointConfig.AsyncInferenceOutputConfigProperty Specifies the configuration for asynchronous inference invocation outputs.
static class	CfnEndpointConfig.Builder A fluent builder for CfnEndpointConfig.
static interface	CfnEndpointConfig.CaptureContentTypeHeaderProperty Specifies the JSON and CSV content types of the data that the endpoint captures.
static interface	CfnEndpointConfig.CaptureOptionProperty Specifies whether the endpoint captures input data or output data.
static interface	CfnEndpointConfig.DataCaptureConfigProperty Specifies the configuration of your endpoint for model monitor data capture.
static interface	CfnEndpointConfig.ProductionVariantProperty Specifies a model that you want to host and the resources to deploy for hosting it.
static interface	CfnEndpointConfig.ServerlessConfigProperty Specifies the serverless configuration for an endpoint variant.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpointConfig(software.constructs.Construct scope, String id, CfnEndpointConfigProps props) Create a new `AWS::SageMaker::EndpointConfig`.
protected	CfnEndpointConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAsyncInferenceConfig() Specifies configuration for how an endpoint performs asynchronous inference.
String	getAttrEndpointConfigName() The name of the endpoint configuration, such as `MyEndpointConfiguration` .
protected Map<String,Object>	getCfnProperties()
Object	getDataCaptureConfig() Specifies how to capture endpoint data for model monitor.
String	getEndpointConfigName() The name of the endpoint configuration.
String	getKmsKeyId() The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
Object	getProductionVariants() A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
TagManager	getTags() A list of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAsyncInferenceConfig(CfnEndpointConfig.AsyncInferenceConfigProperty value) Specifies configuration for how an endpoint performs asynchronous inference.
void	setAsyncInferenceConfig(IResolvable value) Specifies configuration for how an endpoint performs asynchronous inference.
void	setDataCaptureConfig(CfnEndpointConfig.DataCaptureConfigProperty value) Specifies how to capture endpoint data for model monitor.
void	setDataCaptureConfig(IResolvable value) Specifies how to capture endpoint data for model monitor.
void	setEndpointConfigName(String value) The name of the endpoint configuration.
void	setKmsKeyId(String value) The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
void	setProductionVariants(IResolvable value) A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
void	setProductionVariants(List<Object> value) A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpointConfig

protected CfnEndpointConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpointConfig

protected CfnEndpointConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpointConfig

@Stability(value=Stable)
public CfnEndpointConfig(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnEndpointConfigProps props)

Create a new `AWS::SageMaker::EndpointConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpointConfigName

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointConfigName()

The name of the endpoint configuration, such as `MyEndpointConfiguration` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of key-value pairs to apply to this resource.

For more information, see Resource Tag and Using Cost Allocation Tags .

getProductionVariants

@Stability(value=Stable)
 @NotNull
public Object getProductionVariants()

A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.

setProductionVariants

@Stability(value=Stable)
public void setProductionVariants(@NotNull
                                                           IResolvable value)

A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.

setProductionVariants

@Stability(value=Stable)
public void setProductionVariants(@NotNull
                                                           List<Object> value)

A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.

getAsyncInferenceConfig

@Stability(value=Stable)
 @Nullable
public Object getAsyncInferenceConfig()

Specifies configuration for how an endpoint performs asynchronous inference.

setAsyncInferenceConfig

@Stability(value=Stable)
public void setAsyncInferenceConfig(@Nullable
                                                             CfnEndpointConfig.AsyncInferenceConfigProperty value)

Specifies configuration for how an endpoint performs asynchronous inference.

setAsyncInferenceConfig

@Stability(value=Stable)
public void setAsyncInferenceConfig(@Nullable
                                                             IResolvable value)

Specifies configuration for how an endpoint performs asynchronous inference.

getDataCaptureConfig

@Stability(value=Stable)
 @Nullable
public Object getDataCaptureConfig()

Specifies how to capture endpoint data for model monitor.

The data capture configuration applies to all production variants hosted at the endpoint.

setDataCaptureConfig

@Stability(value=Stable)
public void setDataCaptureConfig(@Nullable
                                                          CfnEndpointConfig.DataCaptureConfigProperty value)

Specifies how to capture endpoint data for model monitor.

The data capture configuration applies to all production variants hosted at the endpoint.

setDataCaptureConfig

@Stability(value=Stable)
public void setDataCaptureConfig(@Nullable
                                                          IResolvable value)

Specifies how to capture endpoint data for model monitor.

The data capture configuration applies to all production variants hosted at the endpoint.

getEndpointConfigName

@Stability(value=Stable)
 @Nullable
public String getEndpointConfigName()

The name of the endpoint configuration.

setEndpointConfigName

@Stability(value=Stable)
public void setEndpointConfigName(@Nullable
                                                           String value)

The name of the endpoint configuration.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint , UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
• Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• Alias name: alias/ExampleAlias
• Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint , UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .