Formal v1.0.2, Aug 14 25

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formal.Permission

Explore with Pulumi AI

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

Create Permission Resource

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

Constructor syntax

new Permission(name: string, args: PermissionArgs, opts?: CustomResourceOptions);

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

@overload
def Permission(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               code: Optional[str] = None,
               description: Optional[str] = None,
               status: Optional[str] = None,
               name: Optional[str] = None,
               termination_protection: Optional[bool] = None)

func NewPermission(ctx *Context, name string, args PermissionArgs, opts ...ResourceOption) (*Permission, error)

public Permission(string name, PermissionArgs args, CustomResourceOptions? opts = null)

public Permission(String name, PermissionArgs args)
public Permission(String name, PermissionArgs args, CustomResourceOptions options)

type: formal:Permission
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 PermissionArgs: 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 PermissionArgs: 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 PermissionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PermissionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PermissionArgs: 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 permissionResource = new Pulumi.Permission("permissionResource", new()
{
    Code = "string",
    Description = "string",
    Status = "string",
    Name = "string",
    TerminationProtection = false,
});

example, err := formal.NewPermission(ctx, "permissionResource", &formal.PermissionArgs{
	Code:                  pulumi.String("string"),
	Description:           pulumi.String("string"),
	Status:                pulumi.String("string"),
	Name:                  pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

var permissionResource = new Permission("permissionResource", PermissionArgs.builder()
    .code("string")
    .description("string")
    .status("string")
    .name("string")
    .terminationProtection(false)
    .build());

permission_resource = formal.Permission("permissionResource",
    code="string",
    description="string",
    status="string",
    name="string",
    termination_protection=False)

const permissionResource = new formal.Permission("permissionResource", {
    code: "string",
    description: "string",
    status: "string",
    name: "string",
    terminationProtection: false,
});

type: formal:Permission
properties:
    code: string
    description: string
    name: string
    status: string
    terminationProtection: false

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

Code string: The code describing how the permission works. Create one in the Formal Console.
Description string: Permission Description.
Status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
Name string: Permission Name
TerminationProtection bool: If set to true, this Permission cannot be deleted.

Code string: The code describing how the permission works. Create one in the Formal Console.
Description string: Permission Description.
Status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
Name string: Permission Name
TerminationProtection bool: If set to true, this Permission cannot be deleted.

code String: The code describing how the permission works. Create one in the Formal Console.
description String: Permission Description.
status String: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
name String: Permission Name
terminationProtection Boolean: If set to true, this Permission cannot be deleted.

code string: The code describing how the permission works. Create one in the Formal Console.
description string: Permission Description.
status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
name string: Permission Name
terminationProtection boolean: If set to true, this Permission cannot be deleted.

code str: The code describing how the permission works. Create one in the Formal Console.
description str: Permission Description.
status str: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
name str: Permission Name
termination_protection bool: If set to true, this Permission cannot be deleted.

code String: The code describing how the permission works. Create one in the Formal Console.
description String: Permission Description.
status String: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
name String: Permission Name
terminationProtection Boolean: If set to true, this Permission cannot be deleted.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        code: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        termination_protection: Optional[bool] = None) -> Permission

func GetPermission(ctx *Context, name string, id IDInput, state *PermissionState, opts ...ResourceOption) (*Permission, error)

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

public static Permission get(String name, Output<String> id, PermissionState state, CustomResourceOptions options)

resources:  _:    type: formal:Permission    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.

The following state arguments are supported:

Code string: The code describing how the permission works. Create one in the Formal Console.
Description string: Permission Description.
Name string: Permission Name
Status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
TerminationProtection bool: If set to true, this Permission cannot be deleted.

Code string: The code describing how the permission works. Create one in the Formal Console.
Description string: Permission Description.
Name string: Permission Name
Status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
TerminationProtection bool: If set to true, this Permission cannot be deleted.

code String: The code describing how the permission works. Create one in the Formal Console.
description String: Permission Description.
name String: Permission Name
status String: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
terminationProtection Boolean: If set to true, this Permission cannot be deleted.

code string: The code describing how the permission works. Create one in the Formal Console.
description string: Permission Description.
name string: Permission Name
status string: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
terminationProtection boolean: If set to true, this Permission cannot be deleted.

code str: The code describing how the permission works. Create one in the Formal Console.
description str: Permission Description.
name str: Permission Name
status str: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
termination_protection bool: If set to true, this Permission cannot be deleted.

code String: The code describing how the permission works. Create one in the Formal Console.
description String: Permission Description.
name String: Permission Name
status String: Defines the current status of the permission. It can be one of the following: 'draft', 'dry-run', or 'active'.
terminationProtection Boolean: If set to true, this Permission cannot be deleted.

Package Details

Repository: formal formalco/pulumi-formal
License: MPL-2.0
Notes: This Pulumi package is based on the formal Terraform Provider.

Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formalco/pulumi-formal

formal.Permission

On this page

On this page

Create Permission Resource

Constructor syntax

Parameters

Constructor example

Permission Resource Properties

Inputs

Outputs

Look up Existing Permission Resource

Package Details

On this page

On this page