Interface ICfnUserPoolResourceServerProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties for defining a CfnUserPoolResourceServer.

public interface ICfnUserPoolResourceServerProps

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"
                 } }
             };

Remarks

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

ExampleMetadata: fixture=_generated

Properties

Identifier

A unique resource server identifier for the resource server.

string Identifier { get; }

Property Value

string

Remarks

This could be an HTTPS endpoint where the resource server is located. For example: https://my-weather-api.example.com .

Link: 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

string

Remarks

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

Scopes

A list of scopes.

object? Scopes { get; }

Property Value

object

Remarks

Each scope is a map with keys ScopeName and ScopeDescription .

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

UserPoolId

The user pool ID for the user pool.

string UserPoolId { get; }

Property Value

string

Remarks

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