AssociateIdentityProviderConfig - Amazon EKS

AssociateIdentityProviderConfig

Associates an identity provider configuration to a cluster.

If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes Role and ClusterRole objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see Using RBAC Authorization in the Kubernetes documentation.

Request Syntax

POST /clusters/name/identity-provider-configs/associate HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "oidc": { "clientId": "string", "groupsClaim": "string", "groupsPrefix": "string", "identityProviderConfigName": "string", "issuerUrl": "string", "requiredClaims": { "string" : "string" }, "usernameClaim": "string", "usernamePrefix": "string" }, "tags": { "string" : "string" } }

URI Request Parameters

The request uses the following URI parameters.

name

The name of your cluster.

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

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

Type: String

Required: No

oidc

An object representing an OpenID Connect (OIDC) identity provider configuration.

Type: OidcIdentityProviderConfigRequest object

Required: Yes

tags

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 AWS resources.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" }, "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

tags

The tags for the resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

update

An object representing an asynchronous update.

Type: Update object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClientException

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

addonName

The Amazon EKS add-on name associated with the exception.

clusterName

The Amazon EKS cluster associated with the exception.

message

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

nodegroupName

The Amazon EKS managed node group associated with the exception.

subscriptionId

The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

addonName

The specified parameter for the add-on name is invalid. Review the available parameters for the API request

clusterName

The Amazon EKS cluster associated with the exception.

fargateProfileName

The Fargate profile associated with the exception.

message

The specified parameter is invalid. Review the available parameters for the API request.

nodegroupName

The Amazon EKS managed node group associated with the exception.

subscriptionId

The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

addonName

The request is invalid given the state of the add-on name. Check the state of the cluster and the associated operations.

clusterName

The Amazon EKS cluster associated with the exception.

message

The Amazon EKS add-on name associated with the exception.

nodegroupName

The Amazon EKS managed node group associated with the exception.

subscriptionId

The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

addonName

The specified add-on name is in use.

clusterName

The Amazon EKS cluster associated with the exception.

message

The Amazon EKS message associated with the exception.

nodegroupName

The Amazon EKS managed node group associated with the exception.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.

addonName

The Amazon EKS add-on name associated with the exception.

clusterName

The Amazon EKS cluster associated with the exception.

fargateProfileName

The Fargate profile associated with the exception.

message

The Amazon EKS message associated with the exception.

nodegroupName

The Amazon EKS managed node group associated with the exception.

subscriptionId

The Amazon EKS subscription ID with the exception.

HTTP Status Code: 404

ServerException

These errors are usually caused by a server-side issue.

addonName

The Amazon EKS add-on name associated with the exception.

clusterName

The Amazon EKS cluster associated with the exception.

message

These errors are usually caused by a server-side issue.

nodegroupName

The Amazon EKS managed node group associated with the exception.

subscriptionId

The Amazon EKS subscription ID with the exception.

HTTP Status Code: 500

ThrottlingException

The request or operation couldn't be performed because a service is throttling requests.

clusterName

The Amazon EKS cluster associated with the exception.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: