heroku.collaborator.Collaborator

A Heroku Collaborator receives access to a specific app that is not owned by a team.

IMPORTANT!: This resource only works for apps that are not part of a team.

Example Usage

resource "heroku_app" "foobar" {
  name = "foobar"
  region = "us"
}

# Create a new collaborator for the foobar application
resource "heroku_collaborator" "foobar-collaborator" {
	app_id = heroku_app.foobar.id
	email = "collaborator@foobar.com"
}

Create Collaborator Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Collaborator(name: string, args: CollaboratorArgs, opts?: CustomResourceOptions);

@overload
def Collaborator(resource_name: str,
                 args: CollaboratorArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Collaborator(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 app_id: Optional[str] = None,
                 email: Optional[str] = None)

func NewCollaborator(ctx *Context, name string, args CollaboratorArgs, opts ...ResourceOption) (*Collaborator, error)

public Collaborator(string name, CollaboratorArgs args, CustomResourceOptions? opts = null)

public Collaborator(String name, CollaboratorArgs args)
public Collaborator(String name, CollaboratorArgs args, CustomResourceOptions options)

type: heroku:collaborator:Collaborator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var collaboratorResource = new Heroku.Collaborator.Collaborator("collaboratorResource", new()
{
    AppId = "string",
    Email = "string",
});

example, err := collaborator.NewCollaborator(ctx, "collaboratorResource", &collaborator.CollaboratorArgs{
	AppId: pulumi.String("string"),
	Email: pulumi.String("string"),
})

var collaboratorResource = new com.pulumi.heroku.collaborator.Collaborator("collaboratorResource", com.pulumi.heroku.collaborator.CollaboratorArgs.builder()
    .appId("string")
    .email("string")
    .build());

collaborator_resource = heroku.collaborator.Collaborator("collaboratorResource",
    app_id="string",
    email="string")

const collaboratorResource = new heroku.collaborator.Collaborator("collaboratorResource", {
    appId: "string",
    email: "string",
});

type: heroku:collaborator:Collaborator
properties:
    appId: string
    email: string

Collaborator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Collaborator resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the Collaborator resource produces the following output properties:

Look up Existing Collaborator Resource

Get an existing Collaborator resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CollaboratorState, opts?: CustomResourceOptions): Collaborator

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        email: Optional[str] = None) -> Collaborator

func GetCollaborator(ctx *Context, name string, id IDInput, state *CollaboratorState, opts ...ResourceOption) (*Collaborator, error)

public static Collaborator Get(string name, Input<string> id, CollaboratorState? state, CustomResourceOptions? opts = null)

public static Collaborator get(String name, Output<String> id, CollaboratorState state, CustomResourceOptions options)

resources:  _:    type: heroku:collaborator:Collaborator    get:      id: ${id}

Import

Collaborators can be imported using the combination of the application name, a colon, and the collaborator’s email address

For example:

$ pulumi import heroku:collaborator/collaborator:Collaborator foobar-collaborator foobar_app:collaborator@foobar.com

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

heroku pulumiverse/pulumi-heroku

License

Apache-2.0

Notes

This Pulumi package is based on the heroku Terraform Provider.