Class: MintPress::Aws::EKS::Cluster

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

Properties (Read/Write)

  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'arn', type: [String]
  • #certificate_authority ⇒ [MintPress::Aws::EKS::Certificate] (Default Value: MintPress::Aws::EKS::Certificate.new)
    'The certificate-authority-data for your cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'certificate_authority'
    • default ⇒ MintPress::Aws::EKS::Certificate.new
    

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

property :certificate_authority, disposition: :attribute, description: 'The certificate-authority-data for your cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'certificate_authority', type: [MintPress::Aws::EKS::Certificate], default: MintPress::Aws::EKS::Certificate.new
  • #client_request_token ⇒ [String]
    'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'client_request_token'
    • create_cluster_prop ⇒ 'client_request_token'
    • read_only ⇒ false
    

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

property :client_request_token, disposition: :attribute, description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'client_request_token', type: [String], create_cluster_prop: 'client_request_token', read_only: false
  • #created_at ⇒ [Time]
    'The Unix epoch timestamp in seconds for when the cluster was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The Unix epoch timestamp in seconds for when the cluster was created.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'created_at', type: [Time]
  • #encryption_config ⇒ Array of ⇒ [MintPress::Aws::EKS::EncryptionConfig]
    'The encryption configuration for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'encryption_config'
    • create_cluster_prop ⇒ 'encryption_config'
    • read_only ⇒ false
    

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

property :encryption_config, disposition: :attribute, description: 'The encryption configuration for the cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'encryption_config', type: [MintPress::Aws::EKS::EncryptionConfig], array: true, create_cluster_prop: 'encryption_config', read_only: false
  • #endpoint ⇒ [String]
    'The endpoint for your Kubernetes API server.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'endpoint'
    

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

property :endpoint, disposition: :attribute, description: 'The endpoint for your Kubernetes API server.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'endpoint', type: [String]
  • #identity ⇒ [MintPress::Aws::EKS::Identity] (Default Value: MintPress::Aws::EKS::Identity.new)
    'The identity provider information for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'identity'
    • default ⇒ MintPress::Aws::EKS::Identity.new
    

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

property :identity, disposition: :attribute, description: 'The identity provider information for the cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'identity', type: [MintPress::Aws::EKS::Identity], default: MintPress::Aws::EKS::Identity.new
  • #kubernetes_network_config ⇒ [String]
    'The Kubernetes network configuration for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'kubernetes_network_config'
    • create_cluster_prop ⇒ "kubernetes_network_config.service_ipv_4_cidr"
    • read_only ⇒ false
    

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

property :kubernetes_network_config, disposition: :attribute, description: 'The Kubernetes network configuration for the cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'kubernetes_network_config', type: [String], create_cluster_prop: "kubernetes_network_config.service_ipv_4_cidr", read_only: false
  • #logging ⇒ [MintPress::Aws::EKS::LogSetup]
    'The logging configuration for your cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'logging'
    • create_cluster_prop ⇒ "logging.cluster_logging"
    • read_only ⇒ false
    

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

property :logging, disposition: :attribute, description: 'The logging configuration for your cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'logging', type: [MintPress::Aws::EKS::LogSetup], create_cluster_prop: "logging.cluster_logging", read_only: false
  • #name ⇒ [String]
    'The name of the cluster to describe.'
    Property Attributes
    • source ⇒ "describe_cluster"
    • orig_name ⇒ 'name'
    • create_cluster_prop ⇒ 'name'
    • read_only ⇒ false
    • delete_cluster_prop ⇒ 'name'
    • describe_cluster_prop ⇒ 'name'
    

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

property :name, description: 'The name of the cluster to describe.', source: "describe_cluster", orig_name: 'name', type: [String], create_cluster_prop: 'name', read_only: false, delete_cluster_prop: 'name', describe_cluster_prop: 'name'
  • #platform_version ⇒ [String]
    'The platform version of your Amazon EKS cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'platform_version'
    

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

property :platform_version, disposition: :attribute, description: 'The platform version of your Amazon EKS cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'platform_version', type: [String]
  • #resources_vpc_config ⇒ [MintPress::Aws::EKS::VpcConfig] (Default Value: MintPress::Aws::EKS::VpcConfig.new)
    'The VPC configuration used by the cluster control plane.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'resources_vpc_config'
    • default ⇒ MintPress::Aws::EKS::VpcConfig.new
    • create_cluster_prop ⇒ 'resources_vpc_config'
    • read_only ⇒ false
    

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

property :resources_vpc_config, disposition: :attribute, description: 'The VPC configuration used by the cluster control plane.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'resources_vpc_config', type: [MintPress::Aws::EKS::VpcConfig], default: MintPress::Aws::EKS::VpcConfig.new, create_cluster_prop: 'resources_vpc_config', read_only: false
  • #role_arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'role_arn'
    • create_cluster_prop ⇒ 'role_arn'
    • read_only ⇒ false
    

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

property :role_arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'role_arn', type: [String], create_cluster_prop: 'role_arn', read_only: false
  • #status ⇒ [String]
    'The current status of the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'status'
    

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

property :status, disposition: :attribute, description: 'The current status of the cluster.', source: "MintPress::Aws::EKS::Cluster", 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::Cluster"
    • orig_name ⇒ 'tags'
    • create_cluster_prop ⇒ 'tags'
    • read_only ⇒ false
    

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

property :tags, disposition: :attribute, description: 'The metadata that you apply to the cluster to assist with categorization and organization.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'tags', type: [], create_cluster_prop: 'tags', read_only: false
  • #version ⇒ [String]
    'The Kubernetes server version for the cluster.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::EKS::Cluster"
    • orig_name ⇒ 'version'
    • create_cluster_prop ⇒ 'version'
    • read_only ⇒ false
    

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

property :version, disposition: :attribute, description: 'The Kubernetes server version for the cluster.', source: "MintPress::Aws::EKS::Cluster", orig_name: 'version', type: [String], create_cluster_prop: 'version', read_only: false
  • #max_results ⇒ [Integer]
    'The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters 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 ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don"t use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.'
    Property Attributes
    • list_clusters_prop ⇒ 'max_results'
    • read_only ⇒ false
    • source ⇒ "list_clusters"
    

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

property :max_results, list_clusters_prop: 'max_results', type: [Integer], read_only: false, source: "list_clusters", description: 'The maximum number of cluster results returned by ListClusters in
paginated output. When you use this parameter, ListClusters 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 ListClusters request with the returned
nextToken value. This value can be between 1 and 100. If you don"t
use this parameter, ListClusters 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 
    

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

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
    

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

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

Returns a new instance of Cluster.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object

#list ⇒ Object