1. Packages
  2. AWS Classic
  3. API Docs
  4. iam
  5. OpenIdConnectProvider

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.iam.OpenIdConnectProvider

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides an IAM OpenID Connect provider.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const _default = new aws.iam.OpenIdConnectProvider("default", {
        url: "https://accounts.google.com",
        clientIdLists: ["266362248691-342342xasdasdasda-apps.googleusercontent.com"],
        thumbprintLists: ["cf23df2207d99a74fbe169e3eba035e633b65d94"],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    default = aws.iam.OpenIdConnectProvider("default",
        url="https://accounts.google.com",
        client_id_lists=["266362248691-342342xasdasdasda-apps.googleusercontent.com"],
        thumbprint_lists=["cf23df2207d99a74fbe169e3eba035e633b65d94"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iam.NewOpenIdConnectProvider(ctx, "default", &iam.OpenIdConnectProviderArgs{
    			Url: pulumi.String("https://accounts.google.com"),
    			ClientIdLists: pulumi.StringArray{
    				pulumi.String("266362248691-342342xasdasdasda-apps.googleusercontent.com"),
    			},
    			ThumbprintLists: pulumi.StringArray{
    				pulumi.String("cf23df2207d99a74fbe169e3eba035e633b65d94"),
    			},
    		})
    		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 @default = new Aws.Iam.OpenIdConnectProvider("default", new()
        {
            Url = "https://accounts.google.com",
            ClientIdLists = new[]
            {
                "266362248691-342342xasdasdasda-apps.googleusercontent.com",
            },
            ThumbprintLists = new[]
            {
                "cf23df2207d99a74fbe169e3eba035e633b65d94",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.OpenIdConnectProvider;
    import com.pulumi.aws.iam.OpenIdConnectProviderArgs;
    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 default_ = new OpenIdConnectProvider("default", OpenIdConnectProviderArgs.builder()
                .url("https://accounts.google.com")
                .clientIdLists("266362248691-342342xasdasdasda-apps.googleusercontent.com")
                .thumbprintLists("cf23df2207d99a74fbe169e3eba035e633b65d94")
                .build());
    
        }
    }
    
    resources:
      default:
        type: aws:iam:OpenIdConnectProvider
        properties:
          url: https://accounts.google.com
          clientIdLists:
            - 266362248691-342342xasdasdasda-apps.googleusercontent.com
          thumbprintLists:
            - cf23df2207d99a74fbe169e3eba035e633b65d94
    

    Create OpenIdConnectProvider Resource

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

    Constructor syntax

    new OpenIdConnectProvider(name: string, args: OpenIdConnectProviderArgs, opts?: CustomResourceOptions);
    @overload
    def OpenIdConnectProvider(resource_name: str,
                              args: OpenIdConnectProviderArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def OpenIdConnectProvider(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              client_id_lists: Optional[Sequence[str]] = None,
                              thumbprint_lists: Optional[Sequence[str]] = None,
                              url: Optional[str] = None,
                              tags: Optional[Mapping[str, str]] = None)
    func NewOpenIdConnectProvider(ctx *Context, name string, args OpenIdConnectProviderArgs, opts ...ResourceOption) (*OpenIdConnectProvider, error)
    public OpenIdConnectProvider(string name, OpenIdConnectProviderArgs args, CustomResourceOptions? opts = null)
    public OpenIdConnectProvider(String name, OpenIdConnectProviderArgs args)
    public OpenIdConnectProvider(String name, OpenIdConnectProviderArgs args, CustomResourceOptions options)
    
    type: aws:iam:OpenIdConnectProvider
    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 OpenIdConnectProviderArgs
    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 OpenIdConnectProviderArgs
    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 OpenIdConnectProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpenIdConnectProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpenIdConnectProviderArgs
    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 openIdConnectProviderResource = new Aws.Iam.OpenIdConnectProvider("openIdConnectProviderResource", new()
    {
        ClientIdLists = new[]
        {
            "string",
        },
        ThumbprintLists = new[]
        {
            "string",
        },
        Url = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := iam.NewOpenIdConnectProvider(ctx, "openIdConnectProviderResource", &iam.OpenIdConnectProviderArgs{
    	ClientIdLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ThumbprintLists: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Url: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var openIdConnectProviderResource = new OpenIdConnectProvider("openIdConnectProviderResource", OpenIdConnectProviderArgs.builder()
        .clientIdLists("string")
        .thumbprintLists("string")
        .url("string")
        .tags(Map.of("string", "string"))
        .build());
    
    open_id_connect_provider_resource = aws.iam.OpenIdConnectProvider("openIdConnectProviderResource",
        client_id_lists=["string"],
        thumbprint_lists=["string"],
        url="string",
        tags={
            "string": "string",
        })
    
    const openIdConnectProviderResource = new aws.iam.OpenIdConnectProvider("openIdConnectProviderResource", {
        clientIdLists: ["string"],
        thumbprintLists: ["string"],
        url: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:iam:OpenIdConnectProvider
    properties:
        clientIdLists:
            - string
        tags:
            string: string
        thumbprintLists:
            - string
        url: string
    

    OpenIdConnectProvider 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 OpenIdConnectProvider resource accepts the following input properties:

    ClientIdLists List<string>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    ThumbprintLists List<string>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    Url string
    The URL of the identity provider. Corresponds to the iss claim.
    Tags Dictionary<string, string>
    Map of resource tags for the IAM OIDC provider. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ClientIdLists []string
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    ThumbprintLists []string
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    Url string
    The URL of the identity provider. Corresponds to the iss claim.
    Tags map[string]string
    Map of resource tags for the IAM OIDC provider. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientIdLists List<String>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    thumbprintLists List<String>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url String
    The URL of the identity provider. Corresponds to the iss claim.
    tags Map<String,String>
    Map of resource tags for the IAM OIDC provider. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientIdLists string[]
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    thumbprintLists string[]
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url string
    The URL of the identity provider. Corresponds to the iss claim.
    tags {[key: string]: string}
    Map of resource tags for the IAM OIDC provider. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    client_id_lists Sequence[str]
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    thumbprint_lists Sequence[str]
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url str
    The URL of the identity provider. Corresponds to the iss claim.
    tags Mapping[str, str]
    Map of resource tags for the IAM OIDC provider. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientIdLists List<String>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    thumbprintLists List<String>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url String
    The URL of the identity provider. Corresponds to the iss claim.
    tags Map<String>
    Map of resource tags for the IAM OIDC provider. 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 OpenIdConnectProvider resource produces the following output properties:

    Arn string
    The ARN assigned by AWS for this provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    The ARN assigned by AWS for this provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    The ARN assigned by AWS for this provider.
    id String
    The provider-assigned unique ID for this managed resource.
    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
    The ARN assigned by AWS for this provider.
    id string
    The provider-assigned unique ID for this managed resource.
    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
    The ARN assigned by AWS for this provider.
    id str
    The provider-assigned unique ID for this managed resource.
    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
    The ARN assigned by AWS for this provider.
    id String
    The provider-assigned unique ID for this managed resource.
    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 OpenIdConnectProvider Resource

    Get an existing OpenIdConnectProvider 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?: OpenIdConnectProviderState, opts?: CustomResourceOptions): OpenIdConnectProvider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            client_id_lists: Optional[Sequence[str]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            thumbprint_lists: Optional[Sequence[str]] = None,
            url: Optional[str] = None) -> OpenIdConnectProvider
    func GetOpenIdConnectProvider(ctx *Context, name string, id IDInput, state *OpenIdConnectProviderState, opts ...ResourceOption) (*OpenIdConnectProvider, error)
    public static OpenIdConnectProvider Get(string name, Input<string> id, OpenIdConnectProviderState? state, CustomResourceOptions? opts = null)
    public static OpenIdConnectProvider get(String name, Output<String> id, OpenIdConnectProviderState 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
    The ARN assigned by AWS for this provider.
    ClientIdLists List<string>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    Tags Dictionary<string, string>
    Map of resource tags for the IAM OIDC provider. 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.

    ThumbprintLists List<string>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    Url string
    The URL of the identity provider. Corresponds to the iss claim.
    Arn string
    The ARN assigned by AWS for this provider.
    ClientIdLists []string
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    Tags map[string]string
    Map of resource tags for the IAM OIDC provider. 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.

    ThumbprintLists []string
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    Url string
    The URL of the identity provider. Corresponds to the iss claim.
    arn String
    The ARN assigned by AWS for this provider.
    clientIdLists List<String>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    tags Map<String,String>
    Map of resource tags for the IAM OIDC provider. 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.

    thumbprintLists List<String>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url String
    The URL of the identity provider. Corresponds to the iss claim.
    arn string
    The ARN assigned by AWS for this provider.
    clientIdLists string[]
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    tags {[key: string]: string}
    Map of resource tags for the IAM OIDC provider. 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.

    thumbprintLists string[]
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url string
    The URL of the identity provider. Corresponds to the iss claim.
    arn str
    The ARN assigned by AWS for this provider.
    client_id_lists Sequence[str]
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    tags Mapping[str, str]
    Map of resource tags for the IAM OIDC provider. 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.

    thumbprint_lists Sequence[str]
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url str
    The URL of the identity provider. Corresponds to the iss claim.
    arn String
    The ARN assigned by AWS for this provider.
    clientIdLists List<String>
    A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)
    tags Map<String>
    Map of resource tags for the IAM OIDC provider. 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.

    thumbprintLists List<String>
    A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s).
    url String
    The URL of the identity provider. Corresponds to the iss claim.

    Import

    Using pulumi import, import IAM OpenID Connect Providers using the arn. For example:

    $ pulumi import aws:iam/openIdConnectProvider:OpenIdConnectProvider default arn:aws:iam::123456789012:oidc-provider/accounts.google.com
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi