Package com.pulumi.aws.cognito

Class ResourceServer

  • public class ResourceServer
extends com.pulumi.resources.CustomResource
    Provides a Cognito Resource Server. ## Example Usage ### Create a basic resource server 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.UserPool;
 import com.pulumi.aws.cognito.UserPoolArgs;
 import com.pulumi.aws.cognito.ResourceServer;
 import com.pulumi.aws.cognito.ResourceServerArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var pool = new UserPool("pool", UserPoolArgs.builder()
             .name("pool")
             .build());
 
         var resource = new ResourceServer("resource", ResourceServerArgs.builder()
             .identifier("https://example.com")
             .name("example")
             .userPoolId(pool.id())
             .build());
 
     }
 }
    ### Create a resource server with sample-scope 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.UserPool;
 import com.pulumi.aws.cognito.UserPoolArgs;
 import com.pulumi.aws.cognito.ResourceServer;
 import com.pulumi.aws.cognito.ResourceServerArgs;
 import com.pulumi.aws.cognito.inputs.ResourceServerScopeArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var pool = new UserPool("pool", UserPoolArgs.builder()
             .name("pool")
             .build());
 
         var resource = new ResourceServer("resource", ResourceServerArgs.builder()
             .scopes(ResourceServerScopeArgs.builder()
                 .scopeName("sample-scope")
                 .scopeDescription("a Sample Scope Description")
                 .build())
             .identifier("https://example.com")
             .name("example")
             .userPoolId(pool.id())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.cognito.ResourceServer` using their User Pool ID and Identifier. For example: ```sh $ pulumi import aws:cognito/resourceServer:ResourceServer example "us-west-2_abc123|https://example.com" ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ResourceServer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResourceServerState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> identifier()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> scopeIdentifiers()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<ResourceServerScope>>> scopes()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ResourceServer

        public ResourceServer​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ResourceServer

        public ResourceServer​(java.lang.String name,
                      ResourceServerArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ResourceServer

        public ResourceServer​(java.lang.String name,
                      ResourceServerArgs args,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • identifier

        public com.pulumi.core.Output<java.lang.String> identifier()
        Returns:
        An identifier for the resource server.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        A name for the resource server.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • scopeIdentifiers

        public com.pulumi.core.Output<java.util.List<java.lang.String>> scopeIdentifiers()
        Returns:
        A list of all scopes configured for this resource server in the format identifier/scope_name.

      • scopes

        public com.pulumi.core.Output<java.util.Optional<java.util.List<ResourceServerScope>>> scopes()
        Returns:
        A list of Authorization Scope.

      • userPoolId

        public com.pulumi.core.Output<java.lang.String> userPoolId()
        Returns:
        User pool the client belongs to.

      • get

        public static ResourceServer get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 ResourceServerState state,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.