Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpoint.RollingUpdatePolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.RollingUpdatePolicyProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

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

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

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.*;
 RollingUpdatePolicyProperty rollingUpdatePolicyProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.RollingUpdatePolicyProperty.Builder	builder()
Object	getMaximumBatchSize()	Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet.
default Number	getMaximumExecutionTimeoutInSeconds()	The time limit for the total deployment.
default Object	getRollbackMaximumBatchSize()	Batch size for rollback to the old endpoint fleet.
Number	getWaitIntervalInSeconds()	The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaximumBatchSize

@Stability(Stable)
@NotNull
Object getMaximumBatchSize()

Batch size for each rolling step to provision capacity and turn on traffic on the new endpoint fleet, and terminate capacity on the old endpoint fleet.

Value must be between 5% to 50% of the variant's total instance count.

Returns union: either IResolvable or CfnEndpoint.CapacitySizeProperty

See Also:

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

getWaitIntervalInSeconds

@Stability(Stable)
@NotNull
Number getWaitIntervalInSeconds()

The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.

See Also:

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

getMaximumExecutionTimeoutInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumExecutionTimeoutInSeconds()

The time limit for the total deployment.

Exceeding this limit causes a timeout.

See Also:

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

getRollbackMaximumBatchSize

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

Batch size for rollback to the old endpoint fleet.

Each rolling step to provision capacity and turn on traffic on the old endpoint fleet, and terminate capacity on the new endpoint fleet. If this field is absent, the default value will be set to 100% of total capacity which means to bring up the whole capacity of the old fleet at once during rollback.

Returns union: either IResolvable or CfnEndpoint.CapacitySizeProperty

See Also:

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

builder

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

Returns:

a CfnEndpoint.RollingUpdatePolicyProperty.Builder of CfnEndpoint.RollingUpdatePolicyProperty