identity_provider_configs

Creates, updates, deletes or gets an identity_provider_config resource or lists identity_provider_configs in a region

Overview

Name	identity_provider_configs
Type	Resource
Description	An object representing an Amazon EKS IdentityProviderConfig.
Id	aws.eks.identity_provider_configs

Fields

Name	Datatype	Description
cluster_name	string	The name of the identity provider configuration.
type	string	The type of the identity provider configuration.
identity_provider_config_name	string	The name of the OIDC provider configuration.
oidc	object	An object representing an OpenID Connect (OIDC) configuration.
tags	array	An array of key-value pairs to apply to this resource.
identity_provider_config_arn	string	The ARN of the configuration.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Type, ClusterName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all identity_provider_configs in a region.

SELECT
region,
cluster_name,
type,
identity_provider_config_name,
oidc,
tags,
identity_provider_config_arn
FROM aws.eks.identity_provider_configs
WHERE region = 'us-east-1';

Gets all properties from an individual identity_provider_config.

SELECT
region,
cluster_name,
type,
identity_provider_config_name,
oidc,
tags,
identity_provider_config_arn
FROM aws.eks.identity_provider_configs
WHERE region = 'us-east-1' AND data__Identifier = '<IdentityProviderConfigName>|<ClusterName>|<Type>';

INSERT example

Use the following StackQL query and manifest file to create a new identity_provider_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.eks.identity_provider_configs (
 ClusterName,
 Type,
 region
)
SELECT 
'{{ ClusterName }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.eks.identity_provider_configs (
 ClusterName,
 Type,
 IdentityProviderConfigName,
 Oidc,
 Tags,
 region
)
SELECT 
 '{{ ClusterName }}',
 '{{ Type }}',
 '{{ IdentityProviderConfigName }}',
 '{{ Oidc }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: identity_provider_config
    props:
      - name: ClusterName
        value: '{{ ClusterName }}'
      - name: Type
        value: '{{ Type }}'
      - name: IdentityProviderConfigName
        value: '{{ IdentityProviderConfigName }}'
      - name: Oidc
        value:
          ClientId: '{{ ClientId }}'
          GroupsClaim: '{{ GroupsClaim }}'
          GroupsPrefix: '{{ GroupsPrefix }}'
          IssuerUrl: '{{ IssuerUrl }}'
          RequiredClaims:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
          UsernameClaim: '{{ UsernameClaim }}'
          UsernamePrefix: '{{ UsernamePrefix }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.eks.identity_provider_configs
WHERE data__Identifier = '<IdentityProviderConfigName|ClusterName|Type>'
AND region = 'us-east-1';

Permissions

To operate on the identity_provider_configs resource, the following permissions are required:

Create

eks:DescribeUpdate,
eks:AssociateIdentityProviderConfig,
eks:DescribeIdentityProviderConfig,
eks:TagResource

Read

eks:DescribeIdentityProviderConfig

Update

eks:DescribeIdentityProviderConfig,
eks:TagResource,
eks:UntagResource

Delete

eks:DisassociateIdentityProviderConfig,
eks:DescribeIdentityProviderConfig

List

eks:ListIdentityProviderConfigs