com.pulumi.keycloak.CustomIdentityProviderMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keycloak Show documentation
A Pulumi package for creating and managing keycloak cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.keycloak;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import com.pulumi.keycloak.CustomIdentityProviderMappingArgs;
import com.pulumi.keycloak.Utilities;
import com.pulumi.keycloak.inputs.CustomIdentityProviderMappingState;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;

/**
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.keycloak.Realm;
 * import com.pulumi.keycloak.RealmArgs;
 * import com.pulumi.keycloak.oidc.IdentityProvider;
 * import com.pulumi.keycloak.oidc.IdentityProviderArgs;
 * import com.pulumi.keycloak.CustomIdentityProviderMapping;
 * import com.pulumi.keycloak.CustomIdentityProviderMappingArgs;
 * 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 realm = new Realm("realm", RealmArgs.builder()
 *             .realm("my-realm")
 *             .enabled(true)
 *             .build());
 * 
 *         var oidc = new IdentityProvider("oidc", IdentityProviderArgs.builder()
 *             .realm(realm.id())
 *             .alias("oidc")
 *             .authorizationUrl("https://example.com/auth")
 *             .tokenUrl("https://example.com/token")
 *             .clientId("example_id")
 *             .clientSecret("example_token")
 *             .defaultScopes("openid random profile")
 *             .build());
 * 
 *         var oidcCustomIdentityProviderMapping = new CustomIdentityProviderMapping("oidcCustomIdentityProviderMapping", CustomIdentityProviderMappingArgs.builder()
 *             .realm(realm.id())
 *             .name("email-attribute-importer")
 *             .identityProviderAlias(oidc.alias())
 *             .identityProviderMapper("%s-user-attribute-idp-mapper")
 *             .extraConfig(Map.ofEntries(
 *                 Map.entry("syncMode", "INHERIT"),
 *                 Map.entry("Claim", "my-email-claim"),
 *                 Map.entry("UserAttribute", "email")
 *             ))
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Identity provider mappers can be imported using the format `{{realm_id}}/{{idp_alias}}/{{idp_mapper_id}}`, where `idp_alias` is the identity provider alias, and `idp_mapper_id` is the unique ID that Keycloak
 * 
 * assigns to the mapper upon creation. This value can be found in the URI when editing this mapper in the GUI, and is typically a GUID.
 * 
 * Example:
 * 
 * bash
 * 
 * ```sh
 * $ pulumi import keycloak:index/customIdentityProviderMapping:CustomIdentityProviderMapping test_mapper my-realm/my-mapper/f446db98-7133-4e30-b18a-3d28fde7ca1b
 * ```
 * 
 */
@ResourceType(type="keycloak:index/customIdentityProviderMapping:CustomIdentityProviderMapping")
public class CustomIdentityProviderMapping extends com.pulumi.resources.CustomResource {
    /**
     * Key/value attributes to add to the identity provider mapper model that is persisted to Keycloak. This can be used to extend the base model with new Keycloak features.
     * 
     */
    @Export(name="extraConfig", refs={Map.class,String.class}, tree="[0,1,1]")
    private Output> extraConfig;

    /**
     * @return Key/value attributes to add to the identity provider mapper model that is persisted to Keycloak. This can be used to extend the base model with new Keycloak features.
     * 
     */
    public Output>> extraConfig() {
        return Codegen.optional(this.extraConfig);
    }
    /**
     * The alias of the associated identity provider.
     * 
     */
    @Export(name="identityProviderAlias", refs={String.class}, tree="[0]")
    private Output identityProviderAlias;

    /**
     * @return The alias of the associated identity provider.
     * 
     */
    public Output identityProviderAlias() {
        return this.identityProviderAlias;
    }
    /**
     * The type of the identity provider mapper. This can be a format string that includes a `%s` - this will be replaced by the provider id.
     * 
     */
    @Export(name="identityProviderMapper", refs={String.class}, tree="[0]")
    private Output identityProviderMapper;

    /**
     * @return The type of the identity provider mapper. This can be a format string that includes a `%s` - this will be replaced by the provider id.
     * 
     */
    public Output identityProviderMapper() {
        return this.identityProviderMapper;
    }
    /**
     * The name of the mapper.
     * 
     */
    @Export(name="name", refs={String.class}, tree="[0]")
    private Output name;

    /**
     * @return The name of the mapper.
     * 
     */
    public Output name() {
        return this.name;
    }
    /**
     * The name of the realm.
     * 
     */
    @Export(name="realm", refs={String.class}, tree="[0]")
    private Output realm;

    /**
     * @return The name of the realm.
     * 
     */
    public Output realm() {
        return this.realm;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public CustomIdentityProviderMapping(java.lang.String name) {
        this(name, CustomIdentityProviderMappingArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public CustomIdentityProviderMapping(java.lang.String name, CustomIdentityProviderMappingArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public CustomIdentityProviderMapping(java.lang.String name, CustomIdentityProviderMappingArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("keycloak:index/customIdentityProviderMapping:CustomIdentityProviderMapping", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private CustomIdentityProviderMapping(java.lang.String name, Output id, @Nullable CustomIdentityProviderMappingState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("keycloak:index/customIdentityProviderMapping:CustomIdentityProviderMapping", name, state, makeResourceOptions(options, id), false);
    }

    private static CustomIdentityProviderMappingArgs makeArgs(CustomIdentityProviderMappingArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? CustomIdentityProviderMappingArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static CustomIdentityProviderMapping get(java.lang.String name, Output id, @Nullable CustomIdentityProviderMappingState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new CustomIdentityProviderMapping(name, id, state, options);
    }
}