pagerduty.User
Explore with Pulumi AI
A user is a member of a PagerDuty account that have the ability to interact with incidents and other data on the account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";
const example = new pagerduty.User("example", {
name: "Earline Greenholt",
email: "125.greenholt.earline@graham.name",
});
import pulumi
import pulumi_pagerduty as pagerduty
example = pagerduty.User("example",
name="Earline Greenholt",
email="125.greenholt.earline@graham.name")
package main
import (
"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := pagerduty.NewUser(ctx, "example", &pagerduty.UserArgs{
Name: pulumi.String("Earline Greenholt"),
Email: pulumi.String("125.greenholt.earline@graham.name"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;
return await Deployment.RunAsync(() =>
{
var example = new Pagerduty.User("example", new()
{
Name = "Earline Greenholt",
Email = "125.greenholt.earline@graham.name",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.User;
import com.pulumi.pagerduty.UserArgs;
import java.util.List;
import java.util.ArrayList;
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 example = new User("example", UserArgs.builder()
.name("Earline Greenholt")
.email("125.greenholt.earline@graham.name")
.build());
}
}
resources:
example:
type: pagerduty:User
properties:
name: Earline Greenholt
email: 125.greenholt.earline@graham.name
Create User Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
args: UserArgs,
opts: Optional[ResourceOptions] = None)
@overload
def User(resource_name: str,
opts: Optional[ResourceOptions] = None,
email: Optional[str] = None,
color: Optional[str] = None,
description: Optional[str] = None,
job_title: Optional[str] = None,
license: Optional[str] = None,
name: Optional[str] = None,
role: Optional[str] = None,
teams: Optional[Sequence[str]] = None,
time_zone: Optional[str] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
type: pagerduty:User
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 UserArgs
- 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 UserArgs
- 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 UserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var userResource = new Pagerduty.User("userResource", new()
{
Email = "string",
Color = "string",
Description = "string",
JobTitle = "string",
License = "string",
Name = "string",
Role = "string",
TimeZone = "string",
});
example, err := pagerduty.NewUser(ctx, "userResource", &pagerduty.UserArgs{
Email: pulumi.String("string"),
Color: pulumi.String("string"),
Description: pulumi.String("string"),
JobTitle: pulumi.String("string"),
License: pulumi.String("string"),
Name: pulumi.String("string"),
Role: pulumi.String("string"),
TimeZone: pulumi.String("string"),
})
var userResource = new User("userResource", UserArgs.builder()
.email("string")
.color("string")
.description("string")
.jobTitle("string")
.license("string")
.name("string")
.role("string")
.timeZone("string")
.build());
user_resource = pagerduty.User("userResource",
email="string",
color="string",
description="string",
job_title="string",
license="string",
name="string",
role="string",
time_zone="string")
const userResource = new pagerduty.User("userResource", {
email: "string",
color: "string",
description: "string",
jobTitle: "string",
license: "string",
name: "string",
role: "string",
timeZone: "string",
});
type: pagerduty:User
properties:
color: string
description: string
email: string
jobTitle: string
license: string
name: string
role: string
timeZone: string
User 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 User resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:
- Avatar
Url string - The URL of the user's avatar.
- Html
Url string - URL at which the entity is uniquely displayed in the Web app
- Id string
- The provider-assigned unique ID for this managed resource.
- Invitation
Sent bool - If true, the user has an outstanding invitation.
- Avatar
Url string - The URL of the user's avatar.
- Html
Url string - URL at which the entity is uniquely displayed in the Web app
- Id string
- The provider-assigned unique ID for this managed resource.
- Invitation
Sent bool - If true, the user has an outstanding invitation.
- avatar
Url String - The URL of the user's avatar.
- html
Url String - URL at which the entity is uniquely displayed in the Web app
- id String
- The provider-assigned unique ID for this managed resource.
- invitation
Sent Boolean - If true, the user has an outstanding invitation.
- avatar
Url string - The URL of the user's avatar.
- html
Url string - URL at which the entity is uniquely displayed in the Web app
- id string
- The provider-assigned unique ID for this managed resource.
- invitation
Sent boolean - If true, the user has an outstanding invitation.
- avatar_
url str - The URL of the user's avatar.
- html_
url str - URL at which the entity is uniquely displayed in the Web app
- id str
- The provider-assigned unique ID for this managed resource.
- invitation_
sent bool - If true, the user has an outstanding invitation.
- avatar
Url String - The URL of the user's avatar.
- html
Url String - URL at which the entity is uniquely displayed in the Web app
- id String
- The provider-assigned unique ID for this managed resource.
- invitation
Sent Boolean - If true, the user has an outstanding invitation.
Look up Existing User Resource
Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
avatar_url: Optional[str] = None,
color: Optional[str] = None,
description: Optional[str] = None,
email: Optional[str] = None,
html_url: Optional[str] = None,
invitation_sent: Optional[bool] = None,
job_title: Optional[str] = None,
license: Optional[str] = None,
name: Optional[str] = None,
role: Optional[str] = None,
teams: Optional[Sequence[str]] = None,
time_zone: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState 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.
- Avatar
Url string - The URL of the user's avatar.
- Color string
- Description string
- Email string
- Html
Url string - URL at which the entity is uniquely displayed in the Web app
- Invitation
Sent bool - If true, the user has an outstanding invitation.
- Job
Title string - License string
- Name string
- Role string
- Teams List<string>
- Time
Zone string - The timezone of the user.
- Avatar
Url string - The URL of the user's avatar.
- Color string
- Description string
- Email string
- Html
Url string - URL at which the entity is uniquely displayed in the Web app
- Invitation
Sent bool - If true, the user has an outstanding invitation.
- Job
Title string - License string
- Name string
- Role string
- Teams []string
- Time
Zone string - The timezone of the user.
- avatar
Url String - The URL of the user's avatar.
- color String
- description String
- email String
- html
Url String - URL at which the entity is uniquely displayed in the Web app
- invitation
Sent Boolean - If true, the user has an outstanding invitation.
- job
Title String - license String
- name String
- role String
- teams List<String>
- time
Zone String - The timezone of the user.
- avatar
Url string - The URL of the user's avatar.
- color string
- description string
- email string
- html
Url string - URL at which the entity is uniquely displayed in the Web app
- invitation
Sent boolean - If true, the user has an outstanding invitation.
- job
Title string - license string
- name string
- role string
- teams string[]
- time
Zone string - The timezone of the user.
- avatar_
url str - The URL of the user's avatar.
- color str
- description str
- email str
- html_
url str - URL at which the entity is uniquely displayed in the Web app
- invitation_
sent bool - If true, the user has an outstanding invitation.
- job_
title str - license str
- name str
- role str
- teams Sequence[str]
- time_
zone str - The timezone of the user.
- avatar
Url String - The URL of the user's avatar.
- color String
- description String
- email String
- html
Url String - URL at which the entity is uniquely displayed in the Web app
- invitation
Sent Boolean - If true, the user has an outstanding invitation.
- job
Title String - license String
- name String
- role String
- teams List<String>
- time
Zone String - The timezone of the user.
Import
Users can be imported using the id
, e.g.
$ pulumi import pagerduty:index/user:User main PLBP09X
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- PagerDuty pulumi/pulumi-pagerduty
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
pagerduty
Terraform Provider.