Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. eks
  5. IdentityProviderConfig
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.eks.IdentityProviderConfig

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Manages an EKS Identity Provider Configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

    import pulumi
import pulumi_aws as aws

example = aws.eks.IdentityProviderConfig("example",
    cluster_name=example_aws_eks_cluster["name"],
    oidc={
        "client_id": "your client_id",
        "identity_provider_config_name": "example",
        "issuer_url": "your issuer_url",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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(exampleAwsEksCluster.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
	})
}

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

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

});

    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(exampleAwsEksCluster.name())
            .oidc(IdentityProviderConfigOidcArgs.builder()
                .clientId("your client_id")
                .identityProviderConfigName("example")
                .issuerUrl("your issuer_url")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:eks:IdentityProviderConfig
    properties:
      clusterName: ${exampleAwsEksCluster.name}
      oidc:
        clientId: your client_id
        identityProviderConfigName: example
        issuerUrl: your issuer_url

    Create IdentityProviderConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdentityProviderConfig(name: string, args: IdentityProviderConfigArgs, opts?: CustomResourceOptions);
    @overload
def IdentityProviderConfig(resource_name: str,
                           args: IdentityProviderConfigArgs,
                           opts: Optional[ResourceOptions] = None)

@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)
    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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var identityProviderConfigResource = new Aws.Eks.IdentityProviderConfig("identityProviderConfigResource", new()
{
    ClusterName = "string",
    Oidc = new Aws.Eks.Inputs.IdentityProviderConfigOidcArgs
    {
        ClientId = "string",
        IdentityProviderConfigName = "string",
        IssuerUrl = "string",
        GroupsClaim = "string",
        GroupsPrefix = "string",
        RequiredClaims = 
        {
            { "string", "string" },
        },
        UsernameClaim = "string",
        UsernamePrefix = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := eks.NewIdentityProviderConfig(ctx, "identityProviderConfigResource", &eks.IdentityProviderConfigArgs{
	ClusterName: pulumi.String("string"),
	Oidc: &eks.IdentityProviderConfigOidcArgs{
		ClientId:                   pulumi.String("string"),
		IdentityProviderConfigName: pulumi.String("string"),
		IssuerUrl:                  pulumi.String("string"),
		GroupsClaim:                pulumi.String("string"),
		GroupsPrefix:               pulumi.String("string"),
		RequiredClaims: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		UsernameClaim:  pulumi.String("string"),
		UsernamePrefix: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var identityProviderConfigResource = new IdentityProviderConfig("identityProviderConfigResource", IdentityProviderConfigArgs.builder()
    .clusterName("string")
    .oidc(IdentityProviderConfigOidcArgs.builder()
        .clientId("string")
        .identityProviderConfigName("string")
        .issuerUrl("string")
        .groupsClaim("string")
        .groupsPrefix("string")
        .requiredClaims(Map.of("string", "string"))
        .usernameClaim("string")
        .usernamePrefix("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    identity_provider_config_resource = aws.eks.IdentityProviderConfig("identityProviderConfigResource",
    cluster_name="string",
    oidc={
        "client_id": "string",
        "identity_provider_config_name": "string",
        "issuer_url": "string",
        "groups_claim": "string",
        "groups_prefix": "string",
        "required_claims": {
            "string": "string",
        },
        "username_claim": "string",
        "username_prefix": "string",
    },
    tags={
        "string": "string",
    })

    const identityProviderConfigResource = new aws.eks.IdentityProviderConfig("identityProviderConfigResource", {
    clusterName: "string",
    oidc: {
        clientId: "string",
        identityProviderConfigName: "string",
        issuerUrl: "string",
        groupsClaim: "string",
        groupsPrefix: "string",
        requiredClaims: {
            string: "string",
        },
        usernameClaim: "string",
        usernamePrefix: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:eks:IdentityProviderConfig
properties:
    clusterName: string
    oidc:
        clientId: string
        groupsClaim: string
        groupsPrefix: string
        identityProviderConfigName: string
        issuerUrl: string
        requiredClaims:
            string: string
        usernameClaim: string
        usernamePrefix: string
    tags:
        string: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IdentityProviderConfig resource accepts the following input properties:

    ClusterName string
    Name of the EKS Cluster.
    Oidc IdentityProviderConfigOidc
    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 IdentityProviderConfigOidc
    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 IdentityProviderConfigOidc
    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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 IdentityProviderConfigOidc
    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.
    clusterName String
    Name of the EKS Cluster.
    oidc IdentityProviderConfigOidc
    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.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the EKS Identity Provider Configuration.
    clusterName string
    Name of the EKS Cluster.
    oidc IdentityProviderConfigOidc
    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    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.

    Deprecated: Please use tags instead.

    Supporting Types

    IdentityProviderConfigOidc, IdentityProviderConfigOidcArgs

    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

    Using pulumi import, import EKS Identity Provider Configurations using the cluster_name and identity_provider_config_name separated by a colon (:). For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws