identity_provider_configs

Creates, updates, deletes, gets or lists an identity_provider_configs resource.

Overview

Name	identity_provider_configs
Type	Resource
Id	aws.eks.identity_provider_configs

Fields

The following fields are returned by SELECT queries:

describe_identity_provider_config

Name	Datatype	Description
oidc	object	An object representing an OpenID Connect (OIDC) identity provider configuration.

list_identity_provider_configs

Name	Datatype	Description
name	string	The name of the identity provider configuration.
type_	string	The type of the identity provider configuration. The only type available is oidc.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_identity_provider_config	select	name, region		Describes an identity provider configuration.
list_identity_provider_configs	select	name, region	maxResults, nextToken	Lists the identity provider configurations for your cluster.
associate_identity_provider_config	update	name, region, oidc		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.
disassociate_identity_provider_config	update	name, region, identityProviderConfig		Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of your cluster.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results, returned in paginated output. You receive maxResults in a single page, along with a nextToken response element. You can see the remaining results of the initial request by sending another request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a nextToken value, if applicable, are returned.
nextToken	string	The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

SELECT examples

describe_identity_provider_config

Describes an identity provider configuration.

SELECT
oidc
FROM aws.eks.identity_provider_configs
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_identity_provider_configs

Lists the identity provider configurations for your cluster.

SELECT
name,
type_
FROM aws.eks.identity_provider_configs
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

associate_identity_provider_config

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.

UPDATE aws.eks.identity_provider_configs
SET 
oidc = '{{ oidc }}',
tags = '{{ tags }}',
clientRequestToken = '{{ clientRequestToken }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND oidc = '{{ oidc }}' --required
RETURNING
tags,
update;

disassociate_identity_provider_config

Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with IAM principals.

UPDATE aws.eks.identity_provider_configs
SET 
identityProviderConfig = '{{ identityProviderConfig }}',
clientRequestToken = '{{ clientRequestToken }}'
WHERE 
name = '{{ name }}' --required
AND region = '{{ region }}' --required
AND identityProviderConfig = '{{ identityProviderConfig }}' --required
RETURNING
update;