com.amazonaws.services.cognitoidentityprovider.model

Class CreateResourceServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.CreateResourceServerRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateResourceServerRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a new OAuth2.0 resource server and defines custom scopes in it.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateResourceServerRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIdentifier() A unique resource server identifier for the resource server.
String	getName() A friendly name for the resource server.
List<ResourceServerScopeType>	getScopes() A list of scopes.
String	getUserPoolId() The user pool ID for the user pool.
int	hashCode()
void	setIdentifier(String identifier) A unique resource server identifier for the resource server.
void	setName(String name) A friendly name for the resource server.
void	setScopes(Collection<ResourceServerScopeType> scopes) A list of scopes.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateResourceServerRequest	withIdentifier(String identifier) A unique resource server identifier for the resource server.
CreateResourceServerRequest	withName(String name) A friendly name for the resource server.
CreateResourceServerRequest	withScopes(Collection<ResourceServerScopeType> scopes) A list of scopes.
CreateResourceServerRequest	withScopes(ResourceServerScopeType... scopes) A list of scopes.
CreateResourceServerRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool.

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

CreateResourceServerRequest

public CreateResourceServerRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool.

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

Returns:

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool.

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

Parameters:

userPoolId -

The user pool ID for the user pool.

withUserPoolId

public CreateResourceServerRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool.

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.

Returns:

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

getIdentifier

public String getIdentifier()

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

Returns:

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

setIdentifier

public void setIdentifier(String identifier)

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

Parameters:

identifier -

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

withIdentifier

public CreateResourceServerRequest withIdentifier(String identifier)

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

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

Constraints:
Length: 1 - 256
Pattern: [\x21\x23-\x5B\x5D-\x7E]+

Parameters:

identifier -

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

Returns:

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

getName

public String getName()

A friendly name for the resource server.

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

Returns:

A friendly name for the resource server.

setName

public void setName(String name)

A friendly name for the resource server.

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

Parameters:

name -

A friendly name for the resource server.

withName

public CreateResourceServerRequest withName(String name)

A friendly name for the resource server.

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

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

Parameters:

name -

A friendly name for the resource server.

Returns:

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

getScopes

public List<ResourceServerScopeType> getScopes()

A list of scopes. Each scope is map, where the keys are name and description.

Returns:

A list of scopes. Each scope is map, where the keys are name and description.

setScopes

public void setScopes(Collection<ResourceServerScopeType> scopes)

A list of scopes. Each scope is map, where the keys are name and description.

Parameters:

scopes -

A list of scopes. Each scope is map, where the keys are name and description.

withScopes

public CreateResourceServerRequest withScopes(ResourceServerScopeType... scopes)

A list of scopes. Each scope is map, where the keys are name and description.

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

Parameters:

scopes -

A list of scopes. Each scope is map, where the keys are name and description.

Returns:

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

withScopes

public CreateResourceServerRequest withScopes(Collection<ResourceServerScopeType> scopes)

A list of scopes. Each scope is map, where the keys are name and description.

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

Parameters:

scopes -

A list of scopes. Each scope is map, where the keys are name and description.

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