Package software.amazon.awscdk.services.sagemaker

Interface CfnCluster.DeploymentConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.DeploymentConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.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(List.of(AlarmDetailsProperty.builder()
                 .alarmName("alarmName")
                 .build()))
         .rollingUpdatePolicy(RollingUpdatePolicyProperty.builder()
                 .maximumBatchSize(CapacitySizeConfigProperty.builder()
                         .type("type")
                         .value(123)
                         .build())
                 // the properties below are optional
                 .rollbackMaximumBatchSize(CapacitySizeConfigProperty.builder()
                         .type("type")
                         .value(123)
                         .build())
                 .build())
         .waitIntervalInSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCluster.DeploymentConfigProperty.Builder	builder()
default Object	getAutoRollbackConfiguration()	Automatic rollback configuration for handling endpoint deployment failures and recovery.
default Object	getRollingUpdatePolicy()	Specifies a rolling deployment strategy for updating a SageMaker endpoint.
default Number	getWaitIntervalInSeconds()	The duration in seconds that SageMaker waits before updating more instances in the cluster.

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.AlarmDetailsProperty>

See Also:

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

getRollingUpdatePolicy

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

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

Returns union: either IResolvable or CfnCluster.RollingUpdatePolicyProperty

See Also:

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

getWaitIntervalInSeconds

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

The duration in seconds that SageMaker waits before updating more instances in the cluster.

See Also:

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

builder

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

Returns:

a CfnCluster.DeploymentConfigProperty.Builder of CfnCluster.DeploymentConfigProperty