Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class CreateResourceServerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateResourceServerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateResourceServerRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateResourceServerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateResourceServerRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasScopes()	For responses, this returns true if the service returned a value for the Scopes property.
String	identifier()	A unique resource server identifier for the resource server.
String	name()	A friendly name for the resource server.
List<ResourceServerScopeType>	scopes()	A list of custom scopes.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateResourceServerRequest.Builder>	serializableBuilderClass()
CreateResourceServerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The ID of the user pool where you want to create a resource server.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public final String userPoolId()

The ID of the user pool where you want to create a resource server.

Returns:

The ID of the user pool where you want to create a resource server.

identifier

public final 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.

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.

name

public final String name()

A friendly name for the resource server.

Returns:

A friendly name for the resource server.

hasScopes

public final boolean hasScopes()

For responses, this returns true if the service returned a value for the Scopes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

scopes

public final List<ResourceServerScopeType> scopes()

A list of custom scopes. Each scope is a key-value map with the keys ScopeName and ScopeDescription. The name of a custom scope is a combination of ScopeName and the resource server Name in this request, for example MyResourceServerName/MyScopeName.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScopes() method.

Returns:

A list of custom scopes. Each scope is a key-value map with the keys ScopeName and ScopeDescription. The name of a custom scope is a combination of ScopeName and the resource server Name in this request, for example MyResourceServerName/MyScopeName.

toBuilder

public CreateResourceServerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static CreateResourceServerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateResourceServerRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo