Class CfnEndpointConfig
- All Implemented Interfaces:
IInspectable,IEnvironmentAware,IEndpointConfigRef,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
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()
.variantName("variantName")
// the properties below are optional
.acceleratorType("acceleratorType")
.capacityReservationConfig(CapacityReservationConfigProperty.builder()
.capacityReservationPreference("capacityReservationPreference")
.mlReservationArn("mlReservationArn")
.build())
.containerStartupHealthCheckTimeoutInSeconds(123)
.coreDumpConfig(CoreDumpConfigProperty.builder()
.destinationS3Uri("destinationS3Uri")
// the properties below are optional
.kmsKeyId("kmsKeyId")
.build())
.enableSsmAccess(false)
.inferenceAmiVersion("inferenceAmiVersion")
.initialInstanceCount(123)
.initialVariantWeight(123)
.instancePools(List.of(InstancePoolProperty.builder()
.instanceType("instanceType")
.priority(123)
// the properties below are optional
.modelNameOverride("modelNameOverride")
.build()))
.instanceType("instanceType")
.managedInstanceScaling(ManagedInstanceScalingProperty.builder()
.maxInstanceCount(123)
.minInstanceCount(123)
.scaleInPolicy(ScaleInPolicyProperty.builder()
.strategy("strategy")
// the properties below are optional
.cooldownInMinutes(123)
.maximumStepSize(123)
.build())
.status("status")
.build())
.modelDataDownloadTimeoutInSeconds(123)
.modelName("modelName")
.routingConfig(RoutingConfigProperty.builder()
.prefixAwareRoutingConfig(PrefixAwareRoutingConfigProperty.builder()
.concurrencyThreshold(123)
.prefixLength(123)
.build())
.routingStrategy("routingStrategy")
.build())
.serverlessConfig(ServerlessConfigProperty.builder()
.maxConcurrency(123)
.memorySizeInMb(123)
// the properties below are optional
.provisionedConcurrency(123)
.build())
.variantInstanceProvisionTimeoutInSeconds(123)
.volumeSizeInGb(123)
.build()))
// the properties below are optional
.asyncInferenceConfig(AsyncInferenceConfigProperty.builder()
.outputConfig(AsyncInferenceOutputConfigProperty.builder()
.kmsKeyId("kmsKeyId")
.notificationConfig(AsyncInferenceNotificationConfigProperty.builder()
.errorTopic("errorTopic")
.includeInferenceResponseIn(List.of("includeInferenceResponseIn"))
.successTopic("successTopic")
.build())
.s3FailurePath("s3FailurePath")
.s3OutputPath("s3OutputPath")
.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())
.enableNetworkIsolation(false)
.endpointConfigName("endpointConfigName")
.executionRoleArn("executionRoleArn")
.explainerConfig(ExplainerConfigProperty.builder()
.clarifyExplainerConfig(ClarifyExplainerConfigProperty.builder()
.shapConfig(ClarifyShapConfigProperty.builder()
.shapBaselineConfig(ClarifyShapBaselineConfigProperty.builder()
.mimeType("mimeType")
.shapBaseline("shapBaseline")
.shapBaselineUri("shapBaselineUri")
.build())
// the properties below are optional
.numberOfSamples(123)
.seed(123)
.textConfig(ClarifyTextConfigProperty.builder()
.granularity("granularity")
.language("language")
.build())
.useLogit(false)
.build())
// the properties below are optional
.enableExplanations("enableExplanations")
.inferenceConfig(ClarifyInferenceConfigProperty.builder()
.contentTemplate("contentTemplate")
.featureHeaders(List.of("featureHeaders"))
.featuresAttribute("featuresAttribute")
.featureTypes(List.of("featureTypes"))
.labelAttribute("labelAttribute")
.labelHeaders(List.of("labelHeaders"))
.labelIndex(123)
.maxPayloadInMb(123)
.maxRecordCount(123)
.probabilityAttribute("probabilityAttribute")
.probabilityIndex(123)
.build())
.build())
.build())
.kmsKeyId("kmsKeyId")
.metricsConfig(MetricsConfigProperty.builder()
.enableDetailedObservability(false)
.enableEnhancedMetrics(false)
.metricPublishFrequencyInSeconds(123)
.build())
.shadowProductionVariants(List.of(ProductionVariantProperty.builder()
.variantName("variantName")
// the properties below are optional
.acceleratorType("acceleratorType")
.capacityReservationConfig(CapacityReservationConfigProperty.builder()
.capacityReservationPreference("capacityReservationPreference")
.mlReservationArn("mlReservationArn")
.build())
.containerStartupHealthCheckTimeoutInSeconds(123)
.coreDumpConfig(CoreDumpConfigProperty.builder()
.destinationS3Uri("destinationS3Uri")
// the properties below are optional
.kmsKeyId("kmsKeyId")
.build())
.enableSsmAccess(false)
.inferenceAmiVersion("inferenceAmiVersion")
.initialInstanceCount(123)
.initialVariantWeight(123)
.instancePools(List.of(InstancePoolProperty.builder()
.instanceType("instanceType")
.priority(123)
// the properties below are optional
.modelNameOverride("modelNameOverride")
.build()))
.instanceType("instanceType")
.managedInstanceScaling(ManagedInstanceScalingProperty.builder()
.maxInstanceCount(123)
.minInstanceCount(123)
.scaleInPolicy(ScaleInPolicyProperty.builder()
.strategy("strategy")
// the properties below are optional
.cooldownInMinutes(123)
.maximumStepSize(123)
.build())
.status("status")
.build())
.modelDataDownloadTimeoutInSeconds(123)
.modelName("modelName")
.routingConfig(RoutingConfigProperty.builder()
.prefixAwareRoutingConfig(PrefixAwareRoutingConfigProperty.builder()
.concurrencyThreshold(123)
.prefixLength(123)
.build())
.routingStrategy("routingStrategy")
.build())
.serverlessConfig(ServerlessConfigProperty.builder()
.maxConcurrency(123)
.memorySizeInMb(123)
// the properties below are optional
.provisionedConcurrency(123)
.build())
.variantInstanceProvisionTimeoutInSeconds(123)
.volumeSizeInGb(123)
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnets(List.of("subnets"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceConfigures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.static interfaceSpecifies configuration for how an endpoint performs asynchronous inference.static interfaceSpecifies the configuration for notifications of inference results for asynchronous inference.static interfaceSpecifies the configuration for asynchronous inference invocation outputs.static final classA fluent builder forCfnEndpointConfig.static interfaceSettings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.static interfaceSpecifies the JSON and CSV content types of the data that the endpoint captures.static interfaceSpecifies whether the endpoint captures input data or output data.static interfaceThe configuration parameters for the SageMaker Clarify explainer.static interfaceThe inference configuration parameter for the model container.static interfaceThe configuration for the SHAP baseline (also called the background or reference dataset) of the Kernal SHAP algorithm.static interfaceThe configuration for SHAP analysis using SageMaker Clarify Explainer.static interfaceA parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text.static interfaceSpecifies where SageMaker writes core dumps from the model container when the process crashes, and how it encrypts them.static interfaceSpecifies the configuration of your endpoint for model monitor data capture.static interfaceA parameter to activate explainers.static interfaceSpecifies an instance type and its priority for a heterogeneous endpoint.static interfaceSettings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.static interfaceSpecifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.static interfaceThe configuration for prefix-aware routing on a SageMaker real-time inference endpoint.static interfaceSpecifies a model that you want to host and the resources to deploy for hosting it.static interfaceSettings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.static interfaceSpecifies how the endpoint releases instances when managed instance scaling scales in.static interfaceSpecifies the serverless configuration for an endpoint variant.static interfaceSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.sagemaker.IEndpointConfigRef
IEndpointConfigRef.Jsii$Default, IEndpointConfigRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnEndpointConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnEndpointConfig(software.amazon.jsii.JsiiObjectRef objRef) CfnEndpointConfig(software.constructs.Construct scope, String id, CfnEndpointConfigProps props) Create a newAWS::SageMaker::EndpointConfig. -
Method Summary
Modifier and TypeMethodDescriptionstatic StringarnForEndpointConfig(IEndpointConfigRef resource) Specifies configuration for how an endpoint performs asynchronous inference.The Amazon Resource Name (ARN) of the endpoint configuration.The name of the endpoint configuration, such asMyEndpointConfiguration.Specifies how to capture endpoint data for model monitor.Sets whether all model containers deployed to the endpoint are isolated.The name of the endpoint configuration.A reference to a EndpointConfig resource.The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf.A parameter to activate explainers.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.Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.A list ofProductionVariantobjects, one for each model that you want to host at this endpoint.Array ofProductionVariantobjects.getTags()Tag Manager which manages the tags for this resource.A list of key-value pairs to apply to this resource.Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnEndpointConfig.renderProperties(Map<String, Object> props) voidSpecifies configuration for how an endpoint performs asynchronous inference.voidSpecifies configuration for how an endpoint performs asynchronous inference.voidsetDataCaptureConfig(IResolvable value) Specifies how to capture endpoint data for model monitor.voidSpecifies how to capture endpoint data for model monitor.voidsetEnableNetworkIsolation(Boolean value) Sets whether all model containers deployed to the endpoint are isolated.voidSets whether all model containers deployed to the endpoint are isolated.voidsetEndpointConfigName(String value) The name of the endpoint configuration.voidsetExecutionRoleArn(String value) The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf.voidsetExplainerConfig(IResolvable value) A parameter to activate explainers.voidA parameter to activate explainers.voidsetKmsKeyId(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.voidsetMetricsConfig(IResolvable value) Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.voidSpecifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.voidsetProductionVariants(List<Object> value) A list ofProductionVariantobjects, one for each model that you want to host at this endpoint.voidsetProductionVariants(IResolvable value) A list ofProductionVariantobjects, one for each model that you want to host at this endpoint.voidsetShadowProductionVariants(List<Object> value) Array ofProductionVariantobjects.voidArray ofProductionVariantobjects.voidsetTagsRaw(List<CfnTag> value) A list of key-value pairs to apply to this resource.voidsetVpcConfig(IResolvable value) Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.voidSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, withMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNode, withMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnEndpointConfig
protected CfnEndpointConfig(software.amazon.jsii.JsiiObjectRef objRef) -
CfnEndpointConfig
protected CfnEndpointConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnEndpointConfig
@Stability(Stable) public CfnEndpointConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEndpointConfigProps props) Create a newAWS::SageMaker::EndpointConfig.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
arnForEndpointConfig
@Stability(Stable) @NotNull public static String arnForEndpointConfig(@NotNull IEndpointConfigRef resource) - Parameters:
resource- This parameter is required.
-
isCfnEndpointConfig
Checks whether the given object is a CfnEndpointConfig.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- Parameters:
inspector- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrEndpointConfigArn
The Amazon Resource Name (ARN) of the endpoint configuration. -
getAttrEndpointConfigName
The name of the endpoint configuration, such asMyEndpointConfiguration. -
getAttrId
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getCfnPropertyNames
- Overrides:
getCfnPropertyNamesin classCfnResource
-
getEndpointConfigRef
A reference to a EndpointConfig resource.- Specified by:
getEndpointConfigRefin interfaceIEndpointConfigRef
-
getTags
Tag Manager which manages the tags for this resource. -
getProductionVariants
A list ofProductionVariantobjects, one for each model that you want to host at this endpoint.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnEndpointConfig.ProductionVariantProperty> -
setProductionVariants
A list ofProductionVariantobjects, one for each model that you want to host at this endpoint. -
setProductionVariants
A list ofProductionVariantobjects, one for each model that you want to host at this endpoint. -
getAsyncInferenceConfig
Specifies configuration for how an endpoint performs asynchronous inference.Returns union: either
IResolvableorCfnEndpointConfig.AsyncInferenceConfigProperty -
setAsyncInferenceConfig
Specifies configuration for how an endpoint performs asynchronous inference. -
setAsyncInferenceConfig
@Stability(Stable) public void setAsyncInferenceConfig(@Nullable CfnEndpointConfig.AsyncInferenceConfigProperty value) Specifies configuration for how an endpoint performs asynchronous inference. -
getDataCaptureConfig
Specifies how to capture endpoint data for model monitor.Returns union: either
IResolvableorCfnEndpointConfig.DataCaptureConfigProperty -
setDataCaptureConfig
Specifies how to capture endpoint data for model monitor. -
setDataCaptureConfig
@Stability(Stable) public void setDataCaptureConfig(@Nullable CfnEndpointConfig.DataCaptureConfigProperty value) Specifies how to capture endpoint data for model monitor. -
getEnableNetworkIsolation
Sets whether all model containers deployed to the endpoint are isolated.Returns union: either
BooleanorIResolvable -
setEnableNetworkIsolation
Sets whether all model containers deployed to the endpoint are isolated. -
setEnableNetworkIsolation
Sets whether all model containers deployed to the endpoint are isolated. -
getEndpointConfigName
The name of the endpoint configuration. -
setEndpointConfigName
The name of the endpoint configuration. -
getExecutionRoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. -
setExecutionRoleArn
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI can assume to perform actions on your behalf. -
getExplainerConfig
A parameter to activate explainers.Returns union: either
IResolvableorCfnEndpointConfig.ExplainerConfigProperty -
setExplainerConfig
A parameter to activate explainers. -
setExplainerConfig
@Stability(Stable) public void setExplainerConfig(@Nullable CfnEndpointConfig.ExplainerConfigProperty value) A parameter to activate explainers. -
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. -
setKmsKeyId
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. -
getMetricsConfig
Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics.Returns union: either
IResolvableorCfnEndpointConfig.MetricsConfigProperty -
setMetricsConfig
Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics. -
setMetricsConfig
@Stability(Stable) public void setMetricsConfig(@Nullable CfnEndpointConfig.MetricsConfigProperty value) Specifies the metrics that the endpoint publishes to Amazon CloudWatch, the frequency of publication, and whether to enable enhanced or detailed observability metrics. -
getShadowProductionVariants
Array ofProductionVariantobjects.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnEndpointConfig.ProductionVariantProperty> -
setShadowProductionVariants
Array ofProductionVariantobjects. -
setShadowProductionVariants
Array ofProductionVariantobjects. -
getTagsRaw
A list of key-value pairs to apply to this resource. -
setTagsRaw
A list of key-value pairs to apply to this resource. -
getVpcConfig
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.Returns union: either
IResolvableorCfnEndpointConfig.VpcConfigProperty -
setVpcConfig
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. -
setVpcConfig
Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.
-