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

Interface ResourceServerType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ResourceServerType.Builder,ResourceServerType>, SdkBuilder<ResourceServerType.Builder,ResourceServerType>, SdkPojo
Enclosing class:
ResourceServerType
public static interface ResourceServerType.Builder extends SdkPojo, CopyableBuilder<ResourceServerType.Builder,ResourceServerType>

  • Method Details

    • userPoolId

      ResourceServerType.Builder userPoolId(String userPoolId)

      The user pool ID for the user pool that hosts the resource server.

      Parameters:
      userPoolId - The user pool ID for the user pool that hosts the resource server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identifier

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

      ResourceServerType.Builder name(String name)

      The name of the resource server.

      Parameters:
      name - The name of the resource server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      ResourceServerType.Builder scopes(Collection<ResourceServerScopeType> scopes)

      A list of scopes that are defined for the resource server.

      Parameters:
      scopes - A list of scopes that are defined for the resource server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      ResourceServerType.Builder scopes(ResourceServerScopeType... scopes)

      A list of scopes that are defined for the resource server.

      Parameters:
      scopes - A list of scopes that are defined for the resource server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

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

      A list of scopes that are defined for the 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<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: