@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to create a user pool client.
NOOP
Constructor and Description |
---|
CreateUserPoolClientRequest() |
Modifier and Type | Method and Description |
---|---|
CreateUserPoolClientRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAllowedOAuthFlows()
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
Boolean |
getAllowedOAuthFlowsUserPoolClient()
Set to
True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools. |
List<String> |
getAllowedOAuthScopes()
A list of allowed
OAuth scopes. |
List<String> |
getCallbackURLs()
A list of allowed callback URLs for the identity providers.
|
String |
getClientName()
The client name for the user pool client you would like to create.
|
String |
getDefaultRedirectURI()
The default redirect URI.
|
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> |
getLogoutURLs()
A list of allowed logout URLs for the identity providers.
|
List<String> |
getReadAttributes()
The read attributes.
|
Integer |
getRefreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
List<String> |
getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
|
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 |
isAllowedOAuthFlowsUserPoolClient()
Set to
True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools. |
Boolean |
isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
void |
setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
void |
setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools. |
void |
setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed
OAuth scopes. |
void |
setCallbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
|
void |
setClientName(String clientName)
The client name for the user pool client you would like to create.
|
void |
setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
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 |
setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
void |
setReadAttributes(Collection<String> readAttributes)
The read attributes.
|
void |
setRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
void |
setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
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 |
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest |
withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest |
withAllowedOAuthFlows(String... allowedOAuthFlows)
Set to
code to initiate a code grant flow, which provides an authorization code as the response. |
CreateUserPoolClientRequest |
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools. |
CreateUserPoolClientRequest |
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed
OAuth scopes. |
CreateUserPoolClientRequest |
withAllowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed
OAuth scopes. |
CreateUserPoolClientRequest |
withCallbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
|
CreateUserPoolClientRequest |
withCallbackURLs(String... callbackURLs)
A list of allowed callback URLs for the identity providers.
|
CreateUserPoolClientRequest |
withClientName(String clientName)
The client name for the user pool client you would like to create.
|
CreateUserPoolClientRequest |
withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The explicit authentication flows.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(ExplicitAuthFlowsType... 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 |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest |
withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest |
withReadAttributes(Collection<String> readAttributes)
The read attributes.
|
CreateUserPoolClientRequest |
withReadAttributes(String... readAttributes)
The read attributes.
|
CreateUserPoolClientRequest |
withRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId
- The user pool ID for the user pool where you want to create a user pool client.public String getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
public CreateUserPoolClientRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId
- The user pool ID for the user pool where you want to create a user pool client.public void setClientName(String clientName)
The client name for the user pool client you would like to create.
clientName
- The client name for the user pool client you would like to create.public String getClientName()
The client name for the user pool client you would like to create.
public CreateUserPoolClientRequest withClientName(String clientName)
The client name for the user pool client you would like to create.
clientName
- The client name for the user pool client you would like to create.public void setGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret
- Boolean to specify whether you want to generate a secret for the user pool client being created.public Boolean getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public CreateUserPoolClientRequest withGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret
- Boolean to specify whether you want to generate a secret for the user pool client being created.public Boolean isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public void setRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
refreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and cannot be used.public Integer getRefreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
public CreateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
refreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and cannot be used.public List<String> getReadAttributes()
The read attributes.
public void setReadAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes
- The read attributes.public CreateUserPoolClientRequest withReadAttributes(String... readAttributes)
The read attributes.
NOTE: This method appends the values to the existing list (if any). Use
setReadAttributes(java.util.Collection)
or withReadAttributes(java.util.Collection)
if you want
to override the existing values.
readAttributes
- The read attributes.public CreateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes
- The read attributes.public List<String> getWriteAttributes()
The write attributes.
public void setWriteAttributes(Collection<String> writeAttributes)
The write attributes.
writeAttributes
- The write attributes.public CreateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
The write attributes.
NOTE: This method appends the values to the existing list (if any). Use
setWriteAttributes(java.util.Collection)
or withWriteAttributes(java.util.Collection)
if you
want to override the existing values.
writeAttributes
- The write attributes.public CreateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
The write attributes.
writeAttributes
- The write attributes.public List<String> getExplicitAuthFlows()
The explicit authentication flows.
ExplicitAuthFlowsType
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.ExplicitAuthFlowsType
public CreateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)
The explicit authentication flows.
NOTE: This method appends the values to the existing list (if any). Use
setExplicitAuthFlows(java.util.Collection)
or withExplicitAuthFlows(java.util.Collection)
if
you want to override the existing values.
explicitAuthFlows
- The explicit authentication flows.ExplicitAuthFlowsType
public CreateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.ExplicitAuthFlowsType
public CreateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The explicit authentication flows.
explicitAuthFlows
- The explicit authentication flows.ExplicitAuthFlowsType
public List<String> getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.public CreateUserPoolClientRequest withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
NOTE: This method appends the values to the existing list (if any). Use
setSupportedIdentityProviders(java.util.Collection)
or
withSupportedIdentityProviders(java.util.Collection)
if you want to override the existing values.
supportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.public CreateUserPoolClientRequest withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders
- A list of provider names for the identity providers that are supported on this client.public List<String> getCallbackURLs()
A list of allowed callback URLs for the identity providers.
public void setCallbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
callbackURLs
- A list of allowed callback URLs for the identity providers.public CreateUserPoolClientRequest withCallbackURLs(String... callbackURLs)
A list of allowed callback URLs for the identity providers.
NOTE: This method appends the values to the existing list (if any). Use
setCallbackURLs(java.util.Collection)
or withCallbackURLs(java.util.Collection)
if you want to
override the existing values.
callbackURLs
- A list of allowed callback URLs for the identity providers.public CreateUserPoolClientRequest withCallbackURLs(Collection<String> callbackURLs)
A list of allowed callback URLs for the identity providers.
callbackURLs
- A list of allowed callback URLs for the identity providers.public List<String> getLogoutURLs()
A list of allowed logout URLs for the identity providers.
public void setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.public CreateUserPoolClientRequest withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
NOTE: This method appends the values to the existing list (if any). Use
setLogoutURLs(java.util.Collection)
or withLogoutURLs(java.util.Collection)
if you want to
override the existing values.
logoutURLs
- A list of allowed logout URLs for the identity providers.public CreateUserPoolClientRequest withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.public void setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs
list.
defaultRedirectURI
- The default redirect URI. Must be in the CallbackURLs
list.public String getDefaultRedirectURI()
The default redirect URI. Must be in the CallbackURLs
list.
CallbackURLs
list.public CreateUserPoolClientRequest withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs
list.
defaultRedirectURI
- The default redirect URI. Must be in the CallbackURLs
list.public List<String> getAllowedOAuthFlows()
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
code
to initiate a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID
token, based on scopes) directly.
OAuthFlowType
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
allowedOAuthFlows
- Set to code
to initiate a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID
token, based on scopes) directly.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(String... allowedOAuthFlows)
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedOAuthFlows(java.util.Collection)
or withAllowedOAuthFlows(java.util.Collection)
if
you want to override the existing values.
allowedOAuthFlows
- Set to code
to initiate a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID
token, based on scopes) directly.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
allowedOAuthFlows
- Set to code
to initiate a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID
token, based on scopes) directly.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
allowedOAuthFlows
- Set to code
to initiate a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the token endpoint.
Set to token
to specify that the client should get the access token (and, optionally, ID
token, based on scopes) directly.
OAuthFlowType
public List<String> getAllowedOAuthScopes()
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
allowedOAuthScopes
- A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.public CreateUserPoolClientRequest withAllowedOAuthScopes(String... allowedOAuthScopes)
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedOAuthScopes(java.util.Collection)
or withAllowedOAuthScopes(java.util.Collection)
if
you want to override the existing values.
allowedOAuthScopes
- A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.public CreateUserPoolClientRequest withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.
allowedOAuthScopes
- A list of allowed OAuth
scopes. Currently supported values are "phone"
,
"email"
, "openid"
, and "Cognito"
.public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
allowedOAuthFlowsUserPoolClient
- Set to True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.public Boolean getAllowedOAuthFlowsUserPoolClient()
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.public CreateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
allowedOAuthFlowsUserPoolClient
- Set to True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.public Boolean isAllowedOAuthFlowsUserPoolClient()
Set to True
if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.
True
if the client is allowed to follow the OAuth protocol when interacting with
Cognito user pools.public String toString()
toString
in class Object
Object.toString()
public CreateUserPoolClientRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.