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

Interface CreateResourceServerRequest.Builder

    • Method Detail

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