Class: AWSCDK::Pipes::CfnPipe::CapacityProviderStrategyItemProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::CapacityProviderStrategyItemProperty

Defined in:

pipes/cfn_pipe.rb

Overview

The details of a capacity provider strategy.

To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html

Instance Attribute Summary

• #base ⇒ Numeric^? readonly

  The base value designates how many tasks, at a minimum, to run on the specified capacity provider.

• #capacity_provider ⇒ String readonly

  The short name of the capacity provider.

• #weight ⇒ Numeric^? readonly

  The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(capacity_provider:, base: nil, weight: nil) ⇒ CapacityProviderStrategyItemProperty constructor

  A new instance of CapacityProviderStrategyItemProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(capacity_provider:, base: nil, weight: nil) ⇒ CapacityProviderStrategyItemProperty

Returns a new instance of CapacityProviderStrategyItemProperty.

Parameters:

• capacity_provider (String) —

  The short name of the capacity provider.

• base (Numeric, nil) (defaults to: nil) —

  The base value designates how many tasks, at a minimum, to run on the specified capacity provider.

• weight (Numeric, nil) (defaults to: nil) —

  The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

# File 'pipes/cfn_pipe.rb', line 1101

def initialize(capacity_provider:, base: nil, weight: nil)
  @capacity_provider = capacity_provider
  Jsii::Type.check_type(@capacity_provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProvider")
  @base = base
  Jsii::Type.check_type(@base, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "base") unless @base.nil?
  @weight = weight
  Jsii::Type.check_type(@weight, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "weight") unless @weight.nil?
end

Instance Attribute Details

#base ⇒ Numeric^? (readonly)

Note:

Default: - 0

The base value designates how many tasks, at a minimum, to run on the specified capacity provider.

Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-base

# File 'pipes/cfn_pipe.rb', line 1122

def base
  @base
end

#capacity_provider ⇒ String (readonly)

The short name of the capacity provider.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-capacityprovider

# File 'pipes/cfn_pipe.rb', line 1114

def capacity_provider
  @capacity_provider
end

#weight ⇒ Numeric^? (readonly)

Note:

Default: - 0

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

The weight value is taken into consideration after the base value, if defined, is satisfied.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-capacityproviderstrategyitem.html#cfn-pipes-pipe-capacityproviderstrategyitem-weight

# File 'pipes/cfn_pipe.rb', line 1130

def weight
  @weight
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 1132

def self.jsii_properties
  {
    :capacity_provider => "capacityProvider",
    :base => "base",
    :weight => "weight",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 1140

def to_jsii
  result = {}
  result.merge!({
    "capacityProvider" => @capacity_provider,
    "base" => @base,
    "weight" => @weight,
  })
  result.compact
end