OpenIdConnectProvider

Provides an IAM OpenID Connect provider.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Iam.OpenIdConnectProvider("default", new Aws.Iam.OpenIdConnectProviderArgs
        {
            ClientIdLists = 
            {
                "266362248691-342342xasdasdasda-apps.googleusercontent.com",
            },
            ThumbprintLists = {},
            Url = "https://accounts.google.com",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/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{
			ClientIdLists: pulumi.StringArray{
				pulumi.String("266362248691-342342xasdasdasda-apps.googleusercontent.com"),
			},
			ThumbprintLists: []interface{}{},
			Url:             pulumi.String("https://accounts.google.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

default = aws.iam.OpenIdConnectProvider("default",
    client_id_lists=["266362248691-342342xasdasdasda-apps.googleusercontent.com"],
    thumbprint_lists=[],
    url="https://accounts.google.com")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const defaultOpenIdConnectProvider = new aws.iam.OpenIdConnectProvider("default", {
    clientIdLists: ["266362248691-342342xasdasdasda-apps.googleusercontent.com"],
    thumbprintLists: [],
    url: "https://accounts.google.com",
});

Create a OpenIdConnectProvider Resource

new OpenIdConnectProvider(name: string, args: OpenIdConnectProviderArgs, opts?: CustomResourceOptions);
@overload
def OpenIdConnectProvider(resource_name: str,
                          opts: Optional[ResourceOptions] = 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)
@overload
def OpenIdConnectProvider(resource_name: str,
                          args: OpenIdConnectProviderArgs,
                          opts: Optional[ResourceOptions] = None)
func NewOpenIdConnectProvider(ctx *Context, name string, args OpenIdConnectProviderArgs, opts ...ResourceOption) (*OpenIdConnectProvider, error)
public OpenIdConnectProvider(string name, OpenIdConnectProviderArgs args, CustomResourceOptions? opts = null)
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.

OpenIdConnectProvider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the 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.)
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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the 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.)
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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the 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.)
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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

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

Look up an 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)
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.

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

Import

IAM OpenID Connect Providers can be imported using the arn, e.g.

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.