Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EKS.Types.Cluster

Description

Synopsis

data Cluster = Cluster' {
- arn :: Maybe Text
- certificateAuthority :: Maybe Certificate
- clientRequestToken :: Maybe Text
- connectorConfig :: Maybe ConnectorConfigResponse
- createdAt :: Maybe POSIX
- encryptionConfig :: Maybe [EncryptionConfig]
- endpoint :: Maybe Text
- health :: Maybe ClusterHealth
- id :: Maybe Text
- identity :: Maybe Identity
- kubernetesNetworkConfig :: Maybe KubernetesNetworkConfigResponse
- logging :: Maybe Logging
- name :: Maybe Text
- outpostConfig :: Maybe OutpostConfigResponse
- platformVersion :: Maybe Text
- resourcesVpcConfig :: Maybe VpcConfigResponse
- roleArn :: Maybe Text
- status :: Maybe ClusterStatus
- tags :: Maybe (HashMap Text Text)
- version :: Maybe Text
}
newCluster :: Cluster
cluster_arn :: Lens' Cluster (Maybe Text)
cluster_certificateAuthority :: Lens' Cluster (Maybe Certificate)
cluster_clientRequestToken :: Lens' Cluster (Maybe Text)
cluster_connectorConfig :: Lens' Cluster (Maybe ConnectorConfigResponse)
cluster_createdAt :: Lens' Cluster (Maybe UTCTime)
cluster_encryptionConfig :: Lens' Cluster (Maybe [EncryptionConfig])
cluster_endpoint :: Lens' Cluster (Maybe Text)
cluster_health :: Lens' Cluster (Maybe ClusterHealth)
cluster_id :: Lens' Cluster (Maybe Text)
cluster_identity :: Lens' Cluster (Maybe Identity)
cluster_kubernetesNetworkConfig :: Lens' Cluster (Maybe KubernetesNetworkConfigResponse)
cluster_logging :: Lens' Cluster (Maybe Logging)
cluster_name :: Lens' Cluster (Maybe Text)
cluster_outpostConfig :: Lens' Cluster (Maybe OutpostConfigResponse)
cluster_platformVersion :: Lens' Cluster (Maybe Text)
cluster_resourcesVpcConfig :: Lens' Cluster (Maybe VpcConfigResponse)
cluster_roleArn :: Lens' Cluster (Maybe Text)
cluster_status :: Lens' Cluster (Maybe ClusterStatus)
cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text))
cluster_version :: Lens' Cluster (Maybe Text)

Documentation

data Cluster Source #

An object representing an Amazon EKS cluster.

See: newCluster smart constructor.

Constructors

Cluster'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the cluster.
certificateAuthority :: Maybe Certificate
The certificate-authority-data for your cluster.
clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
connectorConfig :: Maybe ConnectorConfigResponse
The configuration used to connect to a cluster for registration.
createdAt :: Maybe POSIX
The Unix epoch timestamp in seconds for when the cluster was created.
encryptionConfig :: Maybe [EncryptionConfig]
The encryption configuration for the cluster.
endpoint :: Maybe Text
The endpoint for your Kubernetes API server.
health :: Maybe ClusterHealth
An object representing the health 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.
id :: Maybe Text
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.
identity :: Maybe Identity
The identity provider information for the cluster.
kubernetesNetworkConfig :: Maybe KubernetesNetworkConfigResponse
The Kubernetes network configuration for the cluster.
logging :: Maybe Logging
The logging configuration for your cluster.
name :: Maybe Text
The name of the cluster.
outpostConfig :: Maybe 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.
platformVersion :: Maybe Text
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the /Amazon EKS User Guide/ .
resourcesVpcConfig :: Maybe 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.
roleArn :: Maybe Text
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 :: Maybe ClusterStatus
The current status of the cluster.
tags :: Maybe (HashMap Text Text)
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.
version :: Maybe Text
The Kubernetes server version for the cluster.

Instances

Instances details

FromJSON Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
Generic Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
Read Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
NFData Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods rnf :: Cluster -> () #
Eq Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Hashable Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster Methods hashWithSalt :: Int -> Cluster -> Int # hash :: Cluster -> Int #
type Rep Cluster Source #
Instance details Defined in Amazonka.EKS.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.EKS.Types.Cluster" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateAuthority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Certificate))) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "connectorConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorConfigResponse)) :: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "encryptionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EncryptionConfig])) :: S1 ('MetaSel ('Just "endpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterHealth)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity)))))) :: (((S1 ('MetaSel ('Just "kubernetesNetworkConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KubernetesNetworkConfigResponse)) :: S1 ('MetaSel ('Just "logging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Logging))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "outpostConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutpostConfigResponse)) :: S1 ('MetaSel ('Just "platformVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "resourcesVpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigResponse)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterStatus)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newCluster :: Cluster Source #

Create a value of Cluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:Cluster', cluster_arn - The Amazon Resource Name (ARN) of the cluster.

$sel:certificateAuthority:Cluster', cluster_certificateAuthority - The certificate-authority-data for your cluster.

$sel:clientRequestToken:Cluster', cluster_clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:connectorConfig:Cluster', cluster_connectorConfig - The configuration used to connect to a cluster for registration.

$sel:createdAt:Cluster', cluster_createdAt - The Unix epoch timestamp in seconds for when the cluster was created.

$sel:encryptionConfig:Cluster', cluster_encryptionConfig - The encryption configuration for the cluster.

$sel:endpoint:Cluster', cluster_endpoint - The endpoint for your Kubernetes API server.

$sel:health:Cluster', cluster_health - An object representing the health 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.

$sel:id:Cluster', cluster_id - 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.

$sel:identity:Cluster', cluster_identity - The identity provider information for the cluster.

$sel:kubernetesNetworkConfig:Cluster', cluster_kubernetesNetworkConfig - The Kubernetes network configuration for the cluster.

$sel:logging:Cluster', cluster_logging - The logging configuration for your cluster.

$sel:name:Cluster', cluster_name - The name of the cluster.

$sel:outpostConfig:Cluster', cluster_outpostConfig - 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.

$sel:platformVersion:Cluster', cluster_platformVersion - The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the /Amazon EKS User Guide/ .

$sel:resourcesVpcConfig:Cluster', cluster_resourcesVpcConfig - 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.

Cluster, cluster_roleArn - 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.

$sel:status:Cluster', cluster_status - The current status of the cluster.

$sel:tags:Cluster', cluster_tags - The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.

$sel:version:Cluster', cluster_version - The Kubernetes server version for the cluster.

cluster_arn :: Lens' Cluster (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster.

cluster_certificateAuthority :: Lens' Cluster (Maybe Certificate) Source #

The certificate-authority-data for your cluster.

cluster_clientRequestToken :: Lens' Cluster (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

cluster_connectorConfig :: Lens' Cluster (Maybe ConnectorConfigResponse) Source #

The configuration used to connect to a cluster for registration.

cluster_createdAt :: Lens' Cluster (Maybe UTCTime) Source #

The Unix epoch timestamp in seconds for when the cluster was created.

cluster_encryptionConfig :: Lens' Cluster (Maybe [EncryptionConfig]) Source #

The encryption configuration for the cluster.

cluster_endpoint :: Lens' Cluster (Maybe Text) Source #

The endpoint for your Kubernetes API server.

cluster_health :: Lens' Cluster (Maybe ClusterHealth) Source #

An object representing the health 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.

cluster_id :: Lens' Cluster (Maybe Text) Source #

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.

cluster_identity :: Lens' Cluster (Maybe Identity) Source #

The identity provider information for the cluster.

cluster_kubernetesNetworkConfig :: Lens' Cluster (Maybe KubernetesNetworkConfigResponse) Source #

The Kubernetes network configuration for the cluster.

cluster_logging :: Lens' Cluster (Maybe Logging) Source #

The logging configuration for your cluster.

cluster_name :: Lens' Cluster (Maybe Text) Source #

The name of the cluster.

cluster_outpostConfig :: Lens' Cluster (Maybe OutpostConfigResponse) Source #

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.

cluster_platformVersion :: Lens' Cluster (Maybe Text) Source #

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the /Amazon EKS User Guide/ .

cluster_resourcesVpcConfig :: Lens' Cluster (Maybe VpcConfigResponse) Source #

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.

cluster_roleArn :: Lens' Cluster (Maybe Text) Source #

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.

cluster_status :: Lens' Cluster (Maybe ClusterStatus) Source #

The current status of the cluster.

cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text)) Source #

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.

cluster_version :: Lens' Cluster (Maybe Text) Source #

The Kubernetes server version for the cluster.