com.amazonaws.services.cognitoidp.model

Class CreateResourceServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.CreateResourceServerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateResourceServerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateResourceServerRequest()

Method Summary

Modifier and Type	Method and Description
CreateResourceServerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateResourceServerRequest

public CreateResourceServerRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId - The user pool ID for the user pool.

getUserPoolId

public String getUserPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

withUserPoolId

public CreateResourceServerRequest withUserPoolId(String userPoolId)

The user pool ID for the user pool.

Parameters:

userPoolId - The user pool ID for the user pool.

Returns:

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

setIdentifier

public void setIdentifier(String identifier)

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Parameters:

identifier - A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

getIdentifier

public String getIdentifier()

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Returns:

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

withIdentifier

public CreateResourceServerRequest withIdentifier(String identifier)

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Parameters:

identifier - A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Returns:

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

setName

public void setName(String name)

A friendly name for the resource server.

Parameters:

name - A friendly name for the resource server.

getName

public String getName()

A friendly name for the resource server.

Returns:

A friendly name for the resource server.

withName

public CreateResourceServerRequest withName(String name)

A friendly name for the resource server.

Parameters:

name - A friendly name for the resource server.

Returns:

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

getScopes

public List<ResourceServerScopeType> getScopes()

A list of scopes. Each scope is a key-value map with the keys name and description.

Returns:

A list of scopes. Each scope is a key-value map with the keys name and description.

setScopes

public void setScopes(Collection<ResourceServerScopeType> scopes)

A list of scopes. Each scope is a key-value map with the keys name and description.

Parameters:

scopes - A list of scopes. Each scope is a key-value map with the keys name and description.

withScopes

public CreateResourceServerRequest withScopes(ResourceServerScopeType... scopes)

A list of scopes. Each scope is a key-value map with the keys name and description.

NOTE: This method appends the values to the existing list (if any). Use setScopes(java.util.Collection) or withScopes(java.util.Collection) if you want to override the existing values.

Parameters:

scopes - A list of scopes. Each scope is a key-value map with the keys name and description.

Returns:

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

withScopes

public CreateResourceServerRequest withScopes(Collection<ResourceServerScopeType> scopes)

A list of scopes. Each scope is a key-value map with the keys name and description.

Parameters:

scopes - A list of scopes. Each scope is a key-value map with the keys name and description.

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateResourceServerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()