Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Heroku
  3. API Docs
  4. team
  5. Collaborator
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

heroku.team.Collaborator

Explore with Pulumi AI

heroku logo
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

    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,
                 permissions: Optional[Sequence[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:team:Collaborator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CollaboratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CollaboratorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CollaboratorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollaboratorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollaboratorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var herokuCollaboratorResource = new Heroku.Team.Collaborator("herokuCollaboratorResource", new()
{
    AppId = "string",
    Email = "string",
    Permissions = new[]
    {
        "string",
    },
});

    example, err := team.NewCollaborator(ctx, "herokuCollaboratorResource", &team.CollaboratorArgs{
	AppId: pulumi.String("string"),
	Email: pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var herokuCollaboratorResource = new Collaborator("herokuCollaboratorResource", CollaboratorArgs.builder()
    .appId("string")
    .email("string")
    .permissions("string")
    .build());

    heroku_collaborator_resource = heroku.team.Collaborator("herokuCollaboratorResource",
    app_id="string",
    email="string",
    permissions=["string"])

    const herokuCollaboratorResource = new heroku.team.Collaborator("herokuCollaboratorResource", {
    appId: "string",
    email: "string",
    permissions: ["string"],
});

    type: heroku:team:Collaborator
properties:
    appId: string
    email: string
    permissions:
        - 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Collaborator resource accepts the following input properties:

    AppId string
    Email string
    Permissions List<string>
    AppId string
    Email string
    Permissions []string
    appId String
    email String
    permissions List<String>
    appId string
    email string
    permissions string[]
    app_id str
    email str
    permissions Sequence[str]
    appId String
    email String
    permissions List<String>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        permissions: Optional[Sequence[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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppId string
    Email string
    Permissions List<string>
    AppId string
    Email string
    Permissions []string
    appId String
    email String
    permissions List<String>
    appId string
    email string
    permissions string[]
    app_id str
    email str
    permissions Sequence[str]
    appId String
    email String
    permissions List<String>

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns
    pulumiverse/pulumi-heroku