Class: MintPress::Aws::EKS::Addon

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

Properties (Read/Write)

  • #addon_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the add-on.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'addon_arn'
    

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

property :addon_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the add-on.', source: "MintPress::Aws::EKS::Addon", orig_name: 'addon_arn', type: [String]
  • #addon_name ⇒ [String]
    'The name of the add-on. The name must match one of the names returned by ListAddons .'
    Property Attributes
    • source ⇒ "update_addon"
    • orig_name ⇒ 'addon_name'
    • create_addon_prop ⇒ 'addon_name'
    • read_only ⇒ false
    • delete_addon_prop ⇒ 'addon_name'
    • describe_addon_prop ⇒ 'addon_name'
    • update_addon_prop ⇒ 'addon_name'
    

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

property :addon_name, description: 'The name of the add-on. The name must match one of the names returned
by  ListAddons .', source: "update_addon", orig_name: 'addon_name', type: [String], create_addon_prop: 'addon_name', read_only: false, delete_addon_prop: 'addon_name', describe_addon_prop: 'addon_name', update_addon_prop: 'addon_name'
  • #addon_version ⇒ [String]
    'The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .'
    Property Attributes
    • source ⇒ "update_addon"
    • orig_name ⇒ 'addon_version'
    • create_addon_prop ⇒ 'addon_version'
    • read_only ⇒ false
    • update_addon_prop ⇒ 'addon_version'
    

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

property :addon_version, description: 'The version of the add-on. The version must match one of the versions
returned by  DescribeAddonVersions .', source: "update_addon", orig_name: 'addon_version', type: [String], create_addon_prop: 'addon_version', read_only: false, update_addon_prop: 'addon_version'
  • #cluster_name ⇒ [String]
    'The name of the cluster.'
    Property Attributes
    • source ⇒ "update_addon"
    • orig_name ⇒ 'cluster_name'
    • create_addon_prop ⇒ 'cluster_name'
    • read_only ⇒ false
    • delete_addon_prop ⇒ 'cluster_name'
    • describe_addon_prop ⇒ 'cluster_name'
    • list_addons_prop ⇒ 'cluster_name'
    • update_addon_prop ⇒ 'cluster_name'
    

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

property :cluster_name, description: 'The name of the cluster.', source: "update_addon", orig_name: 'cluster_name', type: [String], create_addon_prop: 'cluster_name', read_only: false, delete_addon_prop: 'cluster_name', describe_addon_prop: 'cluster_name', list_addons_prop: 'cluster_name', update_addon_prop: 'cluster_name'
  • #created_at ⇒ [Time]
    'The date and time that the add-on was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The date and time that the add-on was created.', source: "MintPress::Aws::EKS::Addon", orig_name: 'created_at', type: [Time]
  • #health ⇒ [MintPress::Aws::EKS::AddonHealth] (Default Value: MintPress::Aws::EKS::AddonHealth.new)
    'An object that represents the health of the add-on.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'health'
    • default ⇒ MintPress::Aws::EKS::AddonHealth.new
    

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

property :health, disposition: :attribute, description: 'An object that represents the health of the add-on.', source: "MintPress::Aws::EKS::Addon", orig_name: 'health', type: [MintPress::Aws::EKS::AddonHealth], default: MintPress::Aws::EKS::AddonHealth.new
  • #modified_at ⇒ [Time]
    'The date and time that the add-on was last modified.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'modified_at'
    

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

property :modified_at, disposition: :attribute, description: 'The date and time that the add-on was last modified.', source: "MintPress::Aws::EKS::Addon", orig_name: 'modified_at', type: [Time]
  • #service_account_role_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on"s service account. The role must be assigned the IAM permissions required by the add-on. If you don"t specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide. To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.'
    Property Attributes
    • source ⇒ "update_addon"
    • orig_name ⇒ 'service_account_role_arn'
    • create_addon_prop ⇒ 'service_account_role_arn'
    • read_only ⇒ false
    • update_addon_prop ⇒ 'service_account_role_arn'
    

35
36
37
38
39
40
41
42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/eks/addon.rb', line 35

property :service_account_role_arn, description: 'The Amazon Resource Name (ARN) of an existing IAM role to bind to the
add-on"s service account. The role must be assigned the IAM
permissions required by the add-on. If you don"t specify an existing
IAM role, then the add-on uses the permissions assigned to the node
IAM role. For more information, see Amazon EKS node IAM role in
the Amazon EKS User Guide.

 To specify an existing IAM role, you must have an IAM OpenID Connect
(OIDC) provider created for your cluster. For more information, see
Enabling IAM roles for service accounts on your cluster in the
Amazon EKS User Guide.', source: "update_addon", orig_name: 'service_account_role_arn', type: [String], create_addon_prop: 'service_account_role_arn', read_only: false, update_addon_prop: 'service_account_role_arn'
  • #status ⇒ [String]
    'The status of the add-on.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The status of the add-on.', source: "MintPress::Aws::EKS::Addon", orig_name: 'status', type: [String]
  • #tags ⇒ []
    'The metadata that you apply to the cluster to assist with categorization and organization.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Addon"
    • orig_name ⇒ 'tags'
    • create_addon_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The metadata that you apply to the cluster to assist with categorization and organization.', source: "MintPress::Aws::EKS::Addon", orig_name: 'tags', type: [], create_addon_prop: 'tags', read_only: false
  • #resolve_conflicts ⇒ [String]
    'How to resolve parameter value conflicts when applying the new version of the add-on to the cluster.'
    Property Attributes
    • create_addon_prop ⇒ 'resolve_conflicts'
    • read_only ⇒ false
    • source ⇒ "update_addon"
    • update_addon_prop ⇒ 'resolve_conflicts'
    

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

property :resolve_conflicts, create_addon_prop: 'resolve_conflicts', type: [String], read_only: false, source: "update_addon", description: 'How to resolve parameter value conflicts when applying the new version
of the add-on to the cluster.', update_addon_prop: 'resolve_conflicts'
  • #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_addon_prop ⇒ 'client_request_token'
    • read_only ⇒ false
    • source ⇒ "update_addon"
    • update_addon_prop ⇒ 'client_request_token'
    

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

property :client_request_token, create_addon_prop: 'client_request_token', type: [String], read_only: false, source: "update_addon", 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.**', update_addon_prop: 'client_request_token'
  • #max_results ⇒ [Integer]
    'The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest 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 ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don"t use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.'
    Property Attributes
    • list_addons_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_addons"
    

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

property :max_results, list_addons_prop: 'max_results', type: [Integer], read_only: false, source: "list_addons", description: 'The maximum number of add-on results returned by ListAddonsRequest
in paginated output. When you use this parameter, ListAddonsRequest
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 ListAddonsRequest request with
the returned nextToken value. This value can be between 1 and 100.
If you don"t use this parameter, ListAddonsRequest 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/addon.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/addon.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 = {}) ⇒ Addon

Returns a new instance of Addon.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object

#update ⇒ Object