Package software.amazon.awscdk.services.sagemaker

Class CfnEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnEndpoint
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.152Z") @Stability(Stable) public class CfnEndpoint extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::Endpoint.

Use the AWS::SageMaker::Endpoint resource to create an endpoint using the specified configuration in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the AWS::SageMaker::EndpointConfig resource. For more information, see Deploy a Model on Amazon SageMaker Hosting Services in the Amazon 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.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .endpointConfigName("endpointConfigName")
         // the properties below are optional
         .deploymentConfig(DeploymentConfigProperty.builder()
                 .blueGreenUpdatePolicy(BlueGreenUpdatePolicyProperty.builder()
                         .trafficRoutingConfiguration(TrafficRoutingConfigProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .canarySize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .linearStepSize(CapacitySizeProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .waitIntervalInSeconds(123)
                                 .build())
                         // the properties below are optional
                         .maximumExecutionTimeoutInSeconds(123)
                         .terminationWaitInSeconds(123)
                         .build())
                 // the properties below are optional
                 .autoRollbackConfiguration(AutoRollbackConfigProperty.builder()
                         .alarms(List.of(AlarmProperty.builder()
                                 .alarmName("alarmName")
                                 .build()))
                         .build())
                 .build())
         .endpointName("endpointName")
         .excludeRetainedVariantProperties(List.of(VariantPropertyProperty.builder()
                 .variantPropertyType("variantPropertyType")
                 .build()))
         .retainAllVariantProperties(false)
         .retainDeploymentConfig(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnEndpoint

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

    • CfnEndpoint

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

    • CfnEndpoint

      @Stability(Stable) public CfnEndpoint(@NotNull Construct scope, @NotNull String id, @NotNull CfnEndpointProps props)
      Create a new AWS::SageMaker::Endpoint.

      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 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.

    • getAttrEndpointName

      @Stability(Stable) @NotNull public String getAttrEndpointName()
      The name of the endpoint, such as MyEndpoint .

    • getCfnProperties

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

    • getTags

      @Stability(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 in the AWS Billing and Cost Management User Guide .

    • getEndpointConfigName

      @Stability(Stable) @NotNull public String getEndpointConfigName()
      The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .

    • setEndpointConfigName

      @Stability(Stable) public void setEndpointConfigName(@NotNull String value)
      The name of the AWS::SageMaker::EndpointConfig resource that specifies the configuration for the endpoint. For more information, see CreateEndpointConfig .

    • getDeploymentConfig

      @Stability(Stable) @Nullable public Object getDeploymentConfig()
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

    • setDeploymentConfig

      @Stability(Stable) public void setDeploymentConfig(@Nullable IResolvable value)
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

    • setDeploymentConfig

      @Stability(Stable) public void setDeploymentConfig(@Nullable CfnEndpoint.DeploymentConfigProperty value)
      The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

    • getEndpointName

      @Stability(Stable) @Nullable public String getEndpointName()
      The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in .

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@Nullable String value)
      The name of the endpoint.The name must be unique within an AWS Region in your AWS account. The name is case-insensitive in CreateEndpoint , but the case is preserved and must be matched in .

    • getExcludeRetainedVariantProperties

      @Stability(Stable) @Nullable public Object getExcludeRetainedVariantProperties()
      When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don't specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don't use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

    • setExcludeRetainedVariantProperties

      @Stability(Stable) public void setExcludeRetainedVariantProperties(@Nullable IResolvable value)
      When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don't specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don't use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

    • setExcludeRetainedVariantProperties

      @Stability(Stable) public void setExcludeRetainedVariantProperties(@Nullable List<Object> value)
      When you are updating endpoint resources with RetainAllVariantProperties whose value is set to true , ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig . If you don't specify a value for ExcludeAllVariantProperties , no variant properties are overridden. Don't use this property when creating new endpoint resources or when RetainAllVariantProperties is set to false .

    • getRetainAllVariantProperties

      @Stability(Stable) @Nullable public Object getRetainAllVariantProperties()
      When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

      To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

    • setRetainAllVariantProperties

      @Stability(Stable) public void setRetainAllVariantProperties(@Nullable Boolean value)
      When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

      To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

    • setRetainAllVariantProperties

      @Stability(Stable) public void setRetainAllVariantProperties(@Nullable IResolvable value)
      When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight.

      To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true . To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false . Use this property only when updating endpoint resources, not when creating new endpoint resources.

    • getRetainDeploymentConfig

      @Stability(Stable) @Nullable public Object getRetainDeploymentConfig()
      Specifies whether to reuse the last deployment configuration.

      The default value is false (the configuration is not reused).

    • setRetainDeploymentConfig

      @Stability(Stable) public void setRetainDeploymentConfig(@Nullable Boolean value)
      Specifies whether to reuse the last deployment configuration.

      The default value is false (the configuration is not reused).

    • setRetainDeploymentConfig

      @Stability(Stable) public void setRetainDeploymentConfig(@Nullable IResolvable value)
      Specifies whether to reuse the last deployment configuration.

      The default value is false (the configuration is not reused).