IdentityProviderConfig class

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", {
    oidc: {
        clientId: "your client_id",
        identityProviderConfigName: "example",
        issuerUrl: "your issuer_url",
    },
    clusterName: exampleAwsEksCluster.name,
});
import pulumi
import pulumi_aws as aws

example = aws.eks.IdentityProviderConfig("example",
    oidc={
        "client_id": "your client_id",
        "identity_provider_config_name": "example",
        "issuer_url": "your issuer_url",
    },
    cluster_name=example_aws_eks_cluster["name"])
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()
    {
        Oidc = new Aws.Eks.Inputs.IdentityProviderConfigOidcArgs
        {
            ClientId = "your client_id",
            IdentityProviderConfigName = "example",
            IssuerUrl = "your issuer_url",
        },
        ClusterName = exampleAwsEksCluster.Name,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			Oidc: &eks.IdentityProviderConfigOidcArgs{
				ClientId:                   pulumi.String("your client_id"),
				IdentityProviderConfigName: pulumi.String("example"),
				IssuerUrl:                  pulumi.String("your issuer_url"),
			},
			ClusterName: pulumi.Any(exampleAwsEksCluster.Name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_eks_identityproviderconfig" "example" {
  oidc = {
    client_id                     = "your client_id"
    identity_provider_config_name = "example"
    issuer_url                    = "your issuer_url"
  }
  cluster_name = exampleAwsEksCluster.name
}
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.ArrayList;
import java.util.Arrays;
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()
            .oidc(IdentityProviderConfigOidcArgs.builder()
                .clientId("your client_id")
                .identityProviderConfigName("example")
                .issuerUrl("your issuer_url")
                .build())
            .clusterName(exampleAwsEksCluster.name())
            .build());

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

Import

Identity Schema

Required

  • clusterName (String) Name of the EKS Cluster.
  • identityProviderConfigName (String) Name of the identity provider config.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

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

$ pulumi import aws:eks/identityProviderConfig:IdentityProviderConfig example example-cluster:example-config

Constructors

IdentityProviderConfig(String name, {IdentityProviderConfigArgs? args, CustomResourceOptions? options})
Creates a new IdentityProviderConfig. name The Pulumi resource name. args Arguments used to configure this IdentityProviderConfig. The set of arguments for IdentityProviderConfig. options Resource options controlling this resource's behavior.
IdentityProviderConfig.reference(String urn)
Creates a typed reference to an existing IdentityProviderConfig resource.

Properties

arn ↔ Output<String>
ARN of the EKS Identity Provider Configuration.
latefinal
childResources → Set<Resource>
finalinherited
clusterName ↔ Output<String>
Name of the EKS Cluster.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
identityProviderConfigName ↔ Output<String>
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
oidc ↔ Output<IdentityProviderConfigOidc>
Nested attribute containing OpenID Connect identity provider information for the cluster. Detailed below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>
Status of the EKS Identity Provider Configuration.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {IdentityProviderConfigState? state, CustomResourceOptions? options}) → IdentityProviderConfig
Gets an existing IdentityProviderConfig resource's state with the given name and id.