Interface ICfnUserPoolResourceServerProps

Properties for defining a CfnUserPoolResourceServer.

Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnUserPoolResourceServerProps
Syntax (vb)
Public Interface ICfnUserPoolResourceServerProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;

var cfnUserPoolResourceServerProps = new CfnUserPoolResourceServerProps {
    Identifier = "identifier",
    Name = "name",
    UserPoolId = "userPoolId",

    // the properties below are optional
    Scopes = new [] { new ResourceServerScopeTypeProperty {
        ScopeDescription = "scopeDescription",
        ScopeName = "scopeName"
    } }
};

Synopsis

Properties

Identifier

A unique resource server identifier for the resource server.
Name

A friendly name for the resource server.
Scopes

A list of scopes.
UserPoolId

The ID of the user pool where you want to create a resource server.

Properties

Identifier

A unique resource server identifier for the resource server.

string Identifier { get; }
Property Value

System.String

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-identifier

Name

A friendly name for the resource server.

string Name { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-name

Scopes

A list of scopes.

virtual object Scopes { get; }
Property Value

System.Object

Remarks

Each scope is a map with keys ScopeName and ScopeDescription .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-scopes

UserPoolId

The ID of the user pool where you want to create a resource server.

string UserPoolId { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolresourceserver.html#cfn-cognito-userpoolresourceserver-userpoolid