heroku.space.AppAccess

Provides a resource for managing permissions for the entire Private Space. Members with the admin role will always have full permissions in the Private Space, so using this resource on an admin will have no effect. The provided email must already be a member of the Heroku Team. Currently, the only supported permission is create_apps.

Example Usage

// Create a new Heroku Private Space
resource "heroku_space" "default" {
  name = "test-space"
  organization = "my-company"
  region = "virginia"
}

// Give an existing team member create_apps permissions to the Private Space
resource "heroku_space_app_access" "member1" {
  space = heroku_space.default.id
  email = "member1@example.com"
  permissions = ["create_apps"]
}

// Remove all permissions from an existing team member
resource "heroku_space_app_access" "member2" {
  space = heroku_space.default.id
  email = "member2@example.com"
  permissions = []
}

Create AppAccess Resource

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

Constructor syntax

new AppAccess(name: string, args: AppAccessArgs, opts?: CustomResourceOptions);

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

@overload
def AppAccess(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              email: Optional[str] = None,
              permissions: Optional[Sequence[str]] = None,
              space: Optional[str] = None)

func NewAppAccess(ctx *Context, name string, args AppAccessArgs, opts ...ResourceOption) (*AppAccess, error)

public AppAccess(string name, AppAccessArgs args, CustomResourceOptions? opts = null)

public AppAccess(String name, AppAccessArgs args)
public AppAccess(String name, AppAccessArgs args, CustomResourceOptions options)

type: heroku:space:AppAccess
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 appAccessResource = new Heroku.Space.AppAccess("appAccessResource", new()
{
    Email = "string",
    Permissions = new[]
    {
        "string",
    },
    Space = "string",
});

example, err := space.NewAppAccess(ctx, "appAccessResource", &space.AppAccessArgs{
	Email: pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Space: pulumi.String("string"),
})

var appAccessResource = new AppAccess("appAccessResource", AppAccessArgs.builder()
    .email("string")
    .permissions("string")
    .space("string")
    .build());

app_access_resource = heroku.space.AppAccess("appAccessResource",
    email="string",
    permissions=["string"],
    space="string")

const appAccessResource = new heroku.space.AppAccess("appAccessResource", {
    email: "string",
    permissions: ["string"],
    space: "string",
});

type: heroku:space:AppAccess
properties:
    email: string
    permissions:
        - string
    space: string

AppAccess 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 AppAccess resource accepts the following input properties:

Outputs

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

Look up Existing AppAccess Resource

Get an existing AppAccess 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?: AppAccessState, opts?: CustomResourceOptions): AppAccess

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        space: Optional[str] = None) -> AppAccess

func GetAppAccess(ctx *Context, name string, id IDInput, state *AppAccessState, opts ...ResourceOption) (*AppAccess, error)

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

public static AppAccess get(String name, Output<String> id, AppAccessState state, CustomResourceOptions options)

resources:  _:    type: heroku:space:AppAccess    get:      id: ${id}

Import

ing

Existing permissions can be imported using the combination of the Private Space name, a colon, and the member email.

For example:

$ terraform import heroku_space_app_access.member1 my-space:member1@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.