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

Interface UpdateResourceServerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateResourceServerRequest.Builder,UpdateResourceServerRequest>, SdkBuilder<UpdateResourceServerRequest.Builder,UpdateResourceServerRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateResourceServerRequest

@Mutable
@NotThreadSafe
public static interface UpdateResourceServerRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateResourceServerRequest.Builder,UpdateResourceServerRequest>

Method Summary

Modifier and Type	Method	Description
UpdateResourceServerRequest.Builder	identifier(String identifier)	A unique resource server identifier for the resource server.
UpdateResourceServerRequest.Builder	name(String name)	The updated name of the resource server.
UpdateResourceServerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateResourceServerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateResourceServerRequest.Builder	scopes(Collection<ResourceServerScopeType> scopes)	An array of updated custom scope names and descriptions that you want to associate with your resource server.
UpdateResourceServerRequest.Builder	scopes(Consumer<ResourceServerScopeType.Builder>... scopes)	An array of updated custom scope names and descriptions that you want to associate with your resource server.
UpdateResourceServerRequest.Builder	scopes(ResourceServerScopeType... scopes)	An array of updated custom scope names and descriptions that you want to associate with your resource server.
UpdateResourceServerRequest.Builder	userPoolId(String userPoolId)	The ID of the user pool that contains the resource server that you want to update.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

userPoolId

UpdateResourceServerRequest.Builder userPoolId(String userPoolId)

The ID of the user pool that contains the resource server that you want to update.

Parameters:

userPoolId - The ID of the user pool that contains the resource server that you want to update.

Returns:

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

identifier

UpdateResourceServerRequest.Builder identifier(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.

name

UpdateResourceServerRequest.Builder name(String name)

The updated name of the resource server.

Parameters:

name - The updated name of the resource server.

Returns:

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

scopes

UpdateResourceServerRequest.Builder scopes(Collection<ResourceServerScopeType> scopes)

An array of updated custom scope names and descriptions that you want to associate with your resource server.

Parameters:

scopes - An array of updated custom scope names and descriptions that you want to associate with your resource server.

Returns:

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

scopes

UpdateResourceServerRequest.Builder scopes(ResourceServerScopeType... scopes)

An array of updated custom scope names and descriptions that you want to associate with your resource server.

Parameters:

scopes - An array of updated custom scope names and descriptions that you want to associate with your resource server.

Returns:

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

scopes

UpdateResourceServerRequest.Builder scopes(Consumer<ResourceServerScopeType.Builder>... scopes)

An array of updated custom scope names and descriptions that you want to associate with your resource server.

This is a convenience method that creates an instance of the ResourceServerScopeType.Builder avoiding the need to create one manually via ResourceServerScopeType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #scopes(List).

Parameters:

scopes - a consumer that will call methods on ResourceServerScopeType.Builder

Returns:

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

See Also:

#scopes(java.util.Collection)

overrideConfiguration

UpdateResourceServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateResourceServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder