Class: AWSCDK::KendraRanking::CfnExecutionPlanProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra_ranking/cfn_execution_plan_props.rb

Overview

Properties for defining a CfnExecutionPlan.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, capacity_units: nil, description: nil, tags: nil) ⇒ CfnExecutionPlanProps

Returns a new instance of CfnExecutionPlanProps.

Parameters:



13
14
15
16
17
18
19
20
21
22
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 13

def initialize(name:, capacity_units: nil, description: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @capacity_units = capacity_units.is_a?(Hash) ? ::AWSCDK::KendraRanking::CfnExecutionPlan::CapacityUnitsConfigurationProperty.new(**capacity_units.transform_keys(&:to_sym)) : capacity_units
  Jsii::Type.check_type(@capacity_units, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmFyYW5raW5nLkNmbkV4ZWN1dGlvblBsYW4uQ2FwYWNpdHlVbml0c0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "capacityUnits") unless @capacity_units.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

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

You can set additional capacity units to meet the needs of your rescore execution plan.

You are given a single capacity unit by default. If you want to use the default capacity, you don't set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity .

Returns:

See Also:



35
36
37
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 35

def capacity_units
  @capacity_units
end

#description ⇒ String? (readonly)

A description for the rescore execution plan.

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 40

def description
  @description
end

#name ⇒ String (readonly)

A name for the rescore execution plan.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 28

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of key-value pairs that identify or categorize your rescore execution plan.

You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space. They can also consist of underscore, period, colon, equal, plus, and asperand.

Returns:

See Also:



47
48
49
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 47

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 49

def self.jsii_properties
  {
    :name => "name",
    :capacity_units => "capacityUnits",
    :description => "description",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'kendra_ranking/cfn_execution_plan_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "capacityUnits" => @capacity_units,
    "description" => @description,
    "tags" => @tags,
  })
  result.compact
end