Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cognito
  5. getUserPoolResourceServer

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.getUserPoolResourceServer

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::UserPoolResourceServer

    Using getUserPoolResourceServer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserPoolResourceServer(args: GetUserPoolResourceServerArgs, opts?: InvokeOptions): Promise<GetUserPoolResourceServerResult>
function getUserPoolResourceServerOutput(args: GetUserPoolResourceServerOutputArgs, opts?: InvokeOptions): Output<GetUserPoolResourceServerResult>
    def get_user_pool_resource_server(identifier: Optional[str] = None,
                                  user_pool_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetUserPoolResourceServerResult
def get_user_pool_resource_server_output(identifier: Optional[pulumi.Input[str]] = None,
                                  user_pool_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolResourceServerResult]
    func LookupUserPoolResourceServer(ctx *Context, args *LookupUserPoolResourceServerArgs, opts ...InvokeOption) (*LookupUserPoolResourceServerResult, error)
func LookupUserPoolResourceServerOutput(ctx *Context, args *LookupUserPoolResourceServerOutputArgs, opts ...InvokeOption) LookupUserPoolResourceServerResultOutput

    > Note: This function is named LookupUserPoolResourceServer in the Go SDK.

    public static class GetUserPoolResourceServer 
{
    public static Task<GetUserPoolResourceServerResult> InvokeAsync(GetUserPoolResourceServerArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolResourceServerResult> Invoke(GetUserPoolResourceServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserPoolResourceServerResult> getUserPoolResourceServer(GetUserPoolResourceServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cognito:getUserPoolResourceServer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Identifier string

    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.

    UserPoolId string
    The user pool ID for the user pool.
    Identifier string

    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.

    UserPoolId string
    The user pool ID for the user pool.
    identifier String

    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.

    userPoolId String
    The user pool ID for the user pool.
    identifier string

    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.

    userPoolId string
    The user pool ID for the user pool.
    identifier str

    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.

    user_pool_id str
    The user pool ID for the user pool.
    identifier String

    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.

    userPoolId String
    The user pool ID for the user pool.

    getUserPoolResourceServer Result

    The following output properties are available:

    Name string
    A friendly name for the resource server.
    Scopes List<Pulumi.AwsNative.Cognito.Outputs.UserPoolResourceServerResourceServerScopeType>
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    Name string
    A friendly name for the resource server.
    Scopes []UserPoolResourceServerResourceServerScopeType
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    name String
    A friendly name for the resource server.
    scopes List<UserPoolResourceServerResourceServerScopeType>
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    name string
    A friendly name for the resource server.
    scopes UserPoolResourceServerResourceServerScopeType[]
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    name str
    A friendly name for the resource server.
    scopes Sequence[UserPoolResourceServerResourceServerScopeType]
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    name String
    A friendly name for the resource server.
    scopes List<Property Map>
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .

    Supporting Types

    UserPoolResourceServerResourceServerScopeType

    ScopeDescription string
    A friendly description of a custom scope.
    ScopeName string
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .
    ScopeDescription string
    A friendly description of a custom scope.
    ScopeName string
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .
    scopeDescription String
    A friendly description of a custom scope.
    scopeName String
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .
    scopeDescription string
    A friendly description of a custom scope.
    scopeName string
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .
    scope_description str
    A friendly description of a custom scope.
    scope_name str
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .
    scopeDescription String
    A friendly description of a custom scope.
    scopeName String
    The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native