Interface CreateResourceServerRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>, SdkBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateResourceServerRequest
@Mutable @NotThreadSafe public static interface CreateResourceServerRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateResourceServerRequest.Builder,CreateResourceServerRequest>

  • Method Details

    • userPoolId

      CreateResourceServerRequest.Builder userPoolId(String userPoolId)

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

      Parameters:
      userPoolId - The ID of the user pool where you want to create a resource server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifier

      CreateResourceServerRequest.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

      CreateResourceServerRequest.Builder name(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.

    • scopes

      CreateResourceServerRequest.Builder scopes(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      CreateResourceServerRequest.Builder scopes(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      CreateResourceServerRequest.Builder scopes(Consumer<ResourceServerScopeType.Builder>... 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.

      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<ResourceServerScopeType>).

      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:

    • overrideConfiguration

      CreateResourceServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateResourceServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.