Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpoint.DeploymentConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.DeploymentConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static interface CfnEndpoint.DeploymentConfigProperty
extends software.amazon.jsii.JsiiSerializable

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

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.*;
 DeploymentConfigProperty deploymentConfigProperty = DeploymentConfigProperty.builder()
         .autoRollbackConfiguration(AutoRollbackConfigProperty.builder()
                 .alarms(List.of(AlarmProperty.builder()
                         .alarmName("alarmName")
                         .build()))
                 .build())
         .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())
         .rollingUpdatePolicy(RollingUpdatePolicyProperty.builder()
                 .maximumBatchSize(CapacitySizeProperty.builder()
                         .type("type")
                         .value(123)
                         .build())
                 .waitIntervalInSeconds(123)
                 // the properties below are optional
                 .maximumExecutionTimeoutInSeconds(123)
                 .rollbackMaximumBatchSize(CapacitySizeProperty.builder()
                         .type("type")
                         .value(123)
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpoint.DeploymentConfigProperty.Builder	A builder for CfnEndpoint.DeploymentConfigProperty
static final class	CfnEndpoint.DeploymentConfigProperty.Jsii$Proxy	An implementation for CfnEndpoint.DeploymentConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.DeploymentConfigProperty.Builder	builder()
default Object	getAutoRollbackConfiguration()	Automatic rollback configuration for handling endpoint deployment failures and recovery.
default Object	getBlueGreenUpdatePolicy()	Update policy for a blue/green deployment.
default Object	getRollingUpdatePolicy()	Specifies a rolling deployment strategy for updating a SageMaker endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoRollbackConfiguration

@Stability(Stable)
@Nullable
default Object getAutoRollbackConfiguration()

Automatic rollback configuration for handling endpoint deployment failures and recovery.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-autorollbackconfiguration

getBlueGreenUpdatePolicy

@Stability(Stable)
@Nullable
default Object getBlueGreenUpdatePolicy()

Update policy for a blue/green deployment.

If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-bluegreenupdatepolicy

getRollingUpdatePolicy

@Stability(Stable)
@Nullable
default Object getRollingUpdatePolicy()

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpoint-deploymentconfig.html#cfn-sagemaker-endpoint-deploymentconfig-rollingupdatepolicy

builder

@Stability(Stable)
static CfnEndpoint.DeploymentConfigProperty.Builder builder()

Returns:

a CfnEndpoint.DeploymentConfigProperty.Builder of CfnEndpoint.DeploymentConfigProperty