Amazon Elastic Kubernetes Service

2021/11/15 - Amazon Elastic Kubernetes Service - 1 updated api methods

Changes  Adding Tags support to Cluster Registrations.

RegisterCluster (updated) Link ΒΆ
Changes (request)
{'tags': {'string': 'string'}}

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 .

See also: AWS API Documentation

Request Syntax

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

string

param name

[REQUIRED]

Define a unique name for this cluster for your Region.

type connectorConfig

dict

param connectorConfig

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

type clientRequestToken

string

param clientRequestToken

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

This field is autopopulated if not provided.

type tags

dict

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

  • (string) --

    • (string) --

rtype

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'
        },
        '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'
        }
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      An object representing an Amazon EKS cluster.

      • name (string) --

        The name of the cluster.

      • arn (string) --

        The Amazon Resource Name (ARN) of the cluster.

      • createdAt (datetime) --

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

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

          This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.

        • 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. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the * Amazon EKS User Guide * .

          • (string) --

      • kubernetesNetworkConfig (dict) --

        The Kubernetes network configuration for the cluster.

        • serviceIpv4Cidr (string) --

          The CIDR block that Kubernetes service IP addresses are assigned from. 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 cannot be changed.

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

        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, see Platform Versions in the * Amazon EKS User Guide * .

      • tags (dict) --

        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.

        • (string) --

          • (string) --

      • 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, created in the same region as the cluster, and if the KMS key was created in a different account, the user 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.