ResourceServer class

Provides a Cognito Resource Server.

Example Usage

Create a basic resource server

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const pool = new aws.cognito.UserPool("pool", {name: "pool"});
const resource = new aws.cognito.ResourceServer("resource", {
    identifier: "https://example.com",
    name: "example",
    userPoolId: pool.id,
});
import pulumi
import pulumi_aws as aws

pool = aws.cognito.UserPool("pool", name="pool")
resource = aws.cognito.ResourceServer("resource",
    identifier="https://example.com",
    name="example",
    user_pool_id=pool.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var pool = new Aws.Cognito.UserPool("pool", new()
    {
        Name = "pool",
    });

    var resource = new Aws.Cognito.ResourceServer("resource", new()
    {
        Identifier = "https://example.com",
        Name = "example",
        UserPoolId = pool.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", &cognito.UserPoolArgs{
			Name: pulumi.String("pool"),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewResourceServer(ctx, "resource", &cognito.ResourceServerArgs{
			Identifier: pulumi.String("https://example.com"),
			Name:       pulumi.String("example"),
			UserPoolId: pool.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cognito_userpool" "pool" {
  name = "pool"
}
resource "aws_cognito_resourceserver" "resource" {
  identifier   = "https://example.com"
  name         = "example"
  user_pool_id = aws_cognito_userpool.pool.id
}
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());

    }
}
resources:
  pool:
    type: aws:cognito:UserPool
    properties:
      name: pool
  resource:
    type: aws:cognito:ResourceServer
    properties:
      identifier: https://example.com
      name: example
      userPoolId: ${pool.id}

Create a resource server with sample-scope

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const pool = new aws.cognito.UserPool("pool", {name: "pool"});
const resource = new aws.cognito.ResourceServer("resource", {
    scopes: [{
        scopeName: "sample-scope",
        scopeDescription: "a Sample Scope Description",
    }],
    identifier: "https://example.com",
    name: "example",
    userPoolId: pool.id,
});
import pulumi
import pulumi_aws as aws

pool = aws.cognito.UserPool("pool", name="pool")
resource = aws.cognito.ResourceServer("resource",
    scopes=[{
        "scope_name": "sample-scope",
        "scope_description": "a Sample Scope Description",
    }],
    identifier="https://example.com",
    name="example",
    user_pool_id=pool.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var pool = new Aws.Cognito.UserPool("pool", new()
    {
        Name = "pool",
    });

    var resource = new Aws.Cognito.ResourceServer("resource", new()
    {
        Scopes = new[]
        {
            new Aws.Cognito.Inputs.ResourceServerScopeArgs
            {
                ScopeName = "sample-scope",
                ScopeDescription = "a Sample Scope Description",
            },
        },
        Identifier = "https://example.com",
        Name = "example",
        UserPoolId = pool.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cognito"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := cognito.NewUserPool(ctx, "pool", &cognito.UserPoolArgs{
			Name: pulumi.String("pool"),
		})
		if err != nil {
			return err
		}
		_, err = cognito.NewResourceServer(ctx, "resource", &cognito.ResourceServerArgs{
			Scopes: cognito.ResourceServerScopeArray{
				&cognito.ResourceServerScopeArgs{
					ScopeName:        pulumi.String("sample-scope"),
					ScopeDescription: pulumi.String("a Sample Scope Description"),
				},
			},
			Identifier: pulumi.String("https://example.com"),
			Name:       pulumi.String("example"),
			UserPoolId: pool.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_cognito_userpool" "pool" {
  name = "pool"
}
resource "aws_cognito_resourceserver" "resource" {
  scopes {
    scope_name        = "sample-scope"
    scope_description = "a Sample Scope Description"
  }
  identifier   = "https://example.com"
  name         = "example"
  user_pool_id = aws_cognito_userpool.pool.id
}
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());

    }
}
resources:
  pool:
    type: aws:cognito:UserPool
    properties:
      name: pool
  resource:
    type: aws:cognito:ResourceServer
    properties:
      scopes:
        - scopeName: sample-scope
          scopeDescription: a Sample Scope Description
      identifier: https://example.com
      name: example
      userPoolId: ${pool.id}

Import

Using pulumi import, import aws.cognito.ResourceServer using their User Pool ID and Identifier. For example:

$ pulumi import aws:cognito/resourceServer:ResourceServer example "us-west-2_abc123|https://example.com"

Constructors

ResourceServer(String name, {ResourceServerArgs? args, CustomResourceOptions? options})
Creates a new ResourceServer. name The Pulumi resource name. args Arguments used to configure this ResourceServer. The set of arguments for ResourceServer. options Resource options controlling this resource's behavior.
ResourceServer.reference(String urn)
Creates a typed reference to an existing ResourceServer resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
identifier ↔ Output<String>
An identifier for the resource server.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
A name for the resource server.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeIdentifiers ↔ Output<List<String>>
A list of all scopes configured for this resource server in the format identifier/scope_name.
latefinal
scopes ↔ Output<List<ResourceServerScope>?>
A list of Authorization Scope.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
userPoolId ↔ Output<String>
User pool the client belongs to.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ResourceServerState? state, CustomResourceOptions? options}) → ResourceServer
Gets an existing ResourceServer resource's state with the given name and id.