software.amazon.awscdk.services.sagemaker

Interface CfnEndpoint.BlueGreenUpdatePolicyProperty

All Known Implementing Classes:

CfnEndpoint.BlueGreenUpdatePolicyProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

public static interface CfnEndpoint.BlueGreenUpdatePolicyProperty

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.

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.*;
 BlueGreenUpdatePolicyProperty blueGreenUpdatePolicyProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnEndpoint.BlueGreenUpdatePolicyProperty.Builder	builder()
default java.lang.Number	getMaximumExecutionTimeoutInSeconds() Maximum execution timeout for the deployment.
default java.lang.Number	getTerminationWaitInSeconds() Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet.
java.lang.Object	getTrafficRoutingConfiguration() Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

Method Detail

getTrafficRoutingConfiguration

java.lang.Object getTrafficRoutingConfiguration()

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

getMaximumExecutionTimeoutInSeconds

default java.lang.Number getMaximumExecutionTimeoutInSeconds()

Maximum execution timeout for the deployment.

Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds .

getTerminationWaitInSeconds

default java.lang.Number getTerminationWaitInSeconds()

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet.

Default is 0.

builder

static CfnEndpoint.BlueGreenUpdatePolicyProperty.Builder builder()

Returns:

a CfnEndpoint.BlueGreenUpdatePolicyProperty.Builder of CfnEndpoint.BlueGreenUpdatePolicyProperty