1. Packages
  2. Rootly
  3. API Docs
  4. Authorization
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly

rootly.Authorization

Explore with Pulumi AI

rootly logo
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly

    Create Authorization Resource

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

    Constructor syntax

    new Authorization(name: string, args: AuthorizationArgs, opts?: CustomResourceOptions);
    @overload
    def Authorization(resource_name: str,
                      args: AuthorizationArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def Authorization(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      authorizable_id: Optional[str] = None,
                      grantee_id: Optional[str] = None,
                      permissions: Optional[Sequence[str]] = None,
                      authorizable_type: Optional[str] = None,
                      grantee_type: Optional[str] = None)
    func NewAuthorization(ctx *Context, name string, args AuthorizationArgs, opts ...ResourceOption) (*Authorization, error)
    public Authorization(string name, AuthorizationArgs args, CustomResourceOptions? opts = null)
    public Authorization(String name, AuthorizationArgs args)
    public Authorization(String name, AuthorizationArgs args, CustomResourceOptions options)
    
    type: rootly:Authorization
    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 AuthorizationArgs
    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 AuthorizationArgs
    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 AuthorizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthorizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthorizationArgs
    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 authorizationResource = new Rootly.Authorization("authorizationResource", new()
    {
        AuthorizableId = "string",
        GranteeId = "string",
        Permissions = new[]
        {
            "string",
        },
        AuthorizableType = "string",
        GranteeType = "string",
    });
    
    example, err := rootly.NewAuthorization(ctx, "authorizationResource", &rootly.AuthorizationArgs{
    	AuthorizableId: pulumi.String("string"),
    	GranteeId:      pulumi.String("string"),
    	Permissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuthorizableType: pulumi.String("string"),
    	GranteeType:      pulumi.String("string"),
    })
    
    var authorizationResource = new Authorization("authorizationResource", AuthorizationArgs.builder()        
        .authorizableId("string")
        .granteeId("string")
        .permissions("string")
        .authorizableType("string")
        .granteeType("string")
        .build());
    
    authorization_resource = rootly.Authorization("authorizationResource",
        authorizable_id="string",
        grantee_id="string",
        permissions=["string"],
        authorizable_type="string",
        grantee_type="string")
    
    const authorizationResource = new rootly.Authorization("authorizationResource", {
        authorizableId: "string",
        granteeId: "string",
        permissions: ["string"],
        authorizableType: "string",
        granteeType: "string",
    });
    
    type: rootly:Authorization
    properties:
        authorizableId: string
        authorizableType: string
        granteeId: string
        granteeType: string
        permissions:
            - string
    

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

    AuthorizableId string
    The id of the resource being accessed.
    GranteeId string
    The resource id granted access.
    Permissions List<string>
    Value must be one of read, update, authorize, destroy.
    AuthorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    GranteeType string
    The type of resource granted access.. Value must be one of User, Team.
    AuthorizableId string
    The id of the resource being accessed.
    GranteeId string
    The resource id granted access.
    Permissions []string
    Value must be one of read, update, authorize, destroy.
    AuthorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    GranteeType string
    The type of resource granted access.. Value must be one of User, Team.
    authorizableId String
    The id of the resource being accessed.
    granteeId String
    The resource id granted access.
    permissions List<String>
    Value must be one of read, update, authorize, destroy.
    authorizableType String
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeType String
    The type of resource granted access.. Value must be one of User, Team.
    authorizableId string
    The id of the resource being accessed.
    granteeId string
    The resource id granted access.
    permissions string[]
    Value must be one of read, update, authorize, destroy.
    authorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeType string
    The type of resource granted access.. Value must be one of User, Team.
    authorizable_id str
    The id of the resource being accessed.
    grantee_id str
    The resource id granted access.
    permissions Sequence[str]
    Value must be one of read, update, authorize, destroy.
    authorizable_type str
    The type of resource being accessed.. Value must be one of Dashboard.
    grantee_type str
    The type of resource granted access.. Value must be one of User, Team.
    authorizableId String
    The id of the resource being accessed.
    granteeId String
    The resource id granted access.
    permissions List<String>
    Value must be one of read, update, authorize, destroy.
    authorizableType String
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeType String
    The type of resource granted access.. Value must be one of User, Team.

    Outputs

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

    Get an existing Authorization 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?: AuthorizationState, opts?: CustomResourceOptions): Authorization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorizable_id: Optional[str] = None,
            authorizable_type: Optional[str] = None,
            grantee_id: Optional[str] = None,
            grantee_type: Optional[str] = None,
            permissions: Optional[Sequence[str]] = None) -> Authorization
    func GetAuthorization(ctx *Context, name string, id IDInput, state *AuthorizationState, opts ...ResourceOption) (*Authorization, error)
    public static Authorization Get(string name, Input<string> id, AuthorizationState? state, CustomResourceOptions? opts = null)
    public static Authorization get(String name, Output<String> id, AuthorizationState 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:
    AuthorizableId string
    The id of the resource being accessed.
    AuthorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    GranteeId string
    The resource id granted access.
    GranteeType string
    The type of resource granted access.. Value must be one of User, Team.
    Permissions List<string>
    Value must be one of read, update, authorize, destroy.
    AuthorizableId string
    The id of the resource being accessed.
    AuthorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    GranteeId string
    The resource id granted access.
    GranteeType string
    The type of resource granted access.. Value must be one of User, Team.
    Permissions []string
    Value must be one of read, update, authorize, destroy.
    authorizableId String
    The id of the resource being accessed.
    authorizableType String
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeId String
    The resource id granted access.
    granteeType String
    The type of resource granted access.. Value must be one of User, Team.
    permissions List<String>
    Value must be one of read, update, authorize, destroy.
    authorizableId string
    The id of the resource being accessed.
    authorizableType string
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeId string
    The resource id granted access.
    granteeType string
    The type of resource granted access.. Value must be one of User, Team.
    permissions string[]
    Value must be one of read, update, authorize, destroy.
    authorizable_id str
    The id of the resource being accessed.
    authorizable_type str
    The type of resource being accessed.. Value must be one of Dashboard.
    grantee_id str
    The resource id granted access.
    grantee_type str
    The type of resource granted access.. Value must be one of User, Team.
    permissions Sequence[str]
    Value must be one of read, update, authorize, destroy.
    authorizableId String
    The id of the resource being accessed.
    authorizableType String
    The type of resource being accessed.. Value must be one of Dashboard.
    granteeId String
    The resource id granted access.
    granteeType String
    The type of resource granted access.. Value must be one of User, Team.
    permissions List<String>
    Value must be one of read, update, authorize, destroy.

    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.2.1 published on Tuesday, Apr 2, 2024 by Rootly