com.amazonaws.services.cognitoidp.model.CreateUserPoolDomainRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* 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.cognitoidp.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserPoolDomainRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*
*/
private String domain;
/**
*
* The user pool ID.
*
*/
private String userPoolId;
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
*/
private CustomDomainConfigType customDomainConfig;
/**
*
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*
*
* @param domain
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*
*
* @return The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*/
public String getDomain() {
return this.domain;
}
/**
*
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
*
*
* @param domain
* The domain string. For custom domains, this is the fully-qualified domain name, such as
* auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as
* auth.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserPoolDomainRequest withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The user pool ID.
*
*
* @param userPoolId
* The user pool ID.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID.
*
*
* @return The user pool ID.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID.
*
*
* @param userPoolId
* The user pool ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserPoolDomainRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
*
* @param customDomainConfig
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your
* application.
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can
* exclude this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*/
public void setCustomDomainConfig(CustomDomainConfigType customDomainConfig) {
this.customDomainConfig = customDomainConfig;
}
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
*
* @return The configuration for a custom domain that hosts the sign-up and sign-in webpages for your
* application.
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can
* exclude this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*/
public CustomDomainConfigType getCustomDomainConfig() {
return this.customDomainConfig;
}
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
*
* @param customDomainConfig
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your
* application.
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can
* exclude this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserPoolDomainRequest withCustomDomainConfig(CustomDomainConfigType customDomainConfig) {
setCustomDomainConfig(customDomainConfig);
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 (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getCustomDomainConfig() != null)
sb.append("CustomDomainConfig: ").append(getCustomDomainConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateUserPoolDomainRequest == false)
return false;
CreateUserPoolDomainRequest other = (CreateUserPoolDomainRequest) obj;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getCustomDomainConfig() == null ^ this.getCustomDomainConfig() == null)
return false;
if (other.getCustomDomainConfig() != null && other.getCustomDomainConfig().equals(this.getCustomDomainConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getCustomDomainConfig() == null) ? 0 : getCustomDomainConfig().hashCode());
return hashCode;
}
@Override
public CreateUserPoolDomainRequest clone() {
return (CreateUserPoolDomainRequest) super.clone();
}
}