Class: AWSCDK::EKS::CfnNodegroup

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEKS::INodegroupRef
Defined in:
eks/cfn_nodegroup.rb

Overview

Creates a managed node group for an Amazon EKS cluster.

You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template.

For later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. For more information about using launch templates, see Customizing managed nodes with launch templates .

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide .

Windows AMI types are only supported for commercial AWS Regions that support Windows on Amazon EKS.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnNodegroup

Create a new AWS::EKS::Nodegroup.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EKS::CfnNodegroupProps) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'eks/cfn_nodegroup.rb', line 26

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroupProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzLkNmbk5vZGVncm91cFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_nodegroup(resource) ⇒ String

Parameters:

Returns:

  • (String) 


102
103
104
105
 
# File 'eks/cfn_nodegroup.rb', line 102

def self.arn_for_nodegroup(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19la3MuSU5vZGVncm91cFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnNodegroup", "arnForNodegroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


209
210
211
 
# File 'eks/cfn_nodegroup.rb', line 209

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_eks.CfnNodegroup", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_nodegroup(x) ⇒ Boolean

Checks whether the given object is a CfnNodegroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


111
112
113
114
 
# File 'eks/cfn_nodegroup.rb', line 111

def self.is_cfn_nodegroup(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnNodegroup", "isCfnNodegroup", [x])
end

.jsii_overridable_methods ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'eks/cfn_nodegroup.rb', line 34

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_cluster_name => { kind: :property, name: "attrClusterName", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_nodegroup_name => { kind: :property, name: "attrNodegroupName", is_optional: false },
    :nodegroup_ref => { kind: :property, name: "nodegroupRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: false },
    :node_role => { kind: :property, name: "nodeRole", is_optional: false },
    :subnets => { kind: :property, name: "subnets", is_optional: false },
    :ami_type => { kind: :property, name: "amiType", is_optional: true },
    :capacity_type => { kind: :property, name: "capacityType", is_optional: true },
    :disk_size => { kind: :property, name: "diskSize", is_optional: true },
    :force_update_enabled => { kind: :property, name: "forceUpdateEnabled", is_optional: true },
    :instance_types => { kind: :property, name: "instanceTypes", is_optional: true },
    :labels => { kind: :property, name: "labels", is_optional: true },
    :launch_template => { kind: :property, name: "launchTemplate", is_optional: true },
    :nodegroup_name => { kind: :property, name: "nodegroupName", is_optional: true },
    :node_repair_config => { kind: :property, name: "nodeRepairConfig", is_optional: true },
    :release_version => { kind: :property, name: "releaseVersion", is_optional: true },
    :remote_access => { kind: :property, name: "remoteAccess", is_optional: true },
    :scaling_config => { kind: :property, name: "scalingConfig", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :taints => { kind: :property, name: "taints", is_optional: true },
    :update_config => { kind: :property, name: "updateConfig", is_optional: true },
    :version => { kind: :property, name: "version", is_optional: true },
    :warm_pool_config => { kind: :property, name: "warmPoolConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



535
536
537
538
 
# File 'eks/cfn_nodegroup.rb', line 535

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



547
548
549
550
 
# File 'eks/cfn_nodegroup.rb', line 547

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



557
558
559
560
 
# File 'eks/cfn_nodegroup.rb', line 557

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



568
569
570
571
572
 
# File 'eks/cfn_nodegroup.rb', line 568

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


625
626
627
628
629
 
# File 'eks/cfn_nodegroup.rb', line 625

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



635
636
637
638
 
# File 'eks/cfn_nodegroup.rb', line 635

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



647
648
649
650
651
 
# File 'eks/cfn_nodegroup.rb', line 647

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#ami_type ⇒ String?

The AMI type for your node group.

Returns:

  • (String, nil) 


292
293
294
 
# File 'eks/cfn_nodegroup.rb', line 292

def ami_type()
  jsii_get_property("amiType")
end

#ami_type=(value) ⇒ Object 



296
297
298
299
 
# File 'eks/cfn_nodegroup.rb', line 296

def ami_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "amiType") unless value.nil?
  jsii_set_property("amiType", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



660
661
662
663
 
# File 'eks/cfn_nodegroup.rb', line 660

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



682
683
684
685
686
687
 
# File 'eks/cfn_nodegroup.rb', line 682

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) associated with the managed node group.

Returns:

  • (String) 


216
217
218
 
# File 'eks/cfn_nodegroup.rb', line 216

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_cluster_name ⇒ String

The name of your cluster.

Returns:

  • (String) 


223
224
225
 
# File 'eks/cfn_nodegroup.rb', line 223

def attr_cluster_name()
  jsii_get_property("attrClusterName")
end

#attr_id ⇒ String

Returns:

  • (String) 


228
229
230
 
# File 'eks/cfn_nodegroup.rb', line 228

def attr_id()
  jsii_get_property("attrId")
end

#attr_nodegroup_name ⇒ String

The name associated with an Amazon EKS managed node group.

Returns:

  • (String) 


235
236
237
 
# File 'eks/cfn_nodegroup.rb', line 235

def attr_nodegroup_name()
  jsii_get_property("attrNodegroupName")
end

#capacity_type ⇒ String?

The capacity type of your managed node group.

Returns:

  • (String, nil) 


304
305
306
 
# File 'eks/cfn_nodegroup.rb', line 304

def capacity_type()
  jsii_get_property("capacityType")
end

#capacity_type=(value) ⇒ Object 



308
309
310
311
 
# File 'eks/cfn_nodegroup.rb', line 308

def capacity_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityType") unless value.nil?
  jsii_set_property("capacityType", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



162
163
164
 
# File 'eks/cfn_nodegroup.rb', line 162

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


167
168
169
 
# File 'eks/cfn_nodegroup.rb', line 167

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


691
692
693
694
 
# File 'eks/cfn_nodegroup.rb', line 691

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


172
173
174
 
# File 'eks/cfn_nodegroup.rb', line 172

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


179
180
181
 
# File 'eks/cfn_nodegroup.rb', line 179

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_name ⇒ String

The name of your cluster.

Returns:

  • (String) 


256
257
258
 
# File 'eks/cfn_nodegroup.rb', line 256

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



260
261
262
263
 
# File 'eks/cfn_nodegroup.rb', line 260

def cluster_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  jsii_set_property("clusterName", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


124
125
126
 
# File 'eks/cfn_nodegroup.rb', line 124

def creation_stack()
  jsii_get_property("creationStack")
end

#disk_size ⇒ Numeric?

The root device disk size (in GiB) for your node group instances.

Returns:

  • (Numeric, nil) 


316
317
318
 
# File 'eks/cfn_nodegroup.rb', line 316

def disk_size()
  jsii_get_property("diskSize")
end

#disk_size=(value) ⇒ Object 



320
321
322
323
 
# File 'eks/cfn_nodegroup.rb', line 320

def disk_size=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "diskSize") unless value.nil?
  jsii_set_property("diskSize", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



184
185
186
 
# File 'eks/cfn_nodegroup.rb', line 184

def env()
  jsii_get_property("env")
end

#force_update_enabled ⇒ Boolean, ...

Force the update if any Pod on the existing node group can't be drained due to a Pod disruption budget issue.

Returns:



328
329
330
 
# File 'eks/cfn_nodegroup.rb', line 328

def force_update_enabled()
  jsii_get_property("forceUpdateEnabled")
end

#force_update_enabled=(value) ⇒ Object 



332
333
334
335
 
# File 'eks/cfn_nodegroup.rb', line 332

def force_update_enabled=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "forceUpdateEnabled") unless value.nil?
  jsii_set_property("forceUpdateEnabled", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



704
705
706
707
708
 
# File 'eks/cfn_nodegroup.rb', line 704

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



715
716
717
718
 
# File 'eks/cfn_nodegroup.rb', line 715

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



785
786
787
788
 
# File 'eks/cfn_nodegroup.rb', line 785

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_types ⇒ Array<String>?

Specify the instance types for a node group.

Returns:

  • (Array<String>, nil) 


340
341
342
 
# File 'eks/cfn_nodegroup.rb', line 340

def instance_types()
  jsii_get_property("instanceTypes")
end

#instance_types=(value) ⇒ Object 



344
345
346
347
 
# File 'eks/cfn_nodegroup.rb', line 344

def instance_types=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "instanceTypes") unless value.nil?
  jsii_set_property("instanceTypes", value)
end

#labels ⇒ AWSCDK::IResolvable, ...

The Kubernetes labels applied to the nodes in the node group.

Returns:



352
353
354
 
# File 'eks/cfn_nodegroup.rb', line 352

def labels()
  jsii_get_property("labels")
end

#labels=(value) ⇒ Object 



356
357
358
359
 
# File 'eks/cfn_nodegroup.rb', line 356

def labels=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "labels") unless value.nil?
  jsii_set_property("labels", value)
end

#launch_template ⇒ AWSCDK::IResolvable, ...

An object representing a node group's launch template specification.

Returns:



364
365
366
 
# File 'eks/cfn_nodegroup.rb', line 364

def launch_template()
  jsii_get_property("launchTemplate")
end

#launch_template=(value) ⇒ Object 



368
369
370
371
372
 
# File 'eks/cfn_nodegroup.rb', line 368

def launch_template=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::LaunchTemplateSpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLkxhdW5jaFRlbXBsYXRlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "launchTemplate") unless value.nil?
  jsii_set_property("launchTemplate", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


136
137
138
 
# File 'eks/cfn_nodegroup.rb', line 136

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


119
120
121
 
# File 'eks/cfn_nodegroup.rb', line 119

def node()
  jsii_get_property("node")
end

#node_repair_config ⇒ AWSCDK::IResolvable, ...

The node auto repair configuration for the node group.

Returns:



389
390
391
 
# File 'eks/cfn_nodegroup.rb', line 389

def node_repair_config()
  jsii_get_property("nodeRepairConfig")
end

#node_repair_config=(value) ⇒ Object 



393
394
395
396
397
 
# File 'eks/cfn_nodegroup.rb', line 393

def node_repair_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::NodeRepairConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLk5vZGVSZXBhaXJDb25maWdQcm9wZXJ0eSJ9XX19")), "nodeRepairConfig") unless value.nil?
  jsii_set_property("nodeRepairConfig", value)
end

#node_role ⇒ String

The Amazon Resource Name (ARN) of the IAM role to associate with your node group.

Returns:

  • (String) 


268
269
270
 
# File 'eks/cfn_nodegroup.rb', line 268

def node_role()
  jsii_get_property("nodeRole")
end

#node_role=(value) ⇒ Object 



272
273
274
275
 
# File 'eks/cfn_nodegroup.rb', line 272

def node_role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nodeRole")
  jsii_set_property("nodeRole", value)
end

#nodegroup_name ⇒ String?

The unique name to give your node group.

Returns:

  • (String, nil) 


377
378
379
 
# File 'eks/cfn_nodegroup.rb', line 377

def nodegroup_name()
  jsii_get_property("nodegroupName")
end

#nodegroup_name=(value) ⇒ Object 



381
382
383
384
 
# File 'eks/cfn_nodegroup.rb', line 381

def nodegroup_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nodegroupName") unless value.nil?
  jsii_set_property("nodegroupName", value)
end

#nodegroup_ref ⇒ AWSCDK::Interfaces::AWSEKS::NodegroupReference

A reference to a Nodegroup resource.

Returns:



242
243
244
 
# File 'eks/cfn_nodegroup.rb', line 242

def nodegroup_ref()
  jsii_get_property("nodegroupRef")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



726
727
728
 
# File 'eks/cfn_nodegroup.rb', line 726

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



733
734
735
 
# File 'eks/cfn_nodegroup.rb', line 733

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



526
527
528
529
 
# File 'eks/cfn_nodegroup.rb', line 526

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


155
156
157
 
# File 'eks/cfn_nodegroup.rb', line 155

def ref()
  jsii_get_property("ref")
end

#release_version ⇒ String?

The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, 1.14.7- *YYYYMMDD* ). By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS optimized Linux AMI Versions in the Amazon EKS User Guide .

Returns:

  • (String, nil) 


402
403
404
 
# File 'eks/cfn_nodegroup.rb', line 402

def release_version()
  jsii_get_property("releaseVersion")
end

#release_version=(value) ⇒ Object 



406
407
408
409
 
# File 'eks/cfn_nodegroup.rb', line 406

def release_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "releaseVersion") unless value.nil?
  jsii_set_property("releaseVersion", value)
end

#remote_access ⇒ AWSCDK::IResolvable, ...

The remote access configuration to use with your node group.

Returns:



414
415
416
 
# File 'eks/cfn_nodegroup.rb', line 414

def remote_access()
  jsii_get_property("remoteAccess")
end

#remote_access=(value) ⇒ Object 



418
419
420
421
422
 
# File 'eks/cfn_nodegroup.rb', line 418

def remote_access=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::RemoteAccessProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLlJlbW90ZUFjY2Vzc1Byb3BlcnR5In1dfX0=")), "remoteAccess") unless value.nil?
  jsii_set_property("remoteAccess", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



744
745
746
747
 
# File 'eks/cfn_nodegroup.rb', line 744

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


751
752
753
754
 
# File 'eks/cfn_nodegroup.rb', line 751

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



761
762
763
764
765
 
# File 'eks/cfn_nodegroup.rb', line 761

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scaling_config ⇒ AWSCDK::IResolvable, ...

The scaling configuration details for the Auto Scaling group that is created for your node group.

Returns:



427
428
429
 
# File 'eks/cfn_nodegroup.rb', line 427

def scaling_config()
  jsii_get_property("scalingConfig")
end

#scaling_config=(value) ⇒ Object 



431
432
433
434
435
 
# File 'eks/cfn_nodegroup.rb', line 431

def scaling_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::ScalingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLlNjYWxpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "scalingConfig") unless value.nil?
  jsii_set_property("scalingConfig", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



770
771
772
 
# File 'eks/cfn_nodegroup.rb', line 770

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



145
146
147
 
# File 'eks/cfn_nodegroup.rb', line 145

def stack()
  jsii_get_property("stack")
end

#subnets ⇒ Array<String>

The subnets to use for the Auto Scaling group that is created for your node group.

Returns:

  • (Array<String>) 


280
281
282
 
# File 'eks/cfn_nodegroup.rb', line 280

def subnets()
  jsii_get_property("subnets")
end

#subnets=(value) ⇒ Object 



284
285
286
287
 
# File 'eks/cfn_nodegroup.rb', line 284

def subnets=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnets")
  jsii_set_property("subnets", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



249
250
251
 
# File 'eks/cfn_nodegroup.rb', line 249

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Metadata that assists with categorization and organization.

Returns:

  • (Hash{String => String}, nil) 


440
441
442
 
# File 'eks/cfn_nodegroup.rb', line 440

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



444
445
446
447
 
# File 'eks/cfn_nodegroup.rb', line 444

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#taints ⇒ AWSCDK::IResolvable, ...

The Kubernetes taints to be applied to the nodes in the node group when they are created.

Returns:



452
453
454
 
# File 'eks/cfn_nodegroup.rb', line 452

def taints()
  jsii_get_property("taints")
end

#taints=(value) ⇒ Object 



456
457
458
459
 
# File 'eks/cfn_nodegroup.rb', line 456

def taints=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzLkNmbk5vZGVncm91cC5UYWludFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "taints") unless value.nil?
  jsii_set_property("taints", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



502
503
504
 
# File 'eks/cfn_nodegroup.rb', line 502

def to_string()
  jsii_call_method("toString", [])
end

#update_config ⇒ AWSCDK::IResolvable, ...

The node group update configuration.

Returns:



464
465
466
 
# File 'eks/cfn_nodegroup.rb', line 464

def update_config()
  jsii_get_property("updateConfig")
end

#update_config=(value) ⇒ Object 



468
469
470
471
472
 
# File 'eks/cfn_nodegroup.rb', line 468

def update_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::UpdateConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLlVwZGF0ZUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "updateConfig") unless value.nil?
  jsii_set_property("updateConfig", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


192
193
194
 
# File 'eks/cfn_nodegroup.rb', line 192

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'eks/cfn_nodegroup.rb', line 202

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


776
777
778
779
 
# File 'eks/cfn_nodegroup.rb', line 776

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version ⇒ String?

The Kubernetes version to use for your managed nodes.

Returns:

  • (String, nil) 


477
478
479
 
# File 'eks/cfn_nodegroup.rb', line 477

def version()
  jsii_get_property("version")
end

#version=(value) ⇒ Object 



481
482
483
484
 
# File 'eks/cfn_nodegroup.rb', line 481

def version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless value.nil?
  jsii_set_property("version", value)
end

#warm_pool_config ⇒ AWSCDK::IResolvable, ...

The warm pool configuration for the node group.

Returns:



489
490
491
 
# File 'eks/cfn_nodegroup.rb', line 489

def warm_pool_config()
  jsii_get_property("warmPoolConfig")
end

#warm_pool_config=(value) ⇒ Object 



493
494
495
496
497
 
# File 'eks/cfn_nodegroup.rb', line 493

def warm_pool_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnNodegroup::WarmPoolConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuTm9kZWdyb3VwLldhcm1Qb29sQ29uZmlnUHJvcGVydHkifV19fQ==")), "warmPoolConfig") unless value.nil?
  jsii_set_property("warmPoolConfig", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


515
516
517
518
519
520
 
# File 'eks/cfn_nodegroup.rb', line 515

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end