EKS / Client / register_cluster

register_cluster#

EKS.Client.register_cluster(**kwargs)#

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, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn’t applied within three days, the connected cluster will no longer be visible and must be deregistered using DeregisterCluster.

See also: AWS API Documentation

Request Syntax

response = client.register_cluster(
    name='string',
    connectorConfig={
        'roleArn': 'string',
        'provider': 'EKS_ANYWHERE'|'ANTHOS'|'GKE'|'AKS'|'OPENSHIFT'|'TANZU'|'RANCHER'|'EC2'|'OTHER'
    },
    clientRequestToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    A unique name for this cluster in your Amazon Web Services Region.

  • connectorConfig (dict) –

    [REQUIRED]

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

    • roleArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.

    • provider (string) – [REQUIRED]

      The cloud provider for the target cluster to connect.

  • clientRequestToken (string) –

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

    This field is autopopulated if not provided.

  • tags (dict) –

    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.

    • (string) –

      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • (string) –

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'cluster': {
        'name': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'version': 'string',
        'endpoint': 'string',
        'roleArn': 'string',
        'resourcesVpcConfig': {
            'subnetIds': [
                'string',
            ],
            'securityGroupIds': [
                'string',
            ],
            'clusterSecurityGroupId': 'string',
            'vpcId': 'string',
            'endpointPublicAccess': True|False,
            'endpointPrivateAccess': True|False,
            'publicAccessCidrs': [
                'string',
            ]
        },
        'kubernetesNetworkConfig': {
            'serviceIpv4Cidr': 'string',
            'serviceIpv6Cidr': 'string',
            'ipFamily': 'ipv4'|'ipv6'
        },
        'logging': {
            'clusterLogging': [
                {
                    'types': [
                        'api'|'audit'|'authenticator'|'controllerManager'|'scheduler',
                    ],
                    'enabled': True|False
                },
            ]
        },
        'identity': {
            'oidc': {
                'issuer': 'string'
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'PENDING',
        'certificateAuthority': {
            'data': 'string'
        },
        'clientRequestToken': 'string',
        'platformVersion': 'string',
        'tags': {
            'string': 'string'
        },
        'encryptionConfig': [
            {
                'resources': [
                    'string',
                ],
                'provider': {
                    'keyArn': 'string'
                }
            },
        ],
        'connectorConfig': {
            'activationId': 'string',
            'activationCode': 'string',
            'activationExpiry': datetime(2015, 1, 1),
            'provider': 'string',
            'roleArn': 'string'
        },
        'id': 'string',
        'health': {
            'issues': [
                {
                    'code': 'AccessDenied'|'ClusterUnreachable'|'ConfigurationConflict'|'InternalFailure'|'ResourceLimitExceeded'|'ResourceNotFound'|'IamRoleNotFound'|'VpcNotFound'|'InsufficientFreeAddresses'|'Ec2ServiceNotSubscribed'|'Ec2SubnetNotFound'|'Ec2SecurityGroupNotFound'|'KmsGrantRevoked'|'KmsKeyNotFound'|'KmsKeyMarkedForDeletion'|'KmsKeyDisabled'|'StsRegionalEndpointDisabled'|'UnsupportedVersion'|'Other',
                    'message': 'string',
                    'resourceIds': [
                        'string',
                    ]
                },
            ]
        },
        'outpostConfig': {
            'outpostArns': [
                'string',
            ],
            'controlPlaneInstanceType': 'string',
            'controlPlanePlacement': {
                'groupName': 'string'
            }
        },
        'accessConfig': {
            'bootstrapClusterCreatorAdminPermissions': True|False,
            'authenticationMode': 'API'|'API_AND_CONFIG_MAP'|'CONFIG_MAP'
        },
        'upgradePolicy': {
            'supportType': 'STANDARD'|'EXTENDED'
        }
    }
}

Response Structure

  • (dict) –

    • cluster (dict) –

      An object representing an Amazon EKS cluster.

      • name (string) –

        The name of your cluster.

      • arn (string) –

        The Amazon Resource Name (ARN) of the cluster.

      • createdAt (datetime) –

        The Unix epoch timestamp at object creation.

      • version (string) –

        The Kubernetes server version for the cluster.

      • endpoint (string) –

        The endpoint for your Kubernetes API server.

      • roleArn (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.

      • resourcesVpcConfig (dict) –

        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.

        • subnetIds (list) –

          The subnets associated with your cluster.

          • (string) –

        • securityGroupIds (list) –

          The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

          • (string) –

        • clusterSecurityGroupId (string) –

          The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

        • vpcId (string) –

          The VPC associated with your cluster.

        • endpointPublicAccess (boolean) –

          Whether the public API server endpoint is enabled.

        • endpointPrivateAccess (boolean) –

          This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster’s VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

        • publicAccessCidrs (list) –

          The CIDR blocks that are allowed access to your cluster’s public Kubernetes API server endpoint.

          • (string) –

      • kubernetesNetworkConfig (dict) –

        The Kubernetes network configuration for the cluster.

        • serviceIpv4Cidr (string) –

          The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If you didn’t specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it can’t be changed.

        • serviceIpv6Cidr (string) –

          The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range ( fc00::/7) because you can’t specify a custom IPv6 CIDR block when you create the cluster.

        • ipFamily (string) –

          The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.

      • logging (dict) –

        The logging configuration for your cluster.

        • clusterLogging (list) –

          The cluster control plane logging configuration for your cluster.

          • (dict) –

            An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

            • types (list) –

              The available cluster control plane log types.

              • (string) –

            • enabled (boolean) –

              If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn’t enabled, that log type doesn’t export its control plane logs. Each individual log type can be enabled or disabled independently.

      • identity (dict) –

        The identity provider information for the cluster.

        • oidc (dict) –

          An object representing the OpenID Connect identity provider information.

          • issuer (string) –

            The issuer URL for the OIDC identity provider.

      • status (string) –

        The current status of the cluster.

      • certificateAuthority (dict) –

        The certificate-authority-data for your cluster.

        • data (string) –

          The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

      • clientRequestToken (string) –

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

      • platformVersion (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 .

      • tags (dict) –

        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.

        • (string) –

          One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

          • (string) –

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

      • encryptionConfig (list) –

        The encryption configuration for the cluster.

        • (dict) –

          The encryption configuration for the cluster.

          • resources (list) –

            Specifies the resources to be encrypted. The only supported value is secrets.

            • (string) –

          • provider (dict) –

            Key Management Service (KMS) key. Either the ARN or the alias can be used.

            • keyArn (string) –

              Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.

      • connectorConfig (dict) –

        The configuration used to connect to a cluster for registration.

        • activationId (string) –

          A unique ID associated with the cluster for registration purposes.

        • activationCode (string) –

          A unique code associated with the cluster for registration purposes.

        • activationExpiry (datetime) –

          The expiration time of the connected cluster. The cluster’s YAML file must be applied through the native provider.

        • provider (string) –

          The cluster’s cloud service provider.

        • roleArn (string) –

          The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

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

      • health (dict) –

        An object representing the health of your Amazon EKS cluster.

        • issues (list) –

          An object representing the health issues of your Amazon EKS cluster.

          • (dict) –

            An issue with your Amazon EKS cluster.

            • code (string) –

              The error code of the issue.

            • message (string) –

              A description of the issue.

            • resourceIds (list) –

              The resource IDs that the issue relates to.

              • (string) –

      • outpostConfig (dict) –

        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.

        • outpostArns (list) –

          The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.

          • (string) –

        • controlPlaneInstanceType (string) –

          The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.

        • controlPlanePlacement (dict) –

          An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.

          • groupName (string) –

            The name of the placement group for the Kubernetes control plane instances.

      • accessConfig (dict) –

        The access configuration for the cluster.

        • bootstrapClusterCreatorAdminPermissions (boolean) –

          Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.

        • authenticationMode (string) –

          The current authentication mode of the cluster.

      • upgradePolicy (dict) –

        This value indicates if extended support is enabled or disabled for the cluster.

        Learn more about EKS Extended Support in the EKS User Guide.

Exceptions

  • EKS.Client.exceptions.ResourceLimitExceededException

  • EKS.Client.exceptions.InvalidParameterException

  • EKS.Client.exceptions.ClientException

  • EKS.Client.exceptions.ServerException

  • EKS.Client.exceptions.ServiceUnavailableException

  • EKS.Client.exceptions.AccessDeniedException

  • EKS.Client.exceptions.ResourceInUseException

  • EKS.Client.exceptions.ResourcePropagationDelayException