Class: AWSCDK::Sagemaker::CfnCluster::RollingUpdatePolicyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Sagemaker::CfnCluster::RollingUpdatePolicyProperty

Defined in:

sagemaker/cfn_cluster.rb

Overview

Specifies a rolling deployment strategy for updating a SageMaker endpoint.

See Also:

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

Instance Attribute Summary

• #maximum_batch_size ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty readonly

  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.

• #rollback_maximum_batch_size ⇒ AWSCDK::IResolvable, ... readonly

  Batch size for rollback to the old endpoint fleet.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(maximum_batch_size:, rollback_maximum_batch_size: nil) ⇒ RollingUpdatePolicyProperty constructor

  A new instance of RollingUpdatePolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(maximum_batch_size:, rollback_maximum_batch_size: nil) ⇒ RollingUpdatePolicyProperty

Returns a new instance of RollingUpdatePolicyProperty.

Parameters:

• maximum_batch_size (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty) —

  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.

• rollback_maximum_batch_size (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty, nil) (defaults to: nil) —

  Batch size for rollback to the old endpoint fleet.

# File 'sagemaker/cfn_cluster.rb', line 1986

def initialize(maximum_batch_size:, rollback_maximum_batch_size: nil)
  @maximum_batch_size = maximum_batch_size.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty.new(**maximum_batch_size.transform_keys(&:to_sym)) : maximum_batch_size
  Jsii::Type.check_type(@maximum_batch_size, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5DYXBhY2l0eVNpemVDb25maWdQcm9wZXJ0eSJ9XX19")), "maximumBatchSize")
  @rollback_maximum_batch_size = rollback_maximum_batch_size.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty.new(**rollback_maximum_batch_size.transform_keys(&:to_sym)) : rollback_maximum_batch_size
  Jsii::Type.check_type(@rollback_maximum_batch_size, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuQ2x1c3Rlci5DYXBhY2l0eVNpemVDb25maWdQcm9wZXJ0eSJ9XX19")), "rollbackMaximumBatchSize") unless @rollback_maximum_batch_size.nil?
end

Instance Attribute Details

#maximum_batch_size ⇒ AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty (readonly)

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:

• (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty)

See Also:

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

# File 'sagemaker/cfn_cluster.rb', line 1999

def maximum_batch_size
  @maximum_batch_size
end

#rollback_maximum_batch_size ⇒ AWSCDK::IResolvable, ... (readonly)

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:

• (AWSCDK::IResolvable, AWSCDK::Sagemaker::CfnCluster::CapacitySizeConfigProperty, nil)

See Also:

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

# File 'sagemaker/cfn_cluster.rb', line 2006

def rollback_maximum_batch_size
  @rollback_maximum_batch_size
end

Class Method Details

.jsii_properties ⇒ Object

# File 'sagemaker/cfn_cluster.rb', line 2008

def self.jsii_properties
  {
    :maximum_batch_size => "maximumBatchSize",
    :rollback_maximum_batch_size => "rollbackMaximumBatchSize",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'sagemaker/cfn_cluster.rb', line 2015

def to_jsii
  result = {}
  result.merge!({
    "maximumBatchSize" => @maximum_batch_size,
    "rollbackMaximumBatchSize" => @rollback_maximum_batch_size,
  })
  result.compact
end