All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Cognito Identity module holds the client classes that are used for communicating with Amazon Cognito Identity Service

The newest version!
/*
 * Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.cognitoidentity.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 

* Input to the CreateIdentityPool action. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateIdentityPoolRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A string that you provide. *

*/ private String identityPoolName; /** *

* TRUE if the identity pool supports unauthenticated logins. *

*/ private Boolean allowUnauthenticatedIdentities; /** *

* Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. *

*/ private Boolean allowClassicFlow; /** *

* Optional key:value pairs mapping provider names to provider app IDs. *

*/ private java.util.Map supportedLoginProviders; /** *

* 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. For the DeveloperProviderName, * you can use letters as well as period (.), underscore (_), and dash (-). *

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. *

*/ private String developerProviderName; /** *

* The Amazon Resource Names (ARN) of the OpenID Connect providers. *

*/ private java.util.List openIdConnectProviderARNs; /** *

* An array of Amazon Cognito user pools and their client IDs. *

*/ private java.util.List cognitoIdentityProviders; /** *

* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. *

*/ private java.util.List samlProviderARNs; /** *

* Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and * manage them in different ways, such as by purpose, owner, environment, or other criteria. *

*/ private java.util.Map identityPoolTags; /** *

* A string that you provide. *

* * @param identityPoolName * A string that you provide. */ public void setIdentityPoolName(String identityPoolName) { this.identityPoolName = identityPoolName; } /** *

* A string that you provide. *

* * @return A string that you provide. */ public String getIdentityPoolName() { return this.identityPoolName; } /** *

* A string that you provide. *

* * @param identityPoolName * A string that you provide. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withIdentityPoolName(String identityPoolName) { setIdentityPoolName(identityPoolName); return this; } /** *

* TRUE if the identity pool supports unauthenticated logins. *

* * @param allowUnauthenticatedIdentities * TRUE if the identity pool supports unauthenticated logins. */ public void setAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) { this.allowUnauthenticatedIdentities = allowUnauthenticatedIdentities; } /** *

* TRUE if the identity pool supports unauthenticated logins. *

* * @return TRUE if the identity pool supports unauthenticated logins. */ public Boolean getAllowUnauthenticatedIdentities() { return this.allowUnauthenticatedIdentities; } /** *

* TRUE if the identity pool supports unauthenticated logins. *

* * @param allowUnauthenticatedIdentities * TRUE if the identity pool supports unauthenticated logins. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withAllowUnauthenticatedIdentities(Boolean allowUnauthenticatedIdentities) { setAllowUnauthenticatedIdentities(allowUnauthenticatedIdentities); return this; } /** *

* TRUE if the identity pool supports unauthenticated logins. *

* * @return TRUE if the identity pool supports unauthenticated logins. */ public Boolean isAllowUnauthenticatedIdentities() { return this.allowUnauthenticatedIdentities; } /** *

* Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. *

* * @param allowClassicFlow * Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. */ public void setAllowClassicFlow(Boolean allowClassicFlow) { this.allowClassicFlow = allowClassicFlow; } /** *

* Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. *

* * @return Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. */ public Boolean getAllowClassicFlow() { return this.allowClassicFlow; } /** *

* Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. *

* * @param allowClassicFlow * Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withAllowClassicFlow(Boolean allowClassicFlow) { setAllowClassicFlow(allowClassicFlow); return this; } /** *

* Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. *

* * @return Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools * (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide. */ public Boolean isAllowClassicFlow() { return this.allowClassicFlow; } /** *

* Optional key:value pairs mapping provider names to provider app IDs. *

* * @return Optional key:value pairs mapping provider names to provider app IDs. */ public java.util.Map getSupportedLoginProviders() { return supportedLoginProviders; } /** *

* Optional key:value pairs mapping provider names to provider app IDs. *

* * @param supportedLoginProviders * Optional key:value pairs mapping provider names to provider app IDs. */ public void setSupportedLoginProviders(java.util.Map supportedLoginProviders) { this.supportedLoginProviders = supportedLoginProviders; } /** *

* Optional key:value pairs mapping provider names to provider app IDs. *

* * @param supportedLoginProviders * Optional key:value pairs mapping provider names to provider app IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withSupportedLoginProviders(java.util.Map supportedLoginProviders) { setSupportedLoginProviders(supportedLoginProviders); return this; } /** * Add a single SupportedLoginProviders entry * * @see CreateIdentityPoolRequest#withSupportedLoginProviders * @returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest addSupportedLoginProvidersEntry(String key, String value) { if (null == this.supportedLoginProviders) { this.supportedLoginProviders = new java.util.HashMap(); } if (this.supportedLoginProviders.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.supportedLoginProviders.put(key, value); return this; } /** * Removes all the entries added into SupportedLoginProviders. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest clearSupportedLoginProvidersEntries() { this.supportedLoginProviders = null; return this; } /** *

* 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. For the DeveloperProviderName, * you can use letters as well as period (.), underscore (_), and dash (-). *

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. *

* * @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. For the * DeveloperProviderName, you can use letters as well as period (.), underscore ( * _), and dash (-).

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this * parameter. */ public void setDeveloperProviderName(String developerProviderName) { this.developerProviderName = 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. For the DeveloperProviderName, * you can use letters as well as period (.), underscore (_), and dash (-). *

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. *

* * @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. For the * DeveloperProviderName, you can use letters as well as period (.), underscore ( * _), and dash (-).

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this * parameter. */ public String getDeveloperProviderName() { return this.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. For the DeveloperProviderName, * you can use letters as well as period (.), underscore (_), and dash (-). *

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter. *

* * @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. For the * DeveloperProviderName, you can use letters as well as period (.), underscore ( * _), and dash (-).

*

* Once you have set a developer provider name, you cannot change it. Please take care in setting this * parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withDeveloperProviderName(String developerProviderName) { setDeveloperProviderName(developerProviderName); return this; } /** *

* The Amazon Resource Names (ARN) of the OpenID Connect providers. *

* * @return The Amazon Resource Names (ARN) of the OpenID Connect providers. */ public java.util.List getOpenIdConnectProviderARNs() { return openIdConnectProviderARNs; } /** *

* The Amazon Resource Names (ARN) of the OpenID Connect providers. *

* * @param openIdConnectProviderARNs * The Amazon Resource Names (ARN) of the OpenID Connect providers. */ public void setOpenIdConnectProviderARNs(java.util.Collection openIdConnectProviderARNs) { if (openIdConnectProviderARNs == null) { this.openIdConnectProviderARNs = null; return; } this.openIdConnectProviderARNs = new java.util.ArrayList(openIdConnectProviderARNs); } /** *

* The Amazon Resource Names (ARN) of the OpenID Connect providers. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setOpenIdConnectProviderARNs(java.util.Collection)} or * {@link #withOpenIdConnectProviderARNs(java.util.Collection)} if you want to override the existing values. *

* * @param openIdConnectProviderARNs * The Amazon Resource Names (ARN) of the OpenID Connect providers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(String... openIdConnectProviderARNs) { if (this.openIdConnectProviderARNs == null) { setOpenIdConnectProviderARNs(new java.util.ArrayList(openIdConnectProviderARNs.length)); } for (String ele : openIdConnectProviderARNs) { this.openIdConnectProviderARNs.add(ele); } return this; } /** *

* The Amazon Resource Names (ARN) of the OpenID Connect providers. *

* * @param openIdConnectProviderARNs * The Amazon Resource Names (ARN) of the OpenID Connect providers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withOpenIdConnectProviderARNs(java.util.Collection openIdConnectProviderARNs) { setOpenIdConnectProviderARNs(openIdConnectProviderARNs); return this; } /** *

* An array of Amazon Cognito user pools and their client IDs. *

* * @return An array of Amazon Cognito user pools and their client IDs. */ public java.util.List getCognitoIdentityProviders() { return cognitoIdentityProviders; } /** *

* An array of Amazon Cognito user pools and their client IDs. *

* * @param cognitoIdentityProviders * An array of Amazon Cognito user pools and their client IDs. */ public void setCognitoIdentityProviders(java.util.Collection cognitoIdentityProviders) { if (cognitoIdentityProviders == null) { this.cognitoIdentityProviders = null; return; } this.cognitoIdentityProviders = new java.util.ArrayList(cognitoIdentityProviders); } /** *

* An array of Amazon Cognito user pools and their client IDs. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setCognitoIdentityProviders(java.util.Collection)} or * {@link #withCognitoIdentityProviders(java.util.Collection)} if you want to override the existing values. *

* * @param cognitoIdentityProviders * An array of Amazon Cognito user pools and their client IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withCognitoIdentityProviders(CognitoIdentityProvider... cognitoIdentityProviders) { if (this.cognitoIdentityProviders == null) { setCognitoIdentityProviders(new java.util.ArrayList(cognitoIdentityProviders.length)); } for (CognitoIdentityProvider ele : cognitoIdentityProviders) { this.cognitoIdentityProviders.add(ele); } return this; } /** *

* An array of Amazon Cognito user pools and their client IDs. *

* * @param cognitoIdentityProviders * An array of Amazon Cognito user pools and their client IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withCognitoIdentityProviders(java.util.Collection cognitoIdentityProviders) { setCognitoIdentityProviders(cognitoIdentityProviders); return this; } /** *

* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. *

* * @return An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. */ public java.util.List getSamlProviderARNs() { return samlProviderARNs; } /** *

* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. *

* * @param samlProviderARNs * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. */ public void setSamlProviderARNs(java.util.Collection samlProviderARNs) { if (samlProviderARNs == null) { this.samlProviderARNs = null; return; } this.samlProviderARNs = new java.util.ArrayList(samlProviderARNs); } /** *

* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setSamlProviderARNs(java.util.Collection)} or {@link #withSamlProviderARNs(java.util.Collection)} if you * want to override the existing values. *

* * @param samlProviderARNs * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withSamlProviderARNs(String... samlProviderARNs) { if (this.samlProviderARNs == null) { setSamlProviderARNs(new java.util.ArrayList(samlProviderARNs.length)); } for (String ele : samlProviderARNs) { this.samlProviderARNs.add(ele); } return this; } /** *

* An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. *

* * @param samlProviderARNs * An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withSamlProviderARNs(java.util.Collection samlProviderARNs) { setSamlProviderARNs(samlProviderARNs); return this; } /** *

* Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and * manage them in different ways, such as by purpose, owner, environment, or other criteria. *

* * @return Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize * and manage them in different ways, such as by purpose, owner, environment, or other criteria. */ public java.util.Map getIdentityPoolTags() { return identityPoolTags; } /** *

* Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and * manage them in different ways, such as by purpose, owner, environment, or other criteria. *

* * @param identityPoolTags * Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize * and manage them in different ways, such as by purpose, owner, environment, or other criteria. */ public void setIdentityPoolTags(java.util.Map identityPoolTags) { this.identityPoolTags = identityPoolTags; } /** *

* Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and * manage them in different ways, such as by purpose, owner, environment, or other criteria. *

* * @param identityPoolTags * Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize * and manage them in different ways, such as by purpose, owner, environment, or other criteria. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest withIdentityPoolTags(java.util.Map identityPoolTags) { setIdentityPoolTags(identityPoolTags); return this; } /** * Add a single IdentityPoolTags entry * * @see CreateIdentityPoolRequest#withIdentityPoolTags * @returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest addIdentityPoolTagsEntry(String key, String value) { if (null == this.identityPoolTags) { this.identityPoolTags = new java.util.HashMap(); } if (this.identityPoolTags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.identityPoolTags.put(key, value); return this; } /** * Removes all the entries added into IdentityPoolTags. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateIdentityPoolRequest clearIdentityPoolTagsEntries() { this.identityPoolTags = null; return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getIdentityPoolName() != null) sb.append("IdentityPoolName: ").append(getIdentityPoolName()).append(","); if (getAllowUnauthenticatedIdentities() != null) sb.append("AllowUnauthenticatedIdentities: ").append(getAllowUnauthenticatedIdentities()).append(","); if (getAllowClassicFlow() != null) sb.append("AllowClassicFlow: ").append(getAllowClassicFlow()).append(","); if (getSupportedLoginProviders() != null) sb.append("SupportedLoginProviders: ").append(getSupportedLoginProviders()).append(","); if (getDeveloperProviderName() != null) sb.append("DeveloperProviderName: ").append(getDeveloperProviderName()).append(","); if (getOpenIdConnectProviderARNs() != null) sb.append("OpenIdConnectProviderARNs: ").append(getOpenIdConnectProviderARNs()).append(","); if (getCognitoIdentityProviders() != null) sb.append("CognitoIdentityProviders: ").append(getCognitoIdentityProviders()).append(","); if (getSamlProviderARNs() != null) sb.append("SamlProviderARNs: ").append(getSamlProviderARNs()).append(","); if (getIdentityPoolTags() != null) sb.append("IdentityPoolTags: ").append(getIdentityPoolTags()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateIdentityPoolRequest == false) return false; CreateIdentityPoolRequest other = (CreateIdentityPoolRequest) obj; if (other.getIdentityPoolName() == null ^ this.getIdentityPoolName() == null) return false; if (other.getIdentityPoolName() != null && other.getIdentityPoolName().equals(this.getIdentityPoolName()) == false) return false; if (other.getAllowUnauthenticatedIdentities() == null ^ this.getAllowUnauthenticatedIdentities() == null) return false; if (other.getAllowUnauthenticatedIdentities() != null && other.getAllowUnauthenticatedIdentities().equals(this.getAllowUnauthenticatedIdentities()) == false) return false; if (other.getAllowClassicFlow() == null ^ this.getAllowClassicFlow() == null) return false; if (other.getAllowClassicFlow() != null && other.getAllowClassicFlow().equals(this.getAllowClassicFlow()) == false) return false; if (other.getSupportedLoginProviders() == null ^ this.getSupportedLoginProviders() == null) return false; if (other.getSupportedLoginProviders() != null && other.getSupportedLoginProviders().equals(this.getSupportedLoginProviders()) == false) return false; if (other.getDeveloperProviderName() == null ^ this.getDeveloperProviderName() == null) return false; if (other.getDeveloperProviderName() != null && other.getDeveloperProviderName().equals(this.getDeveloperProviderName()) == false) return false; if (other.getOpenIdConnectProviderARNs() == null ^ this.getOpenIdConnectProviderARNs() == null) return false; if (other.getOpenIdConnectProviderARNs() != null && other.getOpenIdConnectProviderARNs().equals(this.getOpenIdConnectProviderARNs()) == false) return false; if (other.getCognitoIdentityProviders() == null ^ this.getCognitoIdentityProviders() == null) return false; if (other.getCognitoIdentityProviders() != null && other.getCognitoIdentityProviders().equals(this.getCognitoIdentityProviders()) == false) return false; if (other.getSamlProviderARNs() == null ^ this.getSamlProviderARNs() == null) return false; if (other.getSamlProviderARNs() != null && other.getSamlProviderARNs().equals(this.getSamlProviderARNs()) == false) return false; if (other.getIdentityPoolTags() == null ^ this.getIdentityPoolTags() == null) return false; if (other.getIdentityPoolTags() != null && other.getIdentityPoolTags().equals(this.getIdentityPoolTags()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getIdentityPoolName() == null) ? 0 : getIdentityPoolName().hashCode()); hashCode = prime * hashCode + ((getAllowUnauthenticatedIdentities() == null) ? 0 : getAllowUnauthenticatedIdentities().hashCode()); hashCode = prime * hashCode + ((getAllowClassicFlow() == null) ? 0 : getAllowClassicFlow().hashCode()); hashCode = prime * hashCode + ((getSupportedLoginProviders() == null) ? 0 : getSupportedLoginProviders().hashCode()); hashCode = prime * hashCode + ((getDeveloperProviderName() == null) ? 0 : getDeveloperProviderName().hashCode()); hashCode = prime * hashCode + ((getOpenIdConnectProviderARNs() == null) ? 0 : getOpenIdConnectProviderARNs().hashCode()); hashCode = prime * hashCode + ((getCognitoIdentityProviders() == null) ? 0 : getCognitoIdentityProviders().hashCode()); hashCode = prime * hashCode + ((getSamlProviderARNs() == null) ? 0 : getSamlProviderARNs().hashCode()); hashCode = prime * hashCode + ((getIdentityPoolTags() == null) ? 0 : getIdentityPoolTags().hashCode()); return hashCode; } @Override public CreateIdentityPoolRequest clone() { return (CreateIdentityPoolRequest) super.clone(); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy