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	awscc.eks.identity_provider_configs

Fields

get (all properties)

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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::EKS::IdentityProviderConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	identity_provider_configs	INSERT	Type, ClusterName, region
delete_resource	identity_provider_configs	DELETE	Identifier, region
update_resource	identity_provider_configs	UPDATE	Identifier, PatchDocument, region
list_resources	identity_provider_configs_list_only	SELECT	region
get_resource	identity_provider_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.eks.identity_provider_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identity_provider_config_name }}|{{ cluster_name }}|{{ type }}';

list (identifiers only)

Lists all identity_provider_configs in a region.

SELECT
  region,
  identity_provider_config_name,
  cluster_name,
  type
FROM awscc.eks.identity_provider_configs_list_only
WHERE
  region = '{{ region }}';

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 awscc.eks.identity_provider_configs (
  ClusterName,
  Type,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.eks.identity_provider_configs (
  ClusterName,
  Type,
  IdentityProviderConfigName,
  Oidc,
  Tags,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ type }}',
  '{{ identity_provider_config_name }}',
  '{{ oidc }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: cluster_name
      value: '{{ cluster_name }}'
    - name: type
      value: '{{ type }}'
    - name: identity_provider_config_name
      value: '{{ identity_provider_config_name }}'
    - name: oidc
      value:
        client_id: '{{ client_id }}'
        groups_claim: '{{ groups_claim }}'
        groups_prefix: '{{ groups_prefix }}'
        issuer_url: '{{ issuer_url }}'
        required_claims:
          - key: '{{ key }}'
            value: '{{ value }}'
        username_claim: '{{ username_claim }}'
        username_prefix: '{{ username_prefix }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.eks.identity_provider_configs
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ identity_provider_config_name }}|{{ cluster_name }}|{{ type }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.eks.identity_provider_configs
WHERE
  Identifier = '{{ identity_provider_config_name }}|{{ cluster_name }}|{{ type }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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