Class CfnEndpointConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:57.820Z") @Stability(Stable) public class CfnEndpointConfig extends CfnResource implements IInspectable, ITaggable
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()
                 .variantName("variantName")
                 // the properties below are optional
                 .acceleratorType("acceleratorType")
                 .containerStartupHealthCheckTimeoutInSeconds(123)
                 .enableSsmAccess(false)
                 .initialInstanceCount(123)
                 .initialVariantWeight(123)
                 .instanceType("instanceType")
                 .managedInstanceScaling(ManagedInstanceScalingProperty.builder()
                         .maxInstanceCount(123)
                         .minInstanceCount(123)
                         .status("status")
                         .build())
                 .modelDataDownloadTimeoutInSeconds(123)
                 .modelName("modelName")
                 .routingConfig(RoutingConfigProperty.builder()
                         .routingStrategy("routingStrategy")
                         .build())
                 .serverlessConfig(ServerlessConfigProperty.builder()
                         .maxConcurrency(123)
                         .memorySizeInMb(123)
                         // the properties below are optional
                         .provisionedConcurrency(123)
                         .build())
                 .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")
         .shadowProductionVariants(List.of(ProductionVariantProperty.builder()
                 .variantName("variantName")
                 // the properties below are optional
                 .acceleratorType("acceleratorType")
                 .containerStartupHealthCheckTimeoutInSeconds(123)
                 .enableSsmAccess(false)
                 .initialInstanceCount(123)
                 .initialVariantWeight(123)
                 .instanceType("instanceType")
                 .managedInstanceScaling(ManagedInstanceScalingProperty.builder()
                         .maxInstanceCount(123)
                         .minInstanceCount(123)
                         .status("status")
                         .build())
                 .modelDataDownloadTimeoutInSeconds(123)
                 .modelName("modelName")
                 .routingConfig(RoutingConfigProperty.builder()
                         .routingStrategy("routingStrategy")
                         .build())
                 .serverlessConfig(ServerlessConfigProperty.builder()
                         .maxConcurrency(123)
                         .memorySizeInMb(123)
                         // the properties below are optional
                         .provisionedConcurrency(123)
                         .build())
                 .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:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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)
      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

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrEndpointConfigName()
      The name of the endpoint configuration, such as MyEndpointConfiguration .
    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getProductionVariants

      @Stability(Stable) @NotNull public Object getProductionVariants()
      A list of ProductionVariant objects, one for each model that you want to host at this endpoint.
    • setProductionVariants

      @Stability(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(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(Stable) @Nullable public Object getAsyncInferenceConfig()
      Specifies configuration for how an endpoint performs asynchronous inference.
    • setAsyncInferenceConfig

      @Stability(Stable) public void setAsyncInferenceConfig(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getDataCaptureConfig()
      Specifies how to capture endpoint data for model monitor.
    • setDataCaptureConfig

      @Stability(Stable) public void setDataCaptureConfig(@Nullable IResolvable value)
      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

      @Stability(Stable) @Nullable public Object getEnableNetworkIsolation()
    • setEnableNetworkIsolation

      @Stability(Stable) public void setEnableNetworkIsolation(@Nullable Boolean value)
    • setEnableNetworkIsolation

      @Stability(Stable) public void setEnableNetworkIsolation(@Nullable IResolvable value)
    • getEndpointConfigName

      @Stability(Stable) @Nullable public String getEndpointConfigName()
      The name of the endpoint configuration.
    • setEndpointConfigName

      @Stability(Stable) public void setEndpointConfigName(@Nullable String value)
      The name of the endpoint configuration.
    • getExecutionRoleArn

      @Stability(Stable) @Nullable public String getExecutionRoleArn()
    • setExecutionRoleArn

      @Stability(Stable) public void setExecutionRoleArn(@Nullable String value)
    • getExplainerConfig

      @Stability(Stable) @Nullable public Object getExplainerConfig()
      A parameter to activate explainers.
    • setExplainerConfig

      @Stability(Stable) public void setExplainerConfig(@Nullable IResolvable value)
      A parameter to activate explainers.
    • setExplainerConfig

      @Stability(Stable) public void setExplainerConfig(@Nullable CfnEndpointConfig.ExplainerConfigProperty value)
      A parameter to activate explainers.
    • getKmsKeyId

      @Stability(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.
    • setKmsKeyId

      @Stability(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.
    • getShadowProductionVariants

      @Stability(Stable) @Nullable public Object getShadowProductionVariants()
      Array of ProductionVariant objects.
    • setShadowProductionVariants

      @Stability(Stable) public void setShadowProductionVariants(@Nullable IResolvable value)
      Array of ProductionVariant objects.
    • setShadowProductionVariants

      @Stability(Stable) public void setShadowProductionVariants(@Nullable List<Object> value)
      Array of ProductionVariant objects.
    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of key-value pairs to apply to this resource.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of key-value pairs to apply to this resource.
    • getVpcConfig

      @Stability(Stable) @Nullable public Object getVpcConfig()
    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable IResolvable value)
    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable CfnEndpointConfig.VpcConfigProperty value)