Docs Packages
  1. Packages
  2. Rootly
  3. API Docs
  4. Role
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.Role

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

    Create Role Resource

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

    Constructor syntax

    new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);
    @overload
def Role(resource_name: str,
         args: Optional[RoleArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         api_keys_permissions: Optional[Sequence[str]] = None,
         audits_permissions: Optional[Sequence[str]] = None,
         billing_permissions: Optional[Sequence[str]] = None,
         environments_permissions: Optional[Sequence[str]] = None,
         form_fields_permissions: Optional[Sequence[str]] = None,
         functionalities_permissions: Optional[Sequence[str]] = None,
         groups_permissions: Optional[Sequence[str]] = None,
         incident_causes_permissions: Optional[Sequence[str]] = None,
         incident_feedbacks_permissions: Optional[Sequence[str]] = None,
         incident_permission_set_id: Optional[str] = None,
         incident_roles_permissions: Optional[Sequence[str]] = None,
         incident_types_permissions: Optional[Sequence[str]] = None,
         incidents_permissions: Optional[Sequence[str]] = None,
         invitations_permissions: Optional[Sequence[str]] = None,
         is_deletable: Optional[bool] = None,
         is_editable: Optional[bool] = None,
         name: Optional[str] = None,
         playbooks_permissions: Optional[Sequence[str]] = None,
         private_incidents_permissions: Optional[Sequence[str]] = None,
         retrospective_permissions: Optional[Sequence[str]] = None,
         roles_permissions: Optional[Sequence[str]] = None,
         secrets_permissions: Optional[Sequence[str]] = None,
         services_permissions: Optional[Sequence[str]] = None,
         severities_permissions: Optional[Sequence[str]] = None,
         slug: Optional[str] = None,
         status_pages_permissions: Optional[Sequence[str]] = None,
         webhooks_permissions: Optional[Sequence[str]] = None,
         workflows_permissions: Optional[Sequence[str]] = None)
    func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

    type: rootly:Role
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 RoleArgs
    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 RoleArgs
    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 RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    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 roleResource = new Rootly.Role("roleResource", new()
{
    ApiKeysPermissions = new[]
    {
        "string",
    },
    AuditsPermissions = new[]
    {
        "string",
    },
    BillingPermissions = new[]
    {
        "string",
    },
    EnvironmentsPermissions = new[]
    {
        "string",
    },
    FormFieldsPermissions = new[]
    {
        "string",
    },
    FunctionalitiesPermissions = new[]
    {
        "string",
    },
    GroupsPermissions = new[]
    {
        "string",
    },
    IncidentCausesPermissions = new[]
    {
        "string",
    },
    IncidentFeedbacksPermissions = new[]
    {
        "string",
    },
    IncidentPermissionSetId = "string",
    IncidentRolesPermissions = new[]
    {
        "string",
    },
    IncidentTypesPermissions = new[]
    {
        "string",
    },
    IncidentsPermissions = new[]
    {
        "string",
    },
    InvitationsPermissions = new[]
    {
        "string",
    },
    IsDeletable = false,
    IsEditable = false,
    Name = "string",
    PlaybooksPermissions = new[]
    {
        "string",
    },
    PrivateIncidentsPermissions = new[]
    {
        "string",
    },
    RetrospectivePermissions = new[]
    {
        "string",
    },
    RolesPermissions = new[]
    {
        "string",
    },
    SecretsPermissions = new[]
    {
        "string",
    },
    ServicesPermissions = new[]
    {
        "string",
    },
    SeveritiesPermissions = new[]
    {
        "string",
    },
    Slug = "string",
    StatusPagesPermissions = new[]
    {
        "string",
    },
    WebhooksPermissions = new[]
    {
        "string",
    },
    WorkflowsPermissions = new[]
    {
        "string",
    },
});

    example, err := rootly.NewRole(ctx, "roleResource", &rootly.RoleArgs{
	ApiKeysPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuditsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	BillingPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnvironmentsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	FormFieldsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	FunctionalitiesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentCausesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentFeedbacksPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentPermissionSetId: pulumi.String("string"),
	IncidentRolesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentTypesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	InvitationsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsDeletable: pulumi.Bool(false),
	IsEditable:  pulumi.Bool(false),
	Name:        pulumi.String("string"),
	PlaybooksPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateIncidentsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetrospectivePermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	RolesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	SecretsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServicesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	SeveritiesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Slug: pulumi.String("string"),
	StatusPagesPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	WebhooksPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	WorkflowsPermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var roleResource = new Role("roleResource", RoleArgs.builder()        
    .apiKeysPermissions("string")
    .auditsPermissions("string")
    .billingPermissions("string")
    .environmentsPermissions("string")
    .formFieldsPermissions("string")
    .functionalitiesPermissions("string")
    .groupsPermissions("string")
    .incidentCausesPermissions("string")
    .incidentFeedbacksPermissions("string")
    .incidentPermissionSetId("string")
    .incidentRolesPermissions("string")
    .incidentTypesPermissions("string")
    .incidentsPermissions("string")
    .invitationsPermissions("string")
    .isDeletable(false)
    .isEditable(false)
    .name("string")
    .playbooksPermissions("string")
    .privateIncidentsPermissions("string")
    .retrospectivePermissions("string")
    .rolesPermissions("string")
    .secretsPermissions("string")
    .servicesPermissions("string")
    .severitiesPermissions("string")
    .slug("string")
    .statusPagesPermissions("string")
    .webhooksPermissions("string")
    .workflowsPermissions("string")
    .build());

    role_resource = rootly.Role("roleResource",
    api_keys_permissions=["string"],
    audits_permissions=["string"],
    billing_permissions=["string"],
    environments_permissions=["string"],
    form_fields_permissions=["string"],
    functionalities_permissions=["string"],
    groups_permissions=["string"],
    incident_causes_permissions=["string"],
    incident_feedbacks_permissions=["string"],
    incident_permission_set_id="string",
    incident_roles_permissions=["string"],
    incident_types_permissions=["string"],
    incidents_permissions=["string"],
    invitations_permissions=["string"],
    is_deletable=False,
    is_editable=False,
    name="string",
    playbooks_permissions=["string"],
    private_incidents_permissions=["string"],
    retrospective_permissions=["string"],
    roles_permissions=["string"],
    secrets_permissions=["string"],
    services_permissions=["string"],
    severities_permissions=["string"],
    slug="string",
    status_pages_permissions=["string"],
    webhooks_permissions=["string"],
    workflows_permissions=["string"])

    const roleResource = new rootly.Role("roleResource", {
    apiKeysPermissions: ["string"],
    auditsPermissions: ["string"],
    billingPermissions: ["string"],
    environmentsPermissions: ["string"],
    formFieldsPermissions: ["string"],
    functionalitiesPermissions: ["string"],
    groupsPermissions: ["string"],
    incidentCausesPermissions: ["string"],
    incidentFeedbacksPermissions: ["string"],
    incidentPermissionSetId: "string",
    incidentRolesPermissions: ["string"],
    incidentTypesPermissions: ["string"],
    incidentsPermissions: ["string"],
    invitationsPermissions: ["string"],
    isDeletable: false,
    isEditable: false,
    name: "string",
    playbooksPermissions: ["string"],
    privateIncidentsPermissions: ["string"],
    retrospectivePermissions: ["string"],
    rolesPermissions: ["string"],
    secretsPermissions: ["string"],
    servicesPermissions: ["string"],
    severitiesPermissions: ["string"],
    slug: "string",
    statusPagesPermissions: ["string"],
    webhooksPermissions: ["string"],
    workflowsPermissions: ["string"],
});

    type: rootly:Role
properties:
    apiKeysPermissions:
        - string
    auditsPermissions:
        - string
    billingPermissions:
        - string
    environmentsPermissions:
        - string
    formFieldsPermissions:
        - string
    functionalitiesPermissions:
        - string
    groupsPermissions:
        - string
    incidentCausesPermissions:
        - string
    incidentFeedbacksPermissions:
        - string
    incidentPermissionSetId: string
    incidentRolesPermissions:
        - string
    incidentTypesPermissions:
        - string
    incidentsPermissions:
        - string
    invitationsPermissions:
        - string
    isDeletable: false
    isEditable: false
    name: string
    playbooksPermissions:
        - string
    privateIncidentsPermissions:
        - string
    retrospectivePermissions:
        - string
    rolesPermissions:
        - string
    secretsPermissions:
        - string
    servicesPermissions:
        - string
    severitiesPermissions:
        - string
    slug: string
    statusPagesPermissions:
        - string
    webhooksPermissions:
        - string
    workflowsPermissions:
        - string

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

    ApiKeysPermissions List<string>
    Value must be one of create, read, update, delete.
    AuditsPermissions List<string>
    Value must be one of create, read, update, delete.
    BillingPermissions List<string>
    Value must be one of create, read, update, delete.
    EnvironmentsPermissions List<string>
    Value must be one of create, read, update, delete.
    FormFieldsPermissions List<string>
    Value must be one of create, read, update, delete.
    FunctionalitiesPermissions List<string>
    Value must be one of create, read, update, delete.
    GroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentCausesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentFeedbacksPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentPermissionSetId string
    Associated incident permissions set.
    IncidentRolesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentTypesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentsPermissions List<string>
    Value must be one of create, read, update, delete.
    InvitationsPermissions List<string>
    Value must be one of create, read, update, delete.
    IsDeletable bool
    Whether the role can be deleted.. Value must be one of true or false
    IsEditable bool
    Whether the role can be edited.. Value must be one of true or false
    Name string
    The role name.
    PlaybooksPermissions List<string>
    Value must be one of create, read, update, delete.
    PrivateIncidentsPermissions List<string>
    Value must be one of create, read, update, delete.
    RetrospectivePermissions List<string>
    Value must be one of create, read, update, delete.
    RolesPermissions List<string>
    Value must be one of create, read, update, delete.
    SecretsPermissions List<string>
    Value must be one of create, read, update, delete.
    ServicesPermissions List<string>
    Value must be one of create, read, update, delete.
    SeveritiesPermissions List<string>
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    StatusPagesPermissions List<string>
    Value must be one of create, read, update, delete.
    WebhooksPermissions List<string>
    Value must be one of create, read, update, delete.
    WorkflowsPermissions List<string>
    Value must be one of create, read, update, delete.
    ApiKeysPermissions []string
    Value must be one of create, read, update, delete.
    AuditsPermissions []string
    Value must be one of create, read, update, delete.
    BillingPermissions []string
    Value must be one of create, read, update, delete.
    EnvironmentsPermissions []string
    Value must be one of create, read, update, delete.
    FormFieldsPermissions []string
    Value must be one of create, read, update, delete.
    FunctionalitiesPermissions []string
    Value must be one of create, read, update, delete.
    GroupsPermissions []string
    Value must be one of create, read, update, delete.
    IncidentCausesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentFeedbacksPermissions []string
    Value must be one of create, read, update, delete.
    IncidentPermissionSetId string
    Associated incident permissions set.
    IncidentRolesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentTypesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentsPermissions []string
    Value must be one of create, read, update, delete.
    InvitationsPermissions []string
    Value must be one of create, read, update, delete.
    IsDeletable bool
    Whether the role can be deleted.. Value must be one of true or false
    IsEditable bool
    Whether the role can be edited.. Value must be one of true or false
    Name string
    The role name.
    PlaybooksPermissions []string
    Value must be one of create, read, update, delete.
    PrivateIncidentsPermissions []string
    Value must be one of create, read, update, delete.
    RetrospectivePermissions []string
    Value must be one of create, read, update, delete.
    RolesPermissions []string
    Value must be one of create, read, update, delete.
    SecretsPermissions []string
    Value must be one of create, read, update, delete.
    ServicesPermissions []string
    Value must be one of create, read, update, delete.
    SeveritiesPermissions []string
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    StatusPagesPermissions []string
    Value must be one of create, read, update, delete.
    WebhooksPermissions []string
    Value must be one of create, read, update, delete.
    WorkflowsPermissions []string
    Value must be one of create, read, update, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    billingPermissions List<String>
    Value must be one of create, read, update, delete.
    environmentsPermissions List<String>
    Value must be one of create, read, update, delete.
    formFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    functionalitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentCausesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentPermissionSetId String
    Associated incident permissions set.
    incidentRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentTypesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    isDeletable Boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable Boolean
    Whether the role can be edited.. Value must be one of true or false
    name String
    The role name.
    playbooksPermissions List<String>
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    retrospectivePermissions List<String>
    Value must be one of create, read, update, delete.
    rolesPermissions List<String>
    Value must be one of create, read, update, delete.
    secretsPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    severitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    statusPagesPermissions List<String>
    Value must be one of create, read, update, delete.
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.
    apiKeysPermissions string[]
    Value must be one of create, read, update, delete.
    auditsPermissions string[]
    Value must be one of create, read, update, delete.
    billingPermissions string[]
    Value must be one of create, read, update, delete.
    environmentsPermissions string[]
    Value must be one of create, read, update, delete.
    formFieldsPermissions string[]
    Value must be one of create, read, update, delete.
    functionalitiesPermissions string[]
    Value must be one of create, read, update, delete.
    groupsPermissions string[]
    Value must be one of create, read, update, delete.
    incidentCausesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions string[]
    Value must be one of create, read, update, delete.
    incidentPermissionSetId string
    Associated incident permissions set.
    incidentRolesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentTypesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentsPermissions string[]
    Value must be one of create, read, update, delete.
    invitationsPermissions string[]
    Value must be one of create, read, update, delete.
    isDeletable boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable boolean
    Whether the role can be edited.. Value must be one of true or false
    name string
    The role name.
    playbooksPermissions string[]
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions string[]
    Value must be one of create, read, update, delete.
    retrospectivePermissions string[]
    Value must be one of create, read, update, delete.
    rolesPermissions string[]
    Value must be one of create, read, update, delete.
    secretsPermissions string[]
    Value must be one of create, read, update, delete.
    servicesPermissions string[]
    Value must be one of create, read, update, delete.
    severitiesPermissions string[]
    Value must be one of create, read, update, delete.
    slug string
    The role slug.
    statusPagesPermissions string[]
    Value must be one of create, read, update, delete.
    webhooksPermissions string[]
    Value must be one of create, read, update, delete.
    workflowsPermissions string[]
    Value must be one of create, read, update, delete.
    api_keys_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    audits_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    billing_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    environments_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    form_fields_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    functionalities_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_causes_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_feedbacks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_permission_set_id str
    Associated incident permissions set.
    incident_roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_types_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incidents_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    invitations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    is_deletable bool
    Whether the role can be deleted.. Value must be one of true or false
    is_editable bool
    Whether the role can be edited.. Value must be one of true or false
    name str
    The role name.
    playbooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    private_incidents_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    retrospective_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    secrets_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    services_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    severities_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    slug str
    The role slug.
    status_pages_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    webhooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    workflows_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    billingPermissions List<String>
    Value must be one of create, read, update, delete.
    environmentsPermissions List<String>
    Value must be one of create, read, update, delete.
    formFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    functionalitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentCausesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentPermissionSetId String
    Associated incident permissions set.
    incidentRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentTypesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    isDeletable Boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable Boolean
    Whether the role can be edited.. Value must be one of true or false
    name String
    The role name.
    playbooksPermissions List<String>
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    retrospectivePermissions List<String>
    Value must be one of create, read, update, delete.
    rolesPermissions List<String>
    Value must be one of create, read, update, delete.
    secretsPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    severitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    statusPagesPermissions List<String>
    Value must be one of create, read, update, delete.
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Role 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 Role Resource

    Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_keys_permissions: Optional[Sequence[str]] = None,
        audits_permissions: Optional[Sequence[str]] = None,
        billing_permissions: Optional[Sequence[str]] = None,
        environments_permissions: Optional[Sequence[str]] = None,
        form_fields_permissions: Optional[Sequence[str]] = None,
        functionalities_permissions: Optional[Sequence[str]] = None,
        groups_permissions: Optional[Sequence[str]] = None,
        incident_causes_permissions: Optional[Sequence[str]] = None,
        incident_feedbacks_permissions: Optional[Sequence[str]] = None,
        incident_permission_set_id: Optional[str] = None,
        incident_roles_permissions: Optional[Sequence[str]] = None,
        incident_types_permissions: Optional[Sequence[str]] = None,
        incidents_permissions: Optional[Sequence[str]] = None,
        invitations_permissions: Optional[Sequence[str]] = None,
        is_deletable: Optional[bool] = None,
        is_editable: Optional[bool] = None,
        name: Optional[str] = None,
        playbooks_permissions: Optional[Sequence[str]] = None,
        private_incidents_permissions: Optional[Sequence[str]] = None,
        retrospective_permissions: Optional[Sequence[str]] = None,
        roles_permissions: Optional[Sequence[str]] = None,
        secrets_permissions: Optional[Sequence[str]] = None,
        services_permissions: Optional[Sequence[str]] = None,
        severities_permissions: Optional[Sequence[str]] = None,
        slug: Optional[str] = None,
        status_pages_permissions: Optional[Sequence[str]] = None,
        webhooks_permissions: Optional[Sequence[str]] = None,
        workflows_permissions: Optional[Sequence[str]] = None) -> Role
    func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
    public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
    public static Role get(String name, Output<String> id, RoleState 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:
    ApiKeysPermissions List<string>
    Value must be one of create, read, update, delete.
    AuditsPermissions List<string>
    Value must be one of create, read, update, delete.
    BillingPermissions List<string>
    Value must be one of create, read, update, delete.
    EnvironmentsPermissions List<string>
    Value must be one of create, read, update, delete.
    FormFieldsPermissions List<string>
    Value must be one of create, read, update, delete.
    FunctionalitiesPermissions List<string>
    Value must be one of create, read, update, delete.
    GroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentCausesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentFeedbacksPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentPermissionSetId string
    Associated incident permissions set.
    IncidentRolesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentTypesPermissions List<string>
    Value must be one of create, read, update, delete.
    IncidentsPermissions List<string>
    Value must be one of create, read, update, delete.
    InvitationsPermissions List<string>
    Value must be one of create, read, update, delete.
    IsDeletable bool
    Whether the role can be deleted.. Value must be one of true or false
    IsEditable bool
    Whether the role can be edited.. Value must be one of true or false
    Name string
    The role name.
    PlaybooksPermissions List<string>
    Value must be one of create, read, update, delete.
    PrivateIncidentsPermissions List<string>
    Value must be one of create, read, update, delete.
    RetrospectivePermissions List<string>
    Value must be one of create, read, update, delete.
    RolesPermissions List<string>
    Value must be one of create, read, update, delete.
    SecretsPermissions List<string>
    Value must be one of create, read, update, delete.
    ServicesPermissions List<string>
    Value must be one of create, read, update, delete.
    SeveritiesPermissions List<string>
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    StatusPagesPermissions List<string>
    Value must be one of create, read, update, delete.
    WebhooksPermissions List<string>
    Value must be one of create, read, update, delete.
    WorkflowsPermissions List<string>
    Value must be one of create, read, update, delete.
    ApiKeysPermissions []string
    Value must be one of create, read, update, delete.
    AuditsPermissions []string
    Value must be one of create, read, update, delete.
    BillingPermissions []string
    Value must be one of create, read, update, delete.
    EnvironmentsPermissions []string
    Value must be one of create, read, update, delete.
    FormFieldsPermissions []string
    Value must be one of create, read, update, delete.
    FunctionalitiesPermissions []string
    Value must be one of create, read, update, delete.
    GroupsPermissions []string
    Value must be one of create, read, update, delete.
    IncidentCausesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentFeedbacksPermissions []string
    Value must be one of create, read, update, delete.
    IncidentPermissionSetId string
    Associated incident permissions set.
    IncidentRolesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentTypesPermissions []string
    Value must be one of create, read, update, delete.
    IncidentsPermissions []string
    Value must be one of create, read, update, delete.
    InvitationsPermissions []string
    Value must be one of create, read, update, delete.
    IsDeletable bool
    Whether the role can be deleted.. Value must be one of true or false
    IsEditable bool
    Whether the role can be edited.. Value must be one of true or false
    Name string
    The role name.
    PlaybooksPermissions []string
    Value must be one of create, read, update, delete.
    PrivateIncidentsPermissions []string
    Value must be one of create, read, update, delete.
    RetrospectivePermissions []string
    Value must be one of create, read, update, delete.
    RolesPermissions []string
    Value must be one of create, read, update, delete.
    SecretsPermissions []string
    Value must be one of create, read, update, delete.
    ServicesPermissions []string
    Value must be one of create, read, update, delete.
    SeveritiesPermissions []string
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    StatusPagesPermissions []string
    Value must be one of create, read, update, delete.
    WebhooksPermissions []string
    Value must be one of create, read, update, delete.
    WorkflowsPermissions []string
    Value must be one of create, read, update, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    billingPermissions List<String>
    Value must be one of create, read, update, delete.
    environmentsPermissions List<String>
    Value must be one of create, read, update, delete.
    formFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    functionalitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentCausesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentPermissionSetId String
    Associated incident permissions set.
    incidentRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentTypesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    isDeletable Boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable Boolean
    Whether the role can be edited.. Value must be one of true or false
    name String
    The role name.
    playbooksPermissions List<String>
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    retrospectivePermissions List<String>
    Value must be one of create, read, update, delete.
    rolesPermissions List<String>
    Value must be one of create, read, update, delete.
    secretsPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    severitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    statusPagesPermissions List<String>
    Value must be one of create, read, update, delete.
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.
    apiKeysPermissions string[]
    Value must be one of create, read, update, delete.
    auditsPermissions string[]
    Value must be one of create, read, update, delete.
    billingPermissions string[]
    Value must be one of create, read, update, delete.
    environmentsPermissions string[]
    Value must be one of create, read, update, delete.
    formFieldsPermissions string[]
    Value must be one of create, read, update, delete.
    functionalitiesPermissions string[]
    Value must be one of create, read, update, delete.
    groupsPermissions string[]
    Value must be one of create, read, update, delete.
    incidentCausesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions string[]
    Value must be one of create, read, update, delete.
    incidentPermissionSetId string
    Associated incident permissions set.
    incidentRolesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentTypesPermissions string[]
    Value must be one of create, read, update, delete.
    incidentsPermissions string[]
    Value must be one of create, read, update, delete.
    invitationsPermissions string[]
    Value must be one of create, read, update, delete.
    isDeletable boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable boolean
    Whether the role can be edited.. Value must be one of true or false
    name string
    The role name.
    playbooksPermissions string[]
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions string[]
    Value must be one of create, read, update, delete.
    retrospectivePermissions string[]
    Value must be one of create, read, update, delete.
    rolesPermissions string[]
    Value must be one of create, read, update, delete.
    secretsPermissions string[]
    Value must be one of create, read, update, delete.
    servicesPermissions string[]
    Value must be one of create, read, update, delete.
    severitiesPermissions string[]
    Value must be one of create, read, update, delete.
    slug string
    The role slug.
    statusPagesPermissions string[]
    Value must be one of create, read, update, delete.
    webhooksPermissions string[]
    Value must be one of create, read, update, delete.
    workflowsPermissions string[]
    Value must be one of create, read, update, delete.
    api_keys_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    audits_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    billing_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    environments_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    form_fields_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    functionalities_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_causes_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_feedbacks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_permission_set_id str
    Associated incident permissions set.
    incident_roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incident_types_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    incidents_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    invitations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    is_deletable bool
    Whether the role can be deleted.. Value must be one of true or false
    is_editable bool
    Whether the role can be edited.. Value must be one of true or false
    name str
    The role name.
    playbooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    private_incidents_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    retrospective_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    secrets_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    services_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    severities_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    slug str
    The role slug.
    status_pages_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    webhooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    workflows_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    billingPermissions List<String>
    Value must be one of create, read, update, delete.
    environmentsPermissions List<String>
    Value must be one of create, read, update, delete.
    formFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    functionalitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentCausesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentFeedbacksPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentPermissionSetId String
    Associated incident permissions set.
    incidentRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentTypesPermissions List<String>
    Value must be one of create, read, update, delete.
    incidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    isDeletable Boolean
    Whether the role can be deleted.. Value must be one of true or false
    isEditable Boolean
    Whether the role can be edited.. Value must be one of true or false
    name String
    The role name.
    playbooksPermissions List<String>
    Value must be one of create, read, update, delete.
    privateIncidentsPermissions List<String>
    Value must be one of create, read, update, delete.
    retrospectivePermissions List<String>
    Value must be one of create, read, update, delete.
    rolesPermissions List<String>
    Value must be one of create, read, update, delete.
    secretsPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    severitiesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    statusPagesPermissions List<String>
    Value must be one of create, read, update, delete.
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
    rootlyhq/pulumi-rootly