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.DescribeCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

Creating a Request

data DescribeCluster Source #

See: newDescribeCluster smart constructor.

Constructors

DescribeCluster'
Fields name :: Text The name of the cluster to describe.

Instances

Instances details

ToHeaders DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods toHeaders :: DescribeCluster -> [Header] #
ToPath DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods toPath :: DescribeCluster -> ByteString #
ToQuery DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods toQuery :: DescribeCluster -> QueryString #
AWSRequest DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Associated Types type AWSResponse DescribeCluster # Methods request :: (Service -> Service) -> DescribeCluster -> Request DescribeCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCluster))) #
Generic DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Associated Types type Rep DescribeCluster :: Type -> Type # Methods from :: DescribeCluster -> Rep DescribeCluster x # to :: Rep DescribeCluster x -> DescribeCluster #
Read DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods readsPrec :: Int -> ReadS DescribeCluster # readList :: ReadS [DescribeCluster] # readPrec :: ReadPrec DescribeCluster # readListPrec :: ReadPrec [DescribeCluster] #
Show DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods showsPrec :: Int -> DescribeCluster -> ShowS # show :: DescribeCluster -> String # showList :: [DescribeCluster] -> ShowS #
NFData DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods rnf :: DescribeCluster -> () #
Eq DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods (==) :: DescribeCluster -> DescribeCluster -> Bool # (/=) :: DescribeCluster -> DescribeCluster -> Bool #
Hashable DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods hashWithSalt :: Int -> DescribeCluster -> Int # hash :: DescribeCluster -> Int #
type AWSResponse DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster type AWSResponse DescribeCluster = DescribeClusterResponse
type Rep DescribeCluster Source #
Instance details Defined in Amazonka.EKS.DescribeCluster type Rep DescribeCluster = D1 ('MetaData "DescribeCluster" "Amazonka.EKS.DescribeCluster" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "DescribeCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCluster Source #

Arguments

:: Text	`DescribeCluster`
-> DescribeCluster

Create a value of DescribeCluster 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:

DescribeCluster, describeCluster_name - The name of the cluster to describe.

Request Lenses

describeCluster_name :: Lens' DescribeCluster Text Source #

The name of the cluster to describe.

Destructuring the Response

data DescribeClusterResponse Source #

See: newDescribeClusterResponse smart constructor.

Constructors

DescribeClusterResponse'
Fields cluster :: Maybe Cluster The full description of your specified cluster. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Associated Types type Rep DescribeClusterResponse :: Type -> Type # Methods from :: DescribeClusterResponse -> Rep DescribeClusterResponse x # to :: Rep DescribeClusterResponse x -> DescribeClusterResponse #
Read DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods readsPrec :: Int -> ReadS DescribeClusterResponse # readList :: ReadS [DescribeClusterResponse] # readPrec :: ReadPrec DescribeClusterResponse # readListPrec :: ReadPrec [DescribeClusterResponse] #
Show DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods showsPrec :: Int -> DescribeClusterResponse -> ShowS # show :: DescribeClusterResponse -> String # showList :: [DescribeClusterResponse] -> ShowS #
NFData DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods rnf :: DescribeClusterResponse -> () #
Eq DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster Methods (==) :: DescribeClusterResponse -> DescribeClusterResponse -> Bool # (/=) :: DescribeClusterResponse -> DescribeClusterResponse -> Bool #
type Rep DescribeClusterResponse Source #
Instance details Defined in Amazonka.EKS.DescribeCluster type Rep DescribeClusterResponse = D1 ('MetaData "DescribeClusterResponse" "Amazonka.EKS.DescribeCluster" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "DescribeClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeClusterResponse'`
-> DescribeClusterResponse

Create a value of DescribeClusterResponse 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:cluster:DescribeClusterResponse', describeClusterResponse_cluster - The full description of your specified cluster.

$sel:httpStatus:DescribeClusterResponse', describeClusterResponse_httpStatus - The response's http status code.

Response Lenses

describeClusterResponse_cluster :: Lens' DescribeClusterResponse (Maybe Cluster) Source #

The full description of your specified cluster.

describeClusterResponse_httpStatus :: Lens' DescribeClusterResponse Int Source #

The response's http status code.