OpenIdConnectProvider class
Provides an IAM OpenID Connect provider.
Example Usage
Basic 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"])
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iam_openidconnectprovider" "default" {
url = "https://accounts.google.com"
client_id_lists = ["266362248691-342342xasdasdasda-apps.googleusercontent.com"]
thumbprint_lists = ["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.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 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
Without A Thumbprint
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"],
});
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"])
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",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iam_openidconnectprovider" "default" {
url = "https://accounts.google.com"
client_id_lists = ["266362248691-342342xasdasdasda-apps.googleusercontent.com"]
}
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.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 default_ = new OpenIdConnectProvider("default", OpenIdConnectProviderArgs.builder()
.url("https://accounts.google.com")
.clientIdLists("266362248691-342342xasdasdasda-apps.googleusercontent.com")
.build());
}
}
resources:
default:
type: aws:iam:OpenIdConnectProvider
properties:
url: https://accounts.google.com
clientIdLists:
- 266362248691-342342xasdasdasda-apps.googleusercontent.com
Import
Identity Schema
Required
arn(String) ARN of the IAM OpenID Connect provider.
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
Constructors
- OpenIdConnectProvider(String name, {OpenIdConnectProviderArgs? args, CustomResourceOptions? options})
-
Creates a new OpenIdConnectProvider.
nameThe Pulumi resource name.argsArguments used to configure this OpenIdConnectProvider. The set of arguments for OpenIdConnectProvider.optionsResource options controlling this resource's behavior. - OpenIdConnectProvider.reference(String urn)
- Creates a typed reference to an existing OpenIdConnectProvider resource.
Properties
-
arn
↔ Output<
String> -
ARN assigned by AWS for this provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
clientIdLists
↔ Output<
List< String> > -
List of client IDs (audiences) that identify the application registered with the OpenID Connect provider. This is the value sent as the
clientIdparameter in OAuth requests.latefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of resource tags for the IAM OIDC provider. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
thumbprintLists
↔ Output<
List< String> > -
List of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). For certain OIDC identity providers (e.g., Auth0, GitHub, GitLab, Google, or those using an Amazon S3-hosted JWKS endpoint), AWS relies on its own library of trusted root certificate authorities (CAs) for validation instead of using any configured thumbprints. In these cases, any configured
thumbprintListis retained in the configuration but not used for verification. For other IdPs, if nothumbprintListis provided, IAM automatically retrieves and uses the top intermediate CA thumbprint from the OIDC IdP server certificate. However, if athumbprintListis initially configured and later removed, Terraform does not prompt IAM to retrieve a thumbprint the same way. Instead, it continues using the original thumbprint list from the initial configuration. This differs from the behavior when creating anaws.iam.OpenIdConnectProviderwithout athumbprintList.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
url
↔ Output<
String> -
URL of the identity provider, corresponding to the
issclaim.latefinal -
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, {OpenIdConnectProviderState? state, CustomResourceOptions? options}) → OpenIdConnectProvider -
Gets an existing OpenIdConnectProvider resource's state with the given
nameandid.