Class CfnUserPoolResourceServer

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

A CloudFormation AWS::Cognito::UserPoolResourceServer.

public class CfnUserPoolResourceServer : CfnResource, IInspectable

Inheritance

object

CfnUserPoolResourceServer

Implements

IInspectable

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 cfnUserPoolResourceServer = new CfnUserPoolResourceServer(this, "MyCfnUserPoolResourceServer", new CfnUserPoolResourceServerProps {
                 Identifier = "identifier",
                 Name = "name",
                 UserPoolId = "userPoolId",

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

Remarks

The AWS::Cognito::UserPoolResourceServer resource creates a new OAuth2.0 resource server and defines custom scopes in it.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

CloudformationResource: AWS::Cognito::UserPoolResourceServer

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

ExampleMetadata: fixture=_generated

Constructors

CfnUserPoolResourceServer(Construct, string, ICfnUserPoolResourceServerProps)

Create a new AWS::Cognito::UserPoolResourceServer.

public CfnUserPoolResourceServer(Construct scope, string id, ICfnUserPoolResourceServerProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnUserPoolResourceServerProps

• resource properties.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Identifier

A unique resource server identifier for the resource server.

public virtual string Identifier { get; set; }

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.

public virtual string Name { get; set; }

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.

public virtual object? Scopes { get; set; }

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.

public virtual string UserPoolId { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>