com.amazonaws.services.cognitoidentityprovider.model

Class CreateUserPoolClientRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolClientRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateUserPoolClientRequest
extends AmazonWebServiceRequest
implements Serializable

Creates the user pool client.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateUserPoolClientRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getClientName() The client name for the user pool client you would like to create.
List<String>	getExplicitAuthFlows() The explicit authentication flows.
Boolean	getGenerateSecret() Boolean to specify whether you want to generate a secret for the user pool client being created.
List<String>	getReadAttributes() The read attributes.
Integer	getRefreshTokenValidity() Refreshes the token validity.
String	getUserPoolId() The user pool ID for the user pool where you want to create a user pool client.
List<String>	getWriteAttributes() The write attributes.
int	hashCode()
Boolean	isGenerateSecret() Boolean to specify whether you want to generate a secret for the user pool client being created.
void	setClientName(String clientName) The client name for the user pool client you would like to create.
void	setExplicitAuthFlows(Collection<String> explicitAuthFlows) The explicit authentication flows.
void	setGenerateSecret(Boolean generateSecret) Boolean to specify whether you want to generate a secret for the user pool client being created.
void	setReadAttributes(Collection<String> readAttributes) The read attributes.
void	setRefreshTokenValidity(Integer refreshTokenValidity) Refreshes the token validity.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool where you want to create a user pool client.
void	setWriteAttributes(Collection<String> writeAttributes) The write attributes.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateUserPoolClientRequest	withClientName(String clientName) The client name for the user pool client you would like to create.
CreateUserPoolClientRequest	withExplicitAuthFlows(Collection<String> explicitAuthFlows) The explicit authentication flows.
CreateUserPoolClientRequest	withExplicitAuthFlows(String... explicitAuthFlows) The explicit authentication flows.
CreateUserPoolClientRequest	withGenerateSecret(Boolean generateSecret) Boolean to specify whether you want to generate a secret for the user pool client being created.
CreateUserPoolClientRequest	withReadAttributes(Collection<String> readAttributes) The read attributes.
CreateUserPoolClientRequest	withReadAttributes(String... readAttributes) The read attributes.
CreateUserPoolClientRequest	withRefreshTokenValidity(Integer refreshTokenValidity) Refreshes the token validity.
CreateUserPoolClientRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool where you want to create a user pool client.
CreateUserPoolClientRequest	withWriteAttributes(Collection<String> writeAttributes) The write attributes.
CreateUserPoolClientRequest	withWriteAttributes(String... writeAttributes) The write attributes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserPoolClientRequest

public CreateUserPoolClientRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool where you want to create a user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID for the user pool where you want to create a user pool client.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to create a user pool client.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool where you want to create a user pool client.

withUserPoolId

public CreateUserPoolClientRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool where you want to create a user pool client.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID for the user pool where you want to create a user pool client.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientName

public String getClientName()

The client name for the user pool client you would like to create.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Returns:

The client name for the user pool client you would like to create.

setClientName

public void setClientName(String clientName)

The client name for the user pool client you would like to create.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Parameters:

clientName -

The client name for the user pool client you would like to create.

withClientName

public CreateUserPoolClientRequest withClientName(String clientName)

The client name for the user pool client you would like to create.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+

Parameters:

clientName -

The client name for the user pool client you would like to create.

Returns:

A reference to this updated object so that method calls can be chained together.

isGenerateSecret

public Boolean isGenerateSecret()

Boolean to specify whether you want to generate a secret for the user pool client being created.

Returns:

Boolean to specify whether you want to generate a secret for the user pool client being created.

getGenerateSecret

public Boolean getGenerateSecret()

Boolean to specify whether you want to generate a secret for the user pool client being created.

Returns:

Boolean to specify whether you want to generate a secret for the user pool client being created.

setGenerateSecret

public void setGenerateSecret(Boolean generateSecret)

Boolean to specify whether you want to generate a secret for the user pool client being created.

Parameters:

generateSecret -

Boolean to specify whether you want to generate a secret for the user pool client being created.

withGenerateSecret

public CreateUserPoolClientRequest withGenerateSecret(Boolean generateSecret)

Boolean to specify whether you want to generate a secret for the user pool client being created.

Returns a reference to this object so that method calls can be chained together.

Parameters:

generateSecret -

Boolean to specify whether you want to generate a secret for the user pool client being created.

Returns:

A reference to this updated object so that method calls can be chained together.

getRefreshTokenValidity

public Integer getRefreshTokenValidity()

Refreshes the token validity.

Constraints:
Range: 0 - 3650

Returns:

Refreshes the token validity.

setRefreshTokenValidity

public void setRefreshTokenValidity(Integer refreshTokenValidity)

Refreshes the token validity.

Constraints:
Range: 0 - 3650

Parameters:

refreshTokenValidity -

Refreshes the token validity.

withRefreshTokenValidity

public CreateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)

Refreshes the token validity.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 - 3650

Parameters:

refreshTokenValidity -

Refreshes the token validity.

Returns:

A reference to this updated object so that method calls can be chained together.

getReadAttributes

public List<String> getReadAttributes()

The read attributes.

Returns:

The read attributes.

setReadAttributes

public void setReadAttributes(Collection<String> readAttributes)

The read attributes.

Parameters:

readAttributes -

The read attributes.

withReadAttributes

public CreateUserPoolClientRequest withReadAttributes(String... readAttributes)

The read attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

readAttributes -

The read attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

withReadAttributes

public CreateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)

The read attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

readAttributes -

The read attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

getWriteAttributes

public List<String> getWriteAttributes()

The write attributes.

Returns:

The write attributes.

setWriteAttributes

public void setWriteAttributes(Collection<String> writeAttributes)

The write attributes.

Parameters:

writeAttributes -

The write attributes.

withWriteAttributes

public CreateUserPoolClientRequest withWriteAttributes(String... writeAttributes)

The write attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

writeAttributes -

The write attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

withWriteAttributes

public CreateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)

The write attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

writeAttributes -

The write attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

getExplicitAuthFlows

public List<String> getExplicitAuthFlows()

The explicit authentication flows.

Returns:

The explicit authentication flows.

setExplicitAuthFlows

public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)

The explicit authentication flows.

Parameters:

explicitAuthFlows -

The explicit authentication flows.

withExplicitAuthFlows

public CreateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)

The explicit authentication flows.

Returns a reference to this object so that method calls can be chained together.

Parameters:

explicitAuthFlows -

The explicit authentication flows.

Returns:

A reference to this updated object so that method calls can be chained together.

withExplicitAuthFlows

public CreateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)

The explicit authentication flows.

Returns a reference to this object so that method calls can be chained together.

Parameters:

explicitAuthFlows -

The explicit authentication flows.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object