heroku.team.Member
Explore with Pulumi AI
A Heroku Team Member receives access to everything owned by the Team.
To create a Heroku Team, use the New Team feature of Heroku Dashboard. For Heroku Enterprise accounts, new Teams may be created within the account by users with the right permissions.
A Heroku “team” was originally called an “organization”, and that is still the identifier used elsewhere in this provider. For heroku.app.App
& heroku.space.Space
resources, set the Heroku Team name as the “organization”.
Example Usage
# Adds a Heroku user to a Heroku team as a viewer.
resource "heroku_team_member" "foobar-member" {
team = "my-team"
email = "some-user@example.com"
role = "member"
}
Create Member Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Member(name: string, args: MemberArgs, opts?: CustomResourceOptions);
@overload
def Member(resource_name: str,
args: MemberArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Member(resource_name: str,
opts: Optional[ResourceOptions] = None,
email: Optional[str] = None,
role: Optional[str] = None,
team: Optional[str] = None,
federated: Optional[bool] = None)
func NewMember(ctx *Context, name string, args MemberArgs, opts ...ResourceOption) (*Member, error)
public Member(string name, MemberArgs args, CustomResourceOptions? opts = null)
public Member(String name, MemberArgs args)
public Member(String name, MemberArgs args, CustomResourceOptions options)
type: heroku:team:Member
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 MemberArgs
- 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 MemberArgs
- 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 MemberArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MemberArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MemberArgs
- 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 memberResource = new Heroku.Team.Member("memberResource", new()
{
Email = "string",
Role = "string",
Team = "string",
Federated = false,
});
example, err := team.NewMember(ctx, "memberResource", &team.MemberArgs{
Email: pulumi.String("string"),
Role: pulumi.String("string"),
Team: pulumi.String("string"),
Federated: pulumi.Bool(false),
})
var memberResource = new Member("memberResource", MemberArgs.builder()
.email("string")
.role("string")
.team("string")
.federated(false)
.build());
member_resource = heroku.team.Member("memberResource",
email="string",
role="string",
team="string",
federated=False)
const memberResource = new heroku.team.Member("memberResource", {
email: "string",
role: "string",
team: "string",
federated: false,
});
type: heroku:team:Member
properties:
email: string
federated: false
role: string
team: string
Member 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 Member resource accepts the following input properties:
- Email string
- Email address of the member
- Role string
- The role to assign the member. See the API docs for available options.
- Team string
- The name of the Heroku Team.
- Federated bool
- Email string
- Email address of the member
- Role string
- The role to assign the member. See the API docs for available options.
- Team string
- The name of the Heroku Team.
- Federated bool
- email String
- Email address of the member
- role String
- The role to assign the member. See the API docs for available options.
- team String
- The name of the Heroku Team.
- federated Boolean
- email string
- Email address of the member
- role string
- The role to assign the member. See the API docs for available options.
- team string
- The name of the Heroku Team.
- federated boolean
- email str
- Email address of the member
- role str
- The role to assign the member. See the API docs for available options.
- team str
- The name of the Heroku Team.
- federated bool
- email String
- Email address of the member
- role String
- The role to assign the member. See the API docs for available options.
- team String
- The name of the Heroku Team.
- federated Boolean
Outputs
All input properties are implicitly available as output properties. Additionally, the Member 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 Member Resource
Get an existing Member 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?: MemberState, opts?: CustomResourceOptions): Member
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
email: Optional[str] = None,
federated: Optional[bool] = None,
role: Optional[str] = None,
team: Optional[str] = None) -> Member
func GetMember(ctx *Context, name string, id IDInput, state *MemberState, opts ...ResourceOption) (*Member, error)
public static Member Get(string name, Input<string> id, MemberState? state, CustomResourceOptions? opts = null)
public static Member get(String name, Output<String> id, MemberState state, CustomResourceOptions options)
resources: _: type: heroku:team:Member get: id: ${id}
- 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.
- Email string
- Email address of the member
- Federated bool
- Role string
- The role to assign the member. See the API docs for available options.
- Team string
- The name of the Heroku Team.
- Email string
- Email address of the member
- Federated bool
- Role string
- The role to assign the member. See the API docs for available options.
- Team string
- The name of the Heroku Team.
- email String
- Email address of the member
- federated Boolean
- role String
- The role to assign the member. See the API docs for available options.
- team String
- The name of the Heroku Team.
- email string
- Email address of the member
- federated boolean
- role string
- The role to assign the member. See the API docs for available options.
- team string
- The name of the Heroku Team.
- email str
- Email address of the member
- federated bool
- role str
- The role to assign the member. See the API docs for available options.
- team str
- The name of the Heroku Team.
- email String
- Email address of the member
- federated Boolean
- role String
- The role to assign the member. See the API docs for available options.
- team String
- The name of the Heroku Team.
Import
Team members can be imported using the combination of the team application name, a colon, and the member’s email address.
$ pulumi import heroku:team/member:Member foobar-member my-team-foobar:some-user@example.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.