libZSservicesZSamazonka-eksZSamazonka-eks
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EKS.RegisterCluster

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 a set amount of time, then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

Synopsis

Creating a Request

data RegisterCluster Source #

See: newRegisterCluster smart constructor.

Constructors

RegisterCluster' 

Fields

Instances

Instances details
Eq RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Read RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Show RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Generic RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Associated Types

type Rep RegisterCluster :: Type -> Type #

NFData RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Methods

rnf :: RegisterCluster -> () #

Hashable RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

ToJSON RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

AWSRequest RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Associated Types

type AWSResponse RegisterCluster #

ToHeaders RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

ToPath RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

ToQuery RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

type Rep RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

type Rep RegisterCluster = D1 ('MetaData "RegisterCluster" "Amazonka.EKS.RegisterCluster" "libZSservicesZSamazonka-eksZSamazonka-eks" 'False) (C1 ('MetaCons "RegisterCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "connectorConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConnectorConfigRequest))))
type AWSResponse RegisterCluster Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

newRegisterCluster Source #

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:

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

$sel:name:RegisterCluster', registerCluster_name - Define a unique name for this cluster within your AWS account.

$sel:connectorConfig: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_name :: Lens' RegisterCluster Text Source #

Define a unique name for this cluster within your AWS account.

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

Instances

Instances details
Eq RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Read RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Show RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Generic RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Associated Types

type Rep RegisterClusterResponse :: Type -> Type #

NFData RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

Methods

rnf :: RegisterClusterResponse -> () #

type Rep RegisterClusterResponse Source # 
Instance details

Defined in Amazonka.EKS.RegisterCluster

type Rep RegisterClusterResponse = D1 ('MetaData "RegisterClusterResponse" "Amazonka.EKS.RegisterCluster" "libZSservicesZSamazonka-eksZSamazonka-eks" '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 #

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