ResourceServerScopeTypeProperty Struct
One custom scope associated with a user pool resource server.
This data type is a member of ResourceServerScopeType . For more information, see Scopes, M2M, and API authorization with resource servers .
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const resourceServerScopeTypeProperty: cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty = {
scopeDescription: 'scopeDescription',
scopeName: 'scopeName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito
resource_server_scope_type_property = cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty(
scope_description="scopeDescription",
scope_name="scopeName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cognito.*;
ResourceServerScopeTypeProperty resourceServerScopeTypeProperty = ResourceServerScopeTypeProperty.builder()
.scopeDescription("scopeDescription")
.scopeName("scopeName")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 resourceServerScopeTypeProperty = new ResourceServerScopeTypeProperty {
ScopeDescription = "scopeDescription",
ScopeName = "scopeName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
resourceServerScopeTypeProperty := &ResourceServerScopeTypeProperty{
ScopeDescription: jsii.String("scopeDescription"),
ScopeName: jsii.String("scopeName"),
}
Properties
scopeDescriptionstringscope_descriptionstrscopeDescriptionStringScopeDescriptionstringScopeDescription*string required #A friendly description of a custom scope.
The name of the scope.
notes
Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName . For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer , you request and receive the scope exampleResourceServer/exampleScope .