Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.202Z") @Stability(Stable) public interface CfnEndpointProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnEndpoint.

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.*;
 CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder()
         .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();

  • Method Details

    • getEndpointConfigName

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

    • getDeploymentConfig

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

    • getEndpointName

      @Stability(Stable) @Nullable default 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 .

    • getExcludeRetainedVariantProperties

      @Stability(Stable) @Nullable default 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 .

    • getRetainAllVariantProperties

      @Stability(Stable) @Nullable default 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.

    • getRetainDeploymentConfig

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

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

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> 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 .

    • builder

      @Stability(Stable) static CfnEndpointProps.Builder builder()
      Returns:
      a CfnEndpointProps.Builder of CfnEndpointProps