com.pulumi.aws.cognito.IdentityPoolArgs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.72.0
// *** 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.aws.cognito;

import com.pulumi.aws.cognito.inputs.IdentityPoolCognitoIdentityProviderArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class IdentityPoolArgs extends com.pulumi.resources.ResourceArgs {

    public static final IdentityPoolArgs Empty = new IdentityPoolArgs();

    /**
     * Enables or disables the classic / basic authentication flow. Default is `false`.
     * 
     */
    @Import(name="allowClassicFlow")
    private @Nullable Output allowClassicFlow;

    /**
     * @return Enables or disables the classic / basic authentication flow. Default is `false`.
     * 
     */
    public Optional> allowClassicFlow() {
        return Optional.ofNullable(this.allowClassicFlow);
    }

    /**
     * Whether the identity pool supports unauthenticated logins or not.
     * 
     */
    @Import(name="allowUnauthenticatedIdentities")
    private @Nullable Output allowUnauthenticatedIdentities;

    /**
     * @return Whether the identity pool supports unauthenticated logins or not.
     * 
     */
    public Optional> allowUnauthenticatedIdentities() {
        return Optional.ofNullable(this.allowUnauthenticatedIdentities);
    }

    /**
     * An array of Amazon Cognito Identity user pools and their client IDs.
     * 
     */
    @Import(name="cognitoIdentityProviders")
    private @Nullable Output> cognitoIdentityProviders;

    /**
     * @return An array of Amazon Cognito Identity user pools and their client IDs.
     * 
     */
    public Optional>> cognitoIdentityProviders() {
        return Optional.ofNullable(this.cognitoIdentityProviders);
    }

    /**
     * The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
     * backend and the Cognito service to communicate about the developer provider.
     * 
     */
    @Import(name="developerProviderName")
    private @Nullable Output developerProviderName;

    /**
     * @return The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
     * backend and the Cognito service to communicate about the developer provider.
     * 
     */
    public Optional> developerProviderName() {
        return Optional.ofNullable(this.developerProviderName);
    }

    /**
     * The Cognito Identity Pool name.
     * 
     */
    @Import(name="identityPoolName", required=true)
    private Output identityPoolName;

    /**
     * @return The Cognito Identity Pool name.
     * 
     */
    public Output identityPoolName() {
        return this.identityPoolName;
    }

    /**
     * Set of OpendID Connect provider ARNs.
     * 
     */
    @Import(name="openidConnectProviderArns")
    private @Nullable Output> openidConnectProviderArns;

    /**
     * @return Set of OpendID Connect provider ARNs.
     * 
     */
    public Optional>> openidConnectProviderArns() {
        return Optional.ofNullable(this.openidConnectProviderArns);
    }

    /**
     * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
     * 
     */
    @Import(name="samlProviderArns")
    private @Nullable Output> samlProviderArns;

    /**
     * @return An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
     * 
     */
    public Optional>> samlProviderArns() {
        return Optional.ofNullable(this.samlProviderArns);
    }

    /**
     * Key-Value pairs mapping provider names to provider app IDs.
     * 
     */
    @Import(name="supportedLoginProviders")
    private @Nullable Output> supportedLoginProviders;

    /**
     * @return Key-Value pairs mapping provider names to provider app IDs.
     * 
     */
    public Optional>> supportedLoginProviders() {
        return Optional.ofNullable(this.supportedLoginProviders);
    }

    /**
     * A map of tags to assign to the Identity Pool. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    @Import(name="tags")
    private @Nullable Output> tags;

    /**
     * @return A map of tags to assign to the Identity Pool. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
     * 
     */
    public Optional>> tags() {
        return Optional.ofNullable(this.tags);
    }

    private IdentityPoolArgs() {}

    private IdentityPoolArgs(IdentityPoolArgs $) {
        this.allowClassicFlow = $.allowClassicFlow;
        this.allowUnauthenticatedIdentities = $.allowUnauthenticatedIdentities;
        this.cognitoIdentityProviders = $.cognitoIdentityProviders;
        this.developerProviderName = $.developerProviderName;
        this.identityPoolName = $.identityPoolName;
        this.openidConnectProviderArns = $.openidConnectProviderArns;
        this.samlProviderArns = $.samlProviderArns;
        this.supportedLoginProviders = $.supportedLoginProviders;
        this.tags = $.tags;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(IdentityPoolArgs defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private IdentityPoolArgs $;

        public Builder() {
            $ = new IdentityPoolArgs();
        }

        public Builder(IdentityPoolArgs defaults) {
            $ = new IdentityPoolArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param allowClassicFlow Enables or disables the classic / basic authentication flow. Default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder allowClassicFlow(@Nullable Output allowClassicFlow) {
            $.allowClassicFlow = allowClassicFlow;
            return this;
        }

        /**
         * @param allowClassicFlow Enables or disables the classic / basic authentication flow. Default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder allowClassicFlow(Boolean allowClassicFlow) {
            return allowClassicFlow(Output.of(allowClassicFlow));
        }

        /**
         * @param allowUnauthenticatedIdentities Whether the identity pool supports unauthenticated logins or not.
         * 
         * @return builder
         * 
         */
        public Builder allowUnauthenticatedIdentities(@Nullable Output allowUnauthenticatedIdentities) {
            $.allowUnauthenticatedIdentities = allowUnauthenticatedIdentities;
            return this;
        }

        /**
         * @param allowUnauthenticatedIdentities Whether the identity pool supports unauthenticated logins or not.
         * 
         * @return builder
         * 
         */
        public Builder allowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) {
            return allowUnauthenticatedIdentities(Output.of(allowUnauthenticatedIdentities));
        }

        /**
         * @param cognitoIdentityProviders An array of Amazon Cognito Identity user pools and their client IDs.
         * 
         * @return builder
         * 
         */
        public Builder cognitoIdentityProviders(@Nullable Output> cognitoIdentityProviders) {
            $.cognitoIdentityProviders = cognitoIdentityProviders;
            return this;
        }

        /**
         * @param cognitoIdentityProviders An array of Amazon Cognito Identity user pools and their client IDs.
         * 
         * @return builder
         * 
         */
        public Builder cognitoIdentityProviders(List cognitoIdentityProviders) {
            return cognitoIdentityProviders(Output.of(cognitoIdentityProviders));
        }

        /**
         * @param cognitoIdentityProviders An array of Amazon Cognito Identity user pools and their client IDs.
         * 
         * @return builder
         * 
         */
        public Builder cognitoIdentityProviders(IdentityPoolCognitoIdentityProviderArgs... cognitoIdentityProviders) {
            return cognitoIdentityProviders(List.of(cognitoIdentityProviders));
        }

        /**
         * @param developerProviderName The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
         * backend and the Cognito service to communicate about the developer provider.
         * 
         * @return builder
         * 
         */
        public Builder developerProviderName(@Nullable Output developerProviderName) {
            $.developerProviderName = developerProviderName;
            return this;
        }

        /**
         * @param developerProviderName The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your
         * backend and the Cognito service to communicate about the developer provider.
         * 
         * @return builder
         * 
         */
        public Builder developerProviderName(String developerProviderName) {
            return developerProviderName(Output.of(developerProviderName));
        }

        /**
         * @param identityPoolName The Cognito Identity Pool name.
         * 
         * @return builder
         * 
         */
        public Builder identityPoolName(Output identityPoolName) {
            $.identityPoolName = identityPoolName;
            return this;
        }

        /**
         * @param identityPoolName The Cognito Identity Pool name.
         * 
         * @return builder
         * 
         */
        public Builder identityPoolName(String identityPoolName) {
            return identityPoolName(Output.of(identityPoolName));
        }

        /**
         * @param openidConnectProviderArns Set of OpendID Connect provider ARNs.
         * 
         * @return builder
         * 
         */
        public Builder openidConnectProviderArns(@Nullable Output> openidConnectProviderArns) {
            $.openidConnectProviderArns = openidConnectProviderArns;
            return this;
        }

        /**
         * @param openidConnectProviderArns Set of OpendID Connect provider ARNs.
         * 
         * @return builder
         * 
         */
        public Builder openidConnectProviderArns(List openidConnectProviderArns) {
            return openidConnectProviderArns(Output.of(openidConnectProviderArns));
        }

        /**
         * @param openidConnectProviderArns Set of OpendID Connect provider ARNs.
         * 
         * @return builder
         * 
         */
        public Builder openidConnectProviderArns(String... openidConnectProviderArns) {
            return openidConnectProviderArns(List.of(openidConnectProviderArns));
        }

        /**
         * @param samlProviderArns An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
         * 
         * @return builder
         * 
         */
        public Builder samlProviderArns(@Nullable Output> samlProviderArns) {
            $.samlProviderArns = samlProviderArns;
            return this;
        }

        /**
         * @param samlProviderArns An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
         * 
         * @return builder
         * 
         */
        public Builder samlProviderArns(List samlProviderArns) {
            return samlProviderArns(Output.of(samlProviderArns));
        }

        /**
         * @param samlProviderArns An array of Amazon Resource Names (ARNs) of the SAML provider for your identity.
         * 
         * @return builder
         * 
         */
        public Builder samlProviderArns(String... samlProviderArns) {
            return samlProviderArns(List.of(samlProviderArns));
        }

        /**
         * @param supportedLoginProviders Key-Value pairs mapping provider names to provider app IDs.
         * 
         * @return builder
         * 
         */
        public Builder supportedLoginProviders(@Nullable Output> supportedLoginProviders) {
            $.supportedLoginProviders = supportedLoginProviders;
            return this;
        }

        /**
         * @param supportedLoginProviders Key-Value pairs mapping provider names to provider app IDs.
         * 
         * @return builder
         * 
         */
        public Builder supportedLoginProviders(Map supportedLoginProviders) {
            return supportedLoginProviders(Output.of(supportedLoginProviders));
        }

        /**
         * @param tags A map of tags to assign to the Identity Pool. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(@Nullable Output> tags) {
            $.tags = tags;
            return this;
        }

        /**
         * @param tags A map of tags to assign to the Identity Pool. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
         * 
         * @return builder
         * 
         */
        public Builder tags(Map tags) {
            return tags(Output.of(tags));
        }

        public IdentityPoolArgs build() {
            if ($.identityPoolName == null) {
                throw new MissingRequiredPropertyException("IdentityPoolArgs", "identityPoolName");
            }
            return $;
        }
    }

}