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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Connects a Kubernetes cluster to the Amazon EKS control plane.

Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.

Cluster connection requires two steps. First, send a RegisterClusterRequest to add it to the Amazon EKS control plane.

Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

Creating a Request

data RegisterCluster Source #

See: newRegisterCluster smart constructor.

Constructors

RegisterCluster'

Fields

clientRequestToken :: Maybe Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.
name :: Text
Define a unique name for this cluster for your Region.
connectorConfig :: ConnectorConfigRequest
The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

Instances

Instances details

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

newRegisterCluster Source #

Arguments

:: Text	`RegisterCluster`
-> ConnectorConfigRequest	`RegisterCluster`
-> RegisterCluster

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

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

RegisterCluster, registerCluster_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, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

RegisterCluster, registerCluster_name - Define a unique name for this cluster for your Region.

RegisterCluster, registerCluster_connectorConfig - The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

Request Lenses

registerCluster_clientRequestToken :: Lens' RegisterCluster (Maybe Text) Source #

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

registerCluster_tags :: Lens' RegisterCluster (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, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

registerCluster_name :: Lens' RegisterCluster Text Source #

Define a unique name for this cluster for your Region.

registerCluster_connectorConfig :: Lens' RegisterCluster ConnectorConfigRequest Source #

The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

Destructuring the Response

data RegisterClusterResponse Source #

See: newRegisterClusterResponse smart constructor.

Constructors

RegisterClusterResponse'
Fields cluster :: Maybe Cluster httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRegisterClusterResponse Source #

Arguments

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

Create a value of RegisterClusterResponse 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:RegisterClusterResponse', registerClusterResponse_cluster - Undocumented member.

$sel:httpStatus:RegisterClusterResponse', registerClusterResponse_httpStatus - The response's http status code.

Response Lenses

registerClusterResponse_cluster :: Lens' RegisterClusterResponse (Maybe Cluster) Source #

Undocumented member.

registerClusterResponse_httpStatus :: Lens' RegisterClusterResponse Int Source #

The response's http status code.