Class: Aws::EKS::Types::Cluster
- Inherits:
-
Struct
- Object
- Struct
- Aws::EKS::Types::Cluster
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-eks/types.rb
Overview
An object representing an Amazon EKS cluster.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_config ⇒ Types::AccessConfigResponse
The access configuration for the cluster.
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the cluster.
-
#certificate_authority ⇒ Types::Certificate
The ‘certificate-authority-data` for your cluster.
-
#client_request_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#compute_config ⇒ Types::ComputeConfigResponse
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.
-
#connector_config ⇒ Types::ConnectorConfigResponse
The configuration used to connect to a cluster for registration.
-
#created_at ⇒ Time
The Unix epoch timestamp at object creation.
-
#encryption_config ⇒ Array<Types::EncryptionConfig>
The encryption configuration for the cluster.
-
#endpoint ⇒ String
The endpoint for your Kubernetes API server.
-
#health ⇒ Types::ClusterHealth
An object representing the health of your Amazon EKS cluster.
-
#id ⇒ String
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost.
-
#identity ⇒ Types::Identity
The identity provider information for the cluster.
-
#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigResponse
The Kubernetes network configuration for the cluster.
-
#logging ⇒ Types::Logging
The logging configuration for your cluster.
-
#name ⇒ String
The name of your cluster.
-
#outpost_config ⇒ Types::OutpostConfigResponse
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
-
#platform_version ⇒ String
The platform version of your Amazon EKS cluster.
-
#remote_network_config ⇒ Types::RemoteNetworkConfigResponse
The configuration in the cluster for EKS Hybrid Nodes.
-
#resources_vpc_config ⇒ Types::VpcConfigResponse
The VPC configuration used by the cluster control plane.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
-
#status ⇒ String
The current status of the cluster.
-
#storage_config ⇒ Types::StorageConfigResponse
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.
-
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization.
-
#upgrade_policy ⇒ Types::UpgradePolicyResponse
This value indicates if extended support is enabled or disabled for the cluster.
-
#version ⇒ String
The Kubernetes server version for the cluster.
-
#zonal_shift_config ⇒ Types::ZonalShiftConfigResponse
The configuration for zonal shift for the cluster.
Instance Attribute Details
#access_config ⇒ Types::AccessConfigResponse
The access configuration for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The Amazon Resource Name (ARN) of the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#certificate_authority ⇒ Types::Certificate
The ‘certificate-authority-data` for your cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#client_request_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#compute_config ⇒ Types::ComputeConfigResponse
Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#connector_config ⇒ Types::ConnectorConfigResponse
The configuration used to connect to a cluster for registration.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
The Unix epoch timestamp at object creation.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#encryption_config ⇒ Array<Types::EncryptionConfig>
The encryption configuration for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#endpoint ⇒ String
The endpoint for your Kubernetes API server.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#health ⇒ Types::ClusterHealth
An object representing the health of your Amazon EKS cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn’t available for an Amazon EKS cluster on the Amazon Web Services cloud.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#identity ⇒ Types::Identity
The identity provider information for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigResponse
The Kubernetes network configuration for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#logging ⇒ Types::Logging
The logging configuration for your cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of your cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#outpost_config ⇒ Types::OutpostConfigResponse
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn’t available for clusters on the Amazon Web Services cloud.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#platform_version ⇒ String
The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see [Platform versions] in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see [Amazon EKS local cluster platform versions] in the Amazon EKS User Guide .
[1]: docs.aws.amazon.com/eks/latest/userguide/platform-versions.html [2]: docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#remote_network_config ⇒ Types::RemoteNetworkConfigResponse
The configuration in the cluster for EKS Hybrid Nodes. You can’t change or update this configuration after the cluster is created.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#resources_vpc_config ⇒ Types::VpcConfigResponse
The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see [Cluster VPC considerations] and [Cluster security group considerations] in the *Amazon EKS User Guide*.
[1]: docs.aws.amazon.com/eks/latest/userguide/network_reqs.html [2]: docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#storage_config ⇒ Types::StorageConfigResponse
Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#upgrade_policy ⇒ Types::UpgradePolicyResponse
This value indicates if extended support is enabled or disabled for the cluster.
- Learn more about EKS Extended Support in the EKS User Guide.][1
-
[1]: docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#version ⇒ String
The Kubernetes server version for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |
#zonal_shift_config ⇒ Types::ZonalShiftConfigResponse
The configuration for zonal shift for the cluster.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/aws-sdk-eks/types.rb', line 931 class Cluster < Struct.new( :name, :arn, :created_at, :version, :endpoint, :role_arn, :resources_vpc_config, :kubernetes_network_config, :logging, :identity, :status, :certificate_authority, :client_request_token, :platform_version, :tags, :encryption_config, :connector_config, :id, :health, :outpost_config, :access_config, :upgrade_policy, :zonal_shift_config, :remote_network_config, :compute_config, :storage_config) SENSITIVE = [] include Aws::Structure end |