Class CfnUserPoolResourceServer
The AWS::Cognito::UserPoolResourceServer
resource creates a new OAuth2.0 resource server and defines custom scopes in it.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUserPoolResourceServer : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUserPoolResourceServer
Inherits CfnResource
Implements IInspectable
Remarks
If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
CloudformationResource: AWS::Cognito::UserPoolResourceServer
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 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"
} }
});
Synopsis
Constructors
CfnUserPoolResourceServer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserPoolResourceServer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUserPoolResourceServer(Construct, String, ICfnUserPoolResourceServerProps) |
Properties
AttrId | The resource ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 user pool ID for the user pool. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserPoolResourceServer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserPoolResourceServer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserPoolResourceServer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserPoolResourceServer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUserPoolResourceServer(Construct, String, ICfnUserPoolResourceServerProps)
public CfnUserPoolResourceServer(Construct scope, string id, ICfnUserPoolResourceServerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUserPoolResourceServerProps
Resource properties.
Properties
AttrId
The resource ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Identifier
A unique resource server identifier for the resource server.
public virtual string Identifier { get; set; }
Property Value
System.String
Name
A friendly name for the resource server.
public virtual string Name { get; set; }
Property Value
System.String
Scopes
A list of scopes.
public virtual object Scopes { get; set; }
Property Value
System.Object
UserPoolId
The user pool ID for the user pool.
public virtual string UserPoolId { get; set; }
Property Value
System.String
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>