aws logo
AWS Classic v5.29.0, Feb 1 23

aws.eks.IdentityProviderConfig

Manages an EKS Identity Provider Configuration.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Eks.IdentityProviderConfig("example", new()
    {
        ClusterName = aws_eks_cluster.Example.Name,
        Oidc = new Aws.Eks.Inputs.IdentityProviderConfigOidcArgs
        {
            ClientId = "your client_id",
            IdentityProviderConfigName = "example",
            IssuerUrl = "your issuer_url",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/eks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eks.NewIdentityProviderConfig(ctx, "example", &eks.IdentityProviderConfigArgs{
			ClusterName: pulumi.Any(aws_eks_cluster.Example.Name),
			Oidc: &eks.IdentityProviderConfigOidcArgs{
				ClientId:                   pulumi.String("your client_id"),
				IdentityProviderConfigName: pulumi.String("example"),
				IssuerUrl:                  pulumi.String("your issuer_url"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.IdentityProviderConfig;
import com.pulumi.aws.eks.IdentityProviderConfigArgs;
import com.pulumi.aws.eks.inputs.IdentityProviderConfigOidcArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new IdentityProviderConfig("example", IdentityProviderConfigArgs.builder()        
            .clusterName(aws_eks_cluster.example().name())
            .oidc(IdentityProviderConfigOidcArgs.builder()
                .clientId("your client_id")
                .identityProviderConfigName("example")
                .issuerUrl("your issuer_url")
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.eks.IdentityProviderConfig("example",
    cluster_name=aws_eks_cluster["example"]["name"],
    oidc=aws.eks.IdentityProviderConfigOidcArgs(
        client_id="your client_id",
        identity_provider_config_name="example",
        issuer_url="your issuer_url",
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.eks.IdentityProviderConfig("example", {
    clusterName: aws_eks_cluster.example.name,
    oidc: {
        clientId: "your client_id",
        identityProviderConfigName: "example",
        issuerUrl: "your issuer_url",
    },
});
resources:
  example:
    type: aws:eks:IdentityProviderConfig
    properties:
      clusterName: ${aws_eks_cluster.example.name}
      oidc:
        clientId: your client_id
        identityProviderConfigName: example
        issuerUrl: your issuer_url

Create IdentityProviderConfig Resource

new IdentityProviderConfig(name: string, args: IdentityProviderConfigArgs, opts?: CustomResourceOptions);
@overload
def IdentityProviderConfig(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cluster_name: Optional[str] = None,
                           oidc: Optional[IdentityProviderConfigOidcArgs] = None,
                           tags: Optional[Mapping[str, str]] = None)
@overload
def IdentityProviderConfig(resource_name: str,
                           args: IdentityProviderConfigArgs,
                           opts: Optional[ResourceOptions] = None)
func NewIdentityProviderConfig(ctx *Context, name string, args IdentityProviderConfigArgs, opts ...ResourceOption) (*IdentityProviderConfig, error)
public IdentityProviderConfig(string name, IdentityProviderConfigArgs args, CustomResourceOptions? opts = null)
public IdentityProviderConfig(String name, IdentityProviderConfigArgs args)
public IdentityProviderConfig(String name, IdentityProviderConfigArgs args, CustomResourceOptions options)
type: aws:eks:IdentityProviderConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args IdentityProviderConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args IdentityProviderConfigArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args IdentityProviderConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IdentityProviderConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args IdentityProviderConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

IdentityProviderConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The IdentityProviderConfig resource accepts the following input properties:

ClusterName string

Name of the EKS Cluster.

Oidc Pulumi.Aws.Eks.Inputs.IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ClusterName string

Name of the EKS Cluster.

Oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterName String

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterName string

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

cluster_name str

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

clusterName String

Name of the EKS Cluster.

oidc Property Map

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityProviderConfig resource produces the following output properties:

Arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the EKS Identity Provider Configuration.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Status of the EKS Identity Provider Configuration.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the EKS Identity Provider Configuration.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

id string

The provider-assigned unique ID for this managed resource.

status string

Status of the EKS Identity Provider Configuration.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

id str

The provider-assigned unique ID for this managed resource.

status str

Status of the EKS Identity Provider Configuration.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

id String

The provider-assigned unique ID for this managed resource.

status String

Status of the EKS Identity Provider Configuration.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing IdentityProviderConfig Resource

Get an existing IdentityProviderConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: IdentityProviderConfigState, opts?: CustomResourceOptions): IdentityProviderConfig
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cluster_name: Optional[str] = None,
        oidc: Optional[IdentityProviderConfigOidcArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> IdentityProviderConfig
func GetIdentityProviderConfig(ctx *Context, name string, id IDInput, state *IdentityProviderConfigState, opts ...ResourceOption) (*IdentityProviderConfig, error)
public static IdentityProviderConfig Get(string name, Input<string> id, IdentityProviderConfigState? state, CustomResourceOptions? opts = null)
public static IdentityProviderConfig get(String name, Output<String> id, IdentityProviderConfigState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

ClusterName string

Name of the EKS Cluster.

Oidc Pulumi.Aws.Eks.Inputs.IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

Status string

Status of the EKS Identity Provider Configuration.

Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

ClusterName string

Name of the EKS Cluster.

Oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

Status string

Status of the EKS Identity Provider Configuration.

Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

clusterName String

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

status String

Status of the EKS Identity Provider Configuration.

tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

clusterName string

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

status string

Status of the EKS Identity Provider Configuration.

tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

cluster_name str

Name of the EKS Cluster.

oidc IdentityProviderConfigOidcArgs

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

status str

Status of the EKS Identity Provider Configuration.

tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.

clusterName String

Name of the EKS Cluster.

oidc Property Map

Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.

status String

Status of the EKS Identity Provider Configuration.

tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

IdentityProviderConfigOidc

ClientId string

Client ID for the OpenID Connect identity provider.

IdentityProviderConfigName string

The name of the identity provider config.

IssuerUrl string

Issuer URL for the OpenID Connect identity provider.

GroupsClaim string

The JWT claim that the provider will use to return groups.

GroupsPrefix string

A prefix that is prepended to group claims e.g., oidc:.

RequiredClaims Dictionary<string, string>

The key value pairs that describe required claims in the identity token.

UsernameClaim string

The JWT claim that the provider will use as the username.

UsernamePrefix string

A prefix that is prepended to username claims.

ClientId string

Client ID for the OpenID Connect identity provider.

IdentityProviderConfigName string

The name of the identity provider config.

IssuerUrl string

Issuer URL for the OpenID Connect identity provider.

GroupsClaim string

The JWT claim that the provider will use to return groups.

GroupsPrefix string

A prefix that is prepended to group claims e.g., oidc:.

RequiredClaims map[string]string

The key value pairs that describe required claims in the identity token.

UsernameClaim string

The JWT claim that the provider will use as the username.

UsernamePrefix string

A prefix that is prepended to username claims.

clientId String

Client ID for the OpenID Connect identity provider.

identityProviderConfigName String

The name of the identity provider config.

issuerUrl String

Issuer URL for the OpenID Connect identity provider.

groupsClaim String

The JWT claim that the provider will use to return groups.

groupsPrefix String

A prefix that is prepended to group claims e.g., oidc:.

requiredClaims Map<String,String>

The key value pairs that describe required claims in the identity token.

usernameClaim String

The JWT claim that the provider will use as the username.

usernamePrefix String

A prefix that is prepended to username claims.

clientId string

Client ID for the OpenID Connect identity provider.

identityProviderConfigName string

The name of the identity provider config.

issuerUrl string

Issuer URL for the OpenID Connect identity provider.

groupsClaim string

The JWT claim that the provider will use to return groups.

groupsPrefix string

A prefix that is prepended to group claims e.g., oidc:.

requiredClaims {[key: string]: string}

The key value pairs that describe required claims in the identity token.

usernameClaim string

The JWT claim that the provider will use as the username.

usernamePrefix string

A prefix that is prepended to username claims.

client_id str

Client ID for the OpenID Connect identity provider.

identity_provider_config_name str

The name of the identity provider config.

issuer_url str

Issuer URL for the OpenID Connect identity provider.

groups_claim str

The JWT claim that the provider will use to return groups.

groups_prefix str

A prefix that is prepended to group claims e.g., oidc:.

required_claims Mapping[str, str]

The key value pairs that describe required claims in the identity token.

username_claim str

The JWT claim that the provider will use as the username.

username_prefix str

A prefix that is prepended to username claims.

clientId String

Client ID for the OpenID Connect identity provider.

identityProviderConfigName String

The name of the identity provider config.

issuerUrl String

Issuer URL for the OpenID Connect identity provider.

groupsClaim String

The JWT claim that the provider will use to return groups.

groupsPrefix String

A prefix that is prepended to group claims e.g., oidc:.

requiredClaims Map<String>

The key value pairs that describe required claims in the identity token.

usernameClaim String

The JWT claim that the provider will use as the username.

usernamePrefix String

A prefix that is prepended to username claims.

Import

EKS Identity Provider Configurations can be imported using the cluster_name and identity_provider_config_name separated by a colon (:), e.g.,

 $ pulumi import aws:eks/identityProviderConfig:IdentityProviderConfig my_identity_provider_config my_cluster:my_identity_provider_config

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.