We recommend new projects start with resources from the AWS provider.
aws-native.cognito.UserPoolResourceServer
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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
This property is required. string - The unique name of the resource.
- args
This property is required. UserPoolResourceServerArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. UserPoolResourceServerArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. UserPoolResourceServerArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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
This property is required. 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 likehttps://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 This property is required. 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.
Aws Native. Cognito. Inputs. User Pool Resource Server Resource Server Scope Type> - A list of scopes. Each scope is a map with keys
ScopeName
andScopeDescription
.
- Identifier
This property is required. 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 likehttps://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 This property is required. 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
[]User
Pool Resource Server Resource Server Scope Type Args - A list of scopes. Each scope is a map with keys
ScopeName
andScopeDescription
.
- identifier
This property is required. 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 likehttps://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 This property is required. 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<User
Pool Resource Server Resource Server Scope Type> - A list of scopes. Each scope is a map with keys
ScopeName
andScopeDescription
.
- identifier
This property is required. 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 likehttps://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 This property is required. 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
User
Pool Resource Server Resource Server Scope Type[] - A list of scopes. Each scope is a map with keys
ScopeName
andScopeDescription
.
- identifier
This property is required. 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 likehttps://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 This property is required. 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[User
Pool Resource Server Resource Server Scope Type Args] - A list of scopes. Each scope is a map with keys
ScopeName
andScopeDescription
.
- identifier
This property is required. 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 likehttps://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 This property is required. 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
andScopeDescription
.
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
- Scope
Description This property is required. string - A friendly description of a custom scope.
- Scope
Name This property is required. string - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
- Scope
Description This property is required. string - A friendly description of a custom scope.
- Scope
Name This property is required. string - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
- scope
Description This property is required. String - A friendly description of a custom scope.
- scope
Name This property is required. String - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
- scope
Description This property is required. string - A friendly description of a custom scope.
- scope
Name This property is required. string - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
- scope_
description This property is required. str - A friendly description of a custom scope.
- scope_
name This property is required. str - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
- scope
Description This property is required. String - A friendly description of a custom scope.
- scope
Name This property is required. String - The name of the scope. Amazon Cognito renders custom scopes in the format
resourceServerIdentifier/ScopeName
. For example, if this parameter isexampleScope
in the resource server with the identifierexampleResourceServer
, you request and receive the scopeexampleResourceServer/exampleScope
.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.