Package software.amazon.awscdk.services.cognito

Class CfnUserPoolResourceServer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolResourceServer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.961Z") @Stability(Stable) public class CfnUserPoolResourceServer extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolResourceServer.

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.

Example: 

 // 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.*;
 CfnUserPoolResourceServer cfnUserPoolResourceServer = CfnUserPoolResourceServer.Builder.create(this, "MyCfnUserPoolResourceServer")
         .identifier("identifier")
         .name("name")
         .userPoolId("userPoolId")
         // the properties below are optional
         .scopes(List.of(ResourceServerScopeTypeProperty.builder()
                 .scopeDescription("scopeDescription")
                 .scopeName("scopeName")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserPoolResourceServer

      protected CfnUserPoolResourceServer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserPoolResourceServer

      protected CfnUserPoolResourceServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserPoolResourceServer

      @Stability(Stable) public CfnUserPoolResourceServer(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserPoolResourceServerProps props)
      Create a new AWS::Cognito::UserPoolResourceServer.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getIdentifier

      @Stability(Stable) @NotNull public String getIdentifier()
      A unique resource server identifier for the resource server.

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

    • setIdentifier

      @Stability(Stable) public void setIdentifier(@NotNull String value)
      A unique resource server identifier for the resource server.

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      A friendly name for the resource server.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A friendly name for the resource server.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool.

    • getScopes

      @Stability(Stable) @Nullable public Object getScopes()
      A list of scopes.

      Each scope is a map with keys ScopeName and ScopeDescription .

    • setScopes

      @Stability(Stable) public void setScopes(@Nullable IResolvable value)
      A list of scopes.

      Each scope is a map with keys ScopeName and ScopeDescription .

    • setScopes

      @Stability(Stable) public void setScopes(@Nullable List<Object> value)
      A list of scopes.

      Each scope is a map with keys ScopeName and ScopeDescription .