IdentitySource class

Resource for managing an AWS Verified Permissions Identity Source.

Example Usage

Cognito User Pool Configuration Usage

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

const example = new aws.verifiedpermissions.PolicyStore("example", {validationSettings: {
    mode: "STRICT",
}});
const exampleUserPool = new aws.cognito.UserPool("example", {name: "example"});
const exampleUserPoolClient = new aws.cognito.UserPoolClient("example", {
    name: "example",
    userPoolId: exampleUserPool.id,
    explicitAuthFlows: ["ADMIN_NO_SRP_AUTH"],
});
const exampleIdentitySource = new aws.verifiedpermissions.IdentitySource("example", {
    configuration: {
        cognitoUserPoolConfiguration: {
            userPoolArn: exampleUserPool.arn,
            clientIds: [exampleUserPoolClient.id],
        },
    },
    policyStoreId: example.id,
});
import pulumi
import pulumi_aws as aws

example = aws.verifiedpermissions.PolicyStore("example", validation_settings={
    "mode": "STRICT",
})
example_user_pool = aws.cognito.UserPool("example", name="example")
example_user_pool_client = aws.cognito.UserPoolClient("example",
    name="example",
    user_pool_id=example_user_pool.id,
    explicit_auth_flows=["ADMIN_NO_SRP_AUTH"])
example_identity_source = aws.verifiedpermissions.IdentitySource("example",
    configuration={
        "cognito_user_pool_configuration": {
            "user_pool_arn": example_user_pool.arn,
            "client_ids": [example_user_pool_client.id],
        },
    },
    policy_store_id=example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedPermissions.PolicyStore("example", new()
    {
        ValidationSettings = new Aws.VerifiedPermissions.Inputs.PolicyStoreValidationSettingsArgs
        {
            Mode = "STRICT",
        },
    });

    var exampleUserPool = new Aws.Cognito.UserPool("example", new()
    {
        Name = "example",
    });

    var exampleUserPoolClient = new Aws.Cognito.UserPoolClient("example", new()
    {
        Name = "example",
        UserPoolId = exampleUserPool.Id,
        ExplicitAuthFlows = new[]
        {
            "ADMIN_NO_SRP_AUTH",
        },
    });

    var exampleIdentitySource = new Aws.VerifiedPermissions.IdentitySource("example", new()
    {
        Configuration = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationArgs
        {
            CognitoUserPoolConfiguration = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationCognitoUserPoolConfigurationArgs
            {
                UserPoolArn = exampleUserPool.Arn,
                ClientIds = new[]
                {
                    exampleUserPoolClient.Id,
                },
            },
        },
        PolicyStoreId = example.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/verifiedpermissions"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := verifiedpermissions.NewPolicyStore(ctx, "example", &verifiedpermissions.PolicyStoreArgs{
			ValidationSettings: &verifiedpermissions.PolicyStoreValidationSettingsArgs{
				Mode: pulumi.String("STRICT"),
			},
		})
		if err != nil {
			return err
		}
		exampleUserPool, err := cognito.NewUserPool(ctx, "example", &cognito.UserPoolArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		exampleUserPoolClient, err := cognito.NewUserPoolClient(ctx, "example", &cognito.UserPoolClientArgs{
			Name:       pulumi.String("example"),
			UserPoolId: exampleUserPool.ID().ToIDOutput().ToStringOutput(),
			ExplicitAuthFlows: pulumi.StringArray{
				pulumi.String("ADMIN_NO_SRP_AUTH"),
			},
		})
		if err != nil {
			return err
		}
		_, err = verifiedpermissions.NewIdentitySource(ctx, "example", &verifiedpermissions.IdentitySourceArgs{
			Configuration: &verifiedpermissions.IdentitySourceConfigurationArgs{
				CognitoUserPoolConfiguration: &verifiedpermissions.IdentitySourceConfigurationCognitoUserPoolConfigurationArgs{
					UserPoolArn: exampleUserPool.Arn,
					ClientIds: pulumi.StringArray{
						exampleUserPoolClient.ID().ToIDOutput().ToStringOutput(),
					},
				},
			},
			PolicyStoreId: example.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedpermissions_policystore" "example" {
  validation_settings = {
    mode = "STRICT"
  }
}
resource "aws_cognito_userpool" "example" {
  name = "example"
}
resource "aws_cognito_userpoolclient" "example" {
  name                = "example"
  user_pool_id        = aws_cognito_userpool.example.id
  explicit_auth_flows = ["ADMIN_NO_SRP_AUTH"]
}
resource "aws_verifiedpermissions_identitysource" "example" {
  configuration = {
    cognito_user_pool_configuration = {
      user_pool_arn = aws_cognito_userpool.example.arn
      client_ids    = [aws_cognito_userpoolclient.example.id]
    }
  }
  policy_store_id = aws_verifiedpermissions_policystore.example.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.verifiedpermissions.PolicyStore;
import com.pulumi.aws.verifiedpermissions.PolicyStoreArgs;
import com.pulumi.aws.verifiedpermissions.inputs.PolicyStoreValidationSettingsArgs;
import com.pulumi.aws.cognito.UserPool;
import com.pulumi.aws.cognito.UserPoolArgs;
import com.pulumi.aws.cognito.UserPoolClient;
import com.pulumi.aws.cognito.UserPoolClientArgs;
import com.pulumi.aws.verifiedpermissions.IdentitySource;
import com.pulumi.aws.verifiedpermissions.IdentitySourceArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationCognitoUserPoolConfigurationArgs;
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 PolicyStore("example", PolicyStoreArgs.builder()
            .validationSettings(PolicyStoreValidationSettingsArgs.builder()
                .mode("STRICT")
                .build())
            .build());

        var exampleUserPool = new UserPool("exampleUserPool", UserPoolArgs.builder()
            .name("example")
            .build());

        var exampleUserPoolClient = new UserPoolClient("exampleUserPoolClient", UserPoolClientArgs.builder()
            .name("example")
            .userPoolId(exampleUserPool.id())
            .explicitAuthFlows("ADMIN_NO_SRP_AUTH")
            .build());

        var exampleIdentitySource = new IdentitySource("exampleIdentitySource", IdentitySourceArgs.builder()
            .configuration(IdentitySourceConfigurationArgs.builder()
                .cognitoUserPoolConfiguration(IdentitySourceConfigurationCognitoUserPoolConfigurationArgs.builder()
                    .userPoolArn(exampleUserPool.arn())
                    .clientIds(exampleUserPoolClient.id())
                    .build())
                .build())
            .policyStoreId(example.id())
            .build());

    }
}
resources:
  example:
    type: aws:verifiedpermissions:PolicyStore
    properties:
      validationSettings:
        mode: STRICT
  exampleUserPool:
    type: aws:cognito:UserPool
    name: example
    properties:
      name: example
  exampleUserPoolClient:
    type: aws:cognito:UserPoolClient
    name: example
    properties:
      name: example
      userPoolId: ${exampleUserPool.id}
      explicitAuthFlows:
        - ADMIN_NO_SRP_AUTH
  exampleIdentitySource:
    type: aws:verifiedpermissions:IdentitySource
    name: example
    properties:
      configuration:
        cognitoUserPoolConfiguration:
          userPoolArn: ${exampleUserPool.arn}
          clientIds:
            - ${exampleUserPoolClient.id}
      policyStoreId: ${example.id}

OpenID Connect Configuration Usage

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

const example = new aws.verifiedpermissions.PolicyStore("example", {validationSettings: {
    mode: "STRICT",
}});
const exampleIdentitySource = new aws.verifiedpermissions.IdentitySource("example", {
    configuration: {
        openIdConnectConfiguration: {
            tokenSelection: {
                accessTokenOnly: {
                    audiences: ["https://myapp.example.com"],
                    principalIdClaim: "sub",
                },
            },
            groupConfiguration: {
                groupClaim: "groups",
                groupEntityType: "MyCorp::UserGroup",
            },
            issuer: "https://auth.example.com",
            entityIdPrefix: "MyOIDCProvider",
        },
    },
    policyStoreId: example.id,
    principalEntityType: "MyCorp::User",
});
import pulumi
import pulumi_aws as aws

example = aws.verifiedpermissions.PolicyStore("example", validation_settings={
    "mode": "STRICT",
})
example_identity_source = aws.verifiedpermissions.IdentitySource("example",
    configuration={
        "open_id_connect_configuration": {
            "token_selection": {
                "access_token_only": {
                    "audiences": ["https://myapp.example.com"],
                    "principal_id_claim": "sub",
                },
            },
            "group_configuration": {
                "group_claim": "groups",
                "group_entity_type": "MyCorp::UserGroup",
            },
            "issuer": "https://auth.example.com",
            "entity_id_prefix": "MyOIDCProvider",
        },
    },
    policy_store_id=example.id,
    principal_entity_type="MyCorp::User")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.VerifiedPermissions.PolicyStore("example", new()
    {
        ValidationSettings = new Aws.VerifiedPermissions.Inputs.PolicyStoreValidationSettingsArgs
        {
            Mode = "STRICT",
        },
    });

    var exampleIdentitySource = new Aws.VerifiedPermissions.IdentitySource("example", new()
    {
        Configuration = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationArgs
        {
            OpenIdConnectConfiguration = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationOpenIdConnectConfigurationArgs
            {
                TokenSelection = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionArgs
                {
                    AccessTokenOnly = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionAccessTokenOnlyArgs
                    {
                        Audiences = new[]
                        {
                            "https://myapp.example.com",
                        },
                        PrincipalIdClaim = "sub",
                    },
                },
                GroupConfiguration = new Aws.VerifiedPermissions.Inputs.IdentitySourceConfigurationOpenIdConnectConfigurationGroupConfigurationArgs
                {
                    GroupClaim = "groups",
                    GroupEntityType = "MyCorp::UserGroup",
                },
                Issuer = "https://auth.example.com",
                EntityIdPrefix = "MyOIDCProvider",
            },
        },
        PolicyStoreId = example.Id,
        PrincipalEntityType = "MyCorp::User",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/verifiedpermissions"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := verifiedpermissions.NewPolicyStore(ctx, "example", &verifiedpermissions.PolicyStoreArgs{
			ValidationSettings: &verifiedpermissions.PolicyStoreValidationSettingsArgs{
				Mode: pulumi.String("STRICT"),
			},
		})
		if err != nil {
			return err
		}
		_, err = verifiedpermissions.NewIdentitySource(ctx, "example", &verifiedpermissions.IdentitySourceArgs{
			Configuration: &verifiedpermissions.IdentitySourceConfigurationArgs{
				OpenIdConnectConfiguration: &verifiedpermissions.IdentitySourceConfigurationOpenIdConnectConfigurationArgs{
					TokenSelection: &verifiedpermissions.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionArgs{
						AccessTokenOnly: &verifiedpermissions.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionAccessTokenOnlyArgs{
							Audiences: pulumi.StringArray{
								pulumi.String("https://myapp.example.com"),
							},
							PrincipalIdClaim: pulumi.String("sub"),
						},
					},
					GroupConfiguration: &verifiedpermissions.IdentitySourceConfigurationOpenIdConnectConfigurationGroupConfigurationArgs{
						GroupClaim:      pulumi.String("groups"),
						GroupEntityType: pulumi.String("MyCorp::UserGroup"),
					},
					Issuer:         pulumi.String("https://auth.example.com"),
					EntityIdPrefix: pulumi.String("MyOIDCProvider"),
				},
			},
			PolicyStoreId:       example.ID().ToIDOutput().ToStringOutput(),
			PrincipalEntityType: pulumi.String("MyCorp::User"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_verifiedpermissions_policystore" "example" {
  validation_settings = {
    mode = "STRICT"
  }
}
resource "aws_verifiedpermissions_identitysource" "example" {
  configuration = {
    open_id_connect_configuration = {
      token_selection = {
        access_token_only = {
          audiences          = ["https://myapp.example.com"]
          principal_id_claim = "sub"
        }
      }
      group_configuration = {
        group_claim       = "groups"
        group_entity_type = "MyCorp::UserGroup"
      }
      issuer           = "https://auth.example.com"
      entity_id_prefix = "MyOIDCProvider"
    }
  }
  policy_store_id       = aws_verifiedpermissions_policystore.example.id
  principal_entity_type = "MyCorp::User"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.verifiedpermissions.PolicyStore;
import com.pulumi.aws.verifiedpermissions.PolicyStoreArgs;
import com.pulumi.aws.verifiedpermissions.inputs.PolicyStoreValidationSettingsArgs;
import com.pulumi.aws.verifiedpermissions.IdentitySource;
import com.pulumi.aws.verifiedpermissions.IdentitySourceArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationOpenIdConnectConfigurationArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionAccessTokenOnlyArgs;
import com.pulumi.aws.verifiedpermissions.inputs.IdentitySourceConfigurationOpenIdConnectConfigurationGroupConfigurationArgs;
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 PolicyStore("example", PolicyStoreArgs.builder()
            .validationSettings(PolicyStoreValidationSettingsArgs.builder()
                .mode("STRICT")
                .build())
            .build());

        var exampleIdentitySource = new IdentitySource("exampleIdentitySource", IdentitySourceArgs.builder()
            .configuration(IdentitySourceConfigurationArgs.builder()
                .openIdConnectConfiguration(IdentitySourceConfigurationOpenIdConnectConfigurationArgs.builder()
                    .tokenSelection(IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionArgs.builder()
                        .accessTokenOnly(IdentitySourceConfigurationOpenIdConnectConfigurationTokenSelectionAccessTokenOnlyArgs.builder()
                            .audiences("https://myapp.example.com")
                            .principalIdClaim("sub")
                            .build())
                        .build())
                    .groupConfiguration(IdentitySourceConfigurationOpenIdConnectConfigurationGroupConfigurationArgs.builder()
                        .groupClaim("groups")
                        .groupEntityType("MyCorp::UserGroup")
                        .build())
                    .issuer("https://auth.example.com")
                    .entityIdPrefix("MyOIDCProvider")
                    .build())
                .build())
            .policyStoreId(example.id())
            .principalEntityType("MyCorp::User")
            .build());

    }
}
resources:
  example:
    type: aws:verifiedpermissions:PolicyStore
    properties:
      validationSettings:
        mode: STRICT
  exampleIdentitySource:
    type: aws:verifiedpermissions:IdentitySource
    name: example
    properties:
      configuration:
        openIdConnectConfiguration:
          tokenSelection:
            accessTokenOnly:
              audiences:
                - https://myapp.example.com
              principalIdClaim: sub
          groupConfiguration:
            groupClaim: groups
            groupEntityType: MyCorp::UserGroup
          issuer: https://auth.example.com
          entityIdPrefix: MyOIDCProvider
      policyStoreId: ${example.id}
      principalEntityType: MyCorp::User

Import

Using pulumi import, import Verified Permissions Identity Source using the policy_store_id:identity_source_id. For example:

$ pulumi import aws:verifiedpermissions/identitySource:IdentitySource example policy-store-id-12345678:identity-source-id-12345678

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configuration ↔ Output<IdentitySourceConfiguration>
Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. See Configuration below.
latefinal
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
policyStoreId ↔ Output<String>
Specifies the ID of the policy store in which you want to store this identity source.
latefinal
principalEntityType ↔ Output<String>
Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
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
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, {IdentitySourceState? state, CustomResourceOptions? options}) → IdentitySource
Gets an existing IdentitySource resource's state with the given name and id.