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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cognito.UserPoolResourceServer

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Cognito::UserPoolResourceServer

    Create UserPoolResourceServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserPoolResourceServer(name: string, args: UserPoolResourceServerArgs, opts?: CustomResourceOptions);
    @overload
def UserPoolResourceServer(resource_name: str,
                           args: UserPoolResourceServerArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def UserPoolResourceServer(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           identifier: Optional[str] = None,
                           user_pool_id: Optional[str] = None,
                           name: Optional[str] = None,
                           scopes: Optional[Sequence[UserPoolResourceServerResourceServerScopeTypeArgs]] = None)
    func NewUserPoolResourceServer(ctx *Context, name string, args UserPoolResourceServerArgs, opts ...ResourceOption) (*UserPoolResourceServer, error)
    public UserPoolResourceServer(string name, UserPoolResourceServerArgs args, CustomResourceOptions? opts = null)
    public UserPoolResourceServer(String name, UserPoolResourceServerArgs args)
public UserPoolResourceServer(String name, UserPoolResourceServerArgs args, CustomResourceOptions options)

    type: aws-native:cognito:UserPoolResourceServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserPoolResourceServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserPoolResourceServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserPoolResourceServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolResourceServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolResourceServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    UserPoolResourceServer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserPoolResourceServer resource accepts the following input properties:

    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 ID of the user pool where you want to create a resource server.
    Name string
    A friendly name for the resource server.
    Scopes List<Pulumi.AwsNative.Cognito.Inputs.UserPoolResourceServerResourceServerScopeType>
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    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 ID of the user pool where you want to create a resource server.
    Name string
    A friendly name for the resource server.
    Scopes []UserPoolResourceServerResourceServerScopeTypeArgs
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    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 ID of the user pool where you want to create a resource server.
    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 .
    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 ID of the user pool where you want to create a resource server.
    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 .
    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 ID of the user pool where you want to create a resource server.
    name str
    A friendly name for the resource server.
    scopes Sequence[UserPoolResourceServerResourceServerScopeTypeArgs]
    A list of scopes. Each scope is a map with keys ScopeName and ScopeDescription .
    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 ID of the user pool where you want to create a resource server.
    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 .

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPoolResourceServer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    UserPoolResourceServerResourceServerScopeType, UserPoolResourceServerResourceServerScopeTypeArgs

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native