CreateResourceServerRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.CreateResourceServerRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateResourceServerRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Creates a new OAuth2.0 resource server and defines custom scopes within it.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateResourceServerRequest()

Constructors
Constructor and Description
`CreateResourceServerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getIdentifier()` A unique resource server identifier for the resource server.
`java.lang.String`	`getName()` A friendly name for the resource server.
`java.util.List<ResourceServerScopeType>`	`getScopes()` A list of scopes.
`java.lang.String`	`getUserPoolId()` The user pool ID for the user pool.
`int`	`hashCode()`
`void`	`setIdentifier(java.lang.String identifier)` A unique resource server identifier for the resource server.
`void`	`setName(java.lang.String name)` A friendly name for the resource server.
`void`	`setScopes(java.util.Collection<ResourceServerScopeType> scopes)` A list of scopes.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateResourceServerRequest`	`withIdentifier(java.lang.String identifier)` A unique resource server identifier for the resource server.
`CreateResourceServerRequest`	`withName(java.lang.String name)` A friendly name for the resource server.
`CreateResourceServerRequest`	`withScopes(java.util.Collection<ResourceServerScopeType> scopes)` A list of scopes.
`CreateResourceServerRequest`	`withScopes(ResourceServerScopeType... scopes)` A list of scopes.
`CreateResourceServerRequest`	`withUserPoolId(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.String getIdentifier()
```
    A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as 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, such as https://my-weather-api.example.com.
  - setIdentifier
```
public void setIdentifier(java.lang.String identifier)
```
    A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as 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, such as https://my-weather-api.example.com.
  - withIdentifier
```
public CreateResourceServerRequest withIdentifier(java.lang.String identifier)
```
    A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as 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, such as https://my-weather-api.example.com.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getName
```
public java.lang.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(java.lang.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(java.lang.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 java.util.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(java.util.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    scopes -
    A list of scopes. Each scope is a key-value map with the keys name and description.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withScopes
```
public CreateResourceServerRequest withScopes(java.util.Collection<ResourceServerScopeType> scopes)
```
    A list of scopes. Each scope is a key-value map with the keys 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 a key-value map with the keys name and description.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class CreateResourceServerRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateResourceServerRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getIdentifier

setIdentifier

withIdentifier

getName

setName

withName

getScopes

setScopes

withScopes

withScopes

toString

hashCode

equals