Class: MintPress::Aws::EKS::Nodegroup

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

Properties (Read/Write)

  • #ami_type ⇒ [String]
    'If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'ami_type'
    • create_nodegroup_prop ⇒ 'ami_type'
    • read_only ⇒ false
    

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

property :ami_type, disposition: :attribute, description: 'If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'ami_type', type: [String], create_nodegroup_prop: 'ami_type', read_only: false
  • #capacity_type ⇒ [String]
    'The capacity type of your managed node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'capacity_type'
    • create_nodegroup_prop ⇒ 'capacity_type'
    • read_only ⇒ false
    

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

property :capacity_type, disposition: :attribute, description: 'The capacity type of your managed node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'capacity_type', type: [String], create_nodegroup_prop: 'capacity_type', read_only: false
  • #cluster_name ⇒ [String]
    'The name of the Amazon EKS cluster that you would like to list node groups in.'
    Property Attributes
    • source ⇒ "list_nodegroups"
    • orig_name ⇒ 'cluster_name'
    • create_nodegroup_prop ⇒ 'cluster_name'
    • read_only ⇒ false
    • delete_nodegroup_prop ⇒ 'cluster_name'
    • describe_nodegroup_prop ⇒ 'cluster_name'
    • list_nodegroups_prop ⇒ 'cluster_name'
    

30
31
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup.rb', line 30

property :cluster_name, description: 'The name of the Amazon EKS cluster that you would like to list node
groups in.', source: "list_nodegroups", orig_name: 'cluster_name', type: [String], create_nodegroup_prop: 'cluster_name', read_only: false, delete_nodegroup_prop: 'cluster_name', describe_nodegroup_prop: 'cluster_name', list_nodegroups_prop: 'cluster_name'
  • #created_at ⇒ [Time]
    'The Unix epoch timestamp in seconds for when the managed node group was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The Unix epoch timestamp in seconds for when the managed node group was created.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'created_at', type: [Time]
  • #disk_size ⇒ [Integer]
    'If the node group wasn"t deployed with a launch template, then this is the disk size in the node group configuration.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'disk_size'
    • create_nodegroup_prop ⇒ 'disk_size'
    • read_only ⇒ false
    

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

property :disk_size, disposition: :attribute, description: 'If the node group wasn"t deployed with a launch template, then this is the disk size in the node group configuration.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'disk_size', type: [Integer], create_nodegroup_prop: 'disk_size', read_only: false
  • #health ⇒ [MintPress::Aws::EKS::NodegroupHealth] (Default Value: MintPress::Aws::EKS::NodegroupHealth.new)
    'The health status of the node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'health'
    • default ⇒ MintPress::Aws::EKS::NodegroupHealth.new
    

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

property :health, disposition: :attribute, description: 'The health status of the node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'health', type: [MintPress::Aws::EKS::NodegroupHealth], default: MintPress::Aws::EKS::NodegroupHealth.new
  • #instance_types ⇒ Array of ⇒ [String]
    'If the node group wasn"t deployed with a launch template, then this is the instance type that is associated with the node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'instance_types'
    • create_nodegroup_prop ⇒ 'instance_types'
    • read_only ⇒ false
    

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

property :instance_types, disposition: :attribute, description: 'If the node group wasn"t deployed with a launch template, then this is the instance type that is associated with the node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'instance_types', type: [String], array: true, create_nodegroup_prop: 'instance_types', read_only: false
  • #labels ⇒ []
    'The Kubernetes labels applied to the nodes in the node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'labels'
    • create_nodegroup_prop ⇒ 'labels'
    • read_only ⇒ false
    

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

property :labels, disposition: :attribute, description: 'The Kubernetes labels applied to the nodes in the node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'labels', type: [], create_nodegroup_prop: 'labels', read_only: false
  • #launch_template ⇒ [MintPress::Aws::EKS::LaunchTemplate] (Default Value: MintPress::Aws::EKS::LaunchTemplate.new)
    'If a launch template was used to create the node group, then this is the launch template that was used.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'launch_template'
    • default ⇒ MintPress::Aws::EKS::LaunchTemplate.new
    • create_nodegroup_prop ⇒ 'launch_template'
    • read_only ⇒ false
    

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

property :launch_template, disposition: :attribute, description: 'If a launch template was used to create the node group, then this is the launch template that was used.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'launch_template', type: [MintPress::Aws::EKS::LaunchTemplate], default: MintPress::Aws::EKS::LaunchTemplate.new, create_nodegroup_prop: 'launch_template', read_only: false
  • #modified_at ⇒ [Time]
    'The Unix epoch timestamp in seconds for when the managed node group was last modified.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'modified_at'
    

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

property :modified_at, disposition: :attribute, description: 'The Unix epoch timestamp in seconds for when the managed node group was last modified.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'modified_at', type: [Time]
  • #node_role ⇒ [String]
    'The IAM role associated with your node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'node_role'
    • create_nodegroup_prop ⇒ 'node_role'
    • read_only ⇒ false
    

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

property :node_role, disposition: :attribute, description: 'The IAM role associated with your node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'node_role', type: [String], create_nodegroup_prop: 'node_role', read_only: false
  • #nodegroup_arn ⇒ [String]
    'The Amazon Resource Name (ARN) associated with the managed node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'nodegroup_arn'
    

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

property :nodegroup_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) associated with the managed node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'nodegroup_arn', type: [String]
  • #nodegroup_name ⇒ [String]
    'The name of the node group to describe.'
    Property Attributes
    • source ⇒ "describe_nodegroup"
    • orig_name ⇒ 'nodegroup_name'
    • create_nodegroup_prop ⇒ 'nodegroup_name'
    • read_only ⇒ false
    • delete_nodegroup_prop ⇒ 'nodegroup_name'
    • describe_nodegroup_prop ⇒ 'nodegroup_name'
    

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

property :nodegroup_name, description: 'The name of the node group to describe.', source: "describe_nodegroup", orig_name: 'nodegroup_name', type: [String], create_nodegroup_prop: 'nodegroup_name', read_only: false, delete_nodegroup_prop: 'nodegroup_name', describe_nodegroup_prop: 'nodegroup_name'
  • #release_version ⇒ [String]
    'If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'release_version'
    • create_nodegroup_prop ⇒ 'release_version'
    • read_only ⇒ false
    

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

property :release_version, disposition: :attribute, description: 'If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'release_version', type: [String], create_nodegroup_prop: 'release_version', read_only: false
  • #remote_access ⇒ [MintPress::Aws::EKS::RemoteAccessConfig] (Default Value: MintPress::Aws::EKS::RemoteAccessConfig.new)
    'If the node group wasn"t deployed with a launch template, then this is the remote access configuration that is associated with the node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'remote_access'
    • default ⇒ MintPress::Aws::EKS::RemoteAccessConfig.new
    • create_nodegroup_prop ⇒ 'remote_access'
    • read_only ⇒ false
    

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

property :remote_access, disposition: :attribute, description: 'If the node group wasn"t deployed with a launch template, then this is the remote access configuration that is associated with the node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'remote_access', type: [MintPress::Aws::EKS::RemoteAccessConfig], default: MintPress::Aws::EKS::RemoteAccessConfig.new, create_nodegroup_prop: 'remote_access', read_only: false
  • #resources ⇒ [MintPress::Aws::EKS::NodegroupResource] (Default Value: Proc.new { [self.parent.id] })
    'The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'resources'
    • default ⇒ Proc.new { [self.parent.id] }
    

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

property :resources, disposition: :attribute, description: 'The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'resources', type: [MintPress::Aws::EKS::NodegroupResource], default: Proc.new { [self.parent.id] }
  • #scaling_config ⇒ [MintPress::Aws::EKS::NodegroupScalingConfig] (Default Value: MintPress::Aws::EKS::NodegroupScalingConfig.new)
    'The scaling configuration details for the Auto Scaling group that is associated with your node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'scaling_config'
    • default ⇒ MintPress::Aws::EKS::NodegroupScalingConfig.new
    • create_nodegroup_prop ⇒ 'scaling_config'
    • read_only ⇒ false
    

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

property :scaling_config, disposition: :attribute, description: 'The scaling configuration details for the Auto Scaling group that is associated with your node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'scaling_config', type: [MintPress::Aws::EKS::NodegroupScalingConfig], default: MintPress::Aws::EKS::NodegroupScalingConfig.new, create_nodegroup_prop: 'scaling_config', read_only: false
  • #status ⇒ [String]
    'The current status of the managed node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The current status of the managed node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'status', type: [String]
  • #subnets ⇒ Array of ⇒ [String]
    'The subnets that were specified for the Auto Scaling group that is associated with your node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'subnets'
    • create_nodegroup_prop ⇒ 'subnets'
    • read_only ⇒ false
    

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

property :subnets, disposition: :attribute, description: 'The subnets that were specified for the Auto Scaling group that is associated with your node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'subnets', type: [String], array: true, create_nodegroup_prop: 'subnets', read_only: false
  • #tags ⇒ []
    'The metadata applied to the node group to assist with categorization and organization.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'tags'
    • create_nodegroup_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The metadata applied to the node group to assist with categorization and organization.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'tags', type: [], create_nodegroup_prop: 'tags', read_only: false
  • #version ⇒ [String]
    'The Kubernetes version of the managed node group.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Nodegroup"
    • orig_name ⇒ 'version'
    • create_nodegroup_prop ⇒ 'version'
    • read_only ⇒ false
    

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

property :version, disposition: :attribute, description: 'The Kubernetes version of the managed node group.', source: "MintPress::Aws::EKS::Nodegroup", orig_name: 'version', type: [String], create_nodegroup_prop: 'version', read_only: false
  • #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
    • create_nodegroup_prop ⇒ 'client_request_token'
    • read_only ⇒ false
    • source ⇒ "create_nodegroup"
    

50
51
52
53
54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup.rb', line 50

property :client_request_token, create_nodegroup_prop: 'client_request_token', type: [String], read_only: false, source: "create_nodegroup", 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.**'
  • #max_results ⇒ [Integer]
    'The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don"t use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_nodegroups_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_nodegroups"
    

55
56
57
58
59
60
61
62
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/nodegroup.rb', line 55

property :max_results, list_nodegroups_prop: 'max_results', type: [Integer], read_only: false, source: "list_nodegroups", description: 'The maximum number of node group results returned by ListNodegroups
in paginated output. When you use this parameter, ListNodegroups
returns only maxResults results in a single page along with a
nextToken response element. You can see the remaining results of the
initial request by sending another ListNodegroups request with the
returned nextToken value. This value can be between 1 and 100. If
you don"t use this parameter, ListNodegroups returns up to 100
results and a nextToken value if applicable.'
  • #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 
    

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

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
    

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

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 = {}) ⇒ Nodegroup

Returns a new instance of Nodegroup.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object