Class: MintPress::Aws::EKS::NodegroupVersion

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb

Properties (Read/Write)

  • #cluster_name ⇒ [String]
    'The name of the Amazon EKS cluster that is associated with the managed node group to update.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'cluster_name'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

18
19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 18

property :cluster_name, update_nodegroup_version_prop: 'cluster_name', type: [String], read_only: false, source: "update_nodegroup_version", description: 'The name of the Amazon EKS cluster that is associated with the managed
node group to update.'
  • #nodegroup_name ⇒ [String]
    'The name of the managed node group to update.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'nodegroup_name'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 20

property :nodegroup_name, update_nodegroup_version_prop: 'nodegroup_name', type: [String], read_only: false, source: "update_nodegroup_version", description: 'The name of the managed node group to update.'
  • #version ⇒ [String]
    'The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster"s Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don"t specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'version'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

21
22
23
24
25
26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 21

property :version, update_nodegroup_version_prop: 'version', type: [String], read_only: false, source: "update_nodegroup_version", description: 'The Kubernetes version to update to. If no version is specified, then
the Kubernetes version of the node group does not change. You can
specify the Kubernetes version of the cluster to update the node group
to the latest AMI version of the cluster"s Kubernetes version. If you
specify launchTemplate, and your launch template uses a custom AMI,
then don"t specify version, or the node group update will fail. For
more information about using launch templates with Amazon EKS, see
Launch template support in the Amazon EKS User Guide.'
  • #release_version ⇒ [String]
    'The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group"s Kubernetes version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don"t specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'release_version'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

29
30
31
32
33
34
35
36
37
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 29

property :release_version, update_nodegroup_version_prop: 'release_version', type: [String], read_only: false, source: "update_nodegroup_version", description: 'The AMI version of the Amazon EKS optimized AMI to use for the update.
By default, the latest available AMI version for the node group"s
Kubernetes version is used. For more information, see Amazon EKS
optimized Amazon Linux 2 AMI versions  in the Amazon EKS User
Guide. If you specify launchTemplate, and your launch template uses
a custom AMI, then don"t specify releaseVersion, or the node group
update will fail. For more information about using launch templates
with Amazon EKS, see Launch template support in the Amazon EKS
User Guide.'
  • #launch_template ⇒ [MintPress::Aws::EKS::LaunchTemplate] (Default Value: MintPress::Aws::EKS::LaunchTemplate.new)
    'An object representing a node group"s launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'launch_template'
    • default ⇒ MintPress::Aws::EKS::LaunchTemplate.new
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

38
39
40
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 38

property :launch_template, update_nodegroup_version_prop: 'launch_template', type: [MintPress::Aws::EKS::LaunchTemplate], default: MintPress::Aws::EKS::LaunchTemplate.new, read_only: false, source: "update_nodegroup_version", description: 'An object representing a node group"s launch template specification.
You can only update a node group using a launch template if the node
group was originally deployed with a launch template.'
  • #force ⇒ [TrueClass,FalseClass]
    'Force the update if the existing node group"s pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'force'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

41
42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 41

property :force, update_nodegroup_version_prop: 'force', type: [TrueClass,FalseClass], read_only: false, source: "update_nodegroup_version", description: 'Force the update if the existing node group"s pods are unable to be
drained due to a pod disruption budget issue. If an update fails
because pods could not be drained, you can force the update after it
fails to terminate the old node whether or not any pods are running on
the node.'
  • #client_request_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. A suitable default value is auto-generated. You should normally not need to pass this option.**'
    Property Attributes
    • update_nodegroup_version_prop ⇒ 'client_request_token'
    • read_only ⇒ false
    • source ⇒ "update_nodegroup_version"
    

46
47
48
49
50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 46

property :client_request_token, update_nodegroup_version_prop: 'client_request_token', type: [String], read_only: false, source: "update_nodegroup_version", description: 'Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.

A suitable default value is auto-generated. You should normally
not need to pass this option.**'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 54

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup_version.rb', line 57

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ NodegroupVersion

Returns a new instance of NodegroupVersion.

Instance Method Details

#update ⇒ Object