Docs Packages
  1. Packages
  2. Port
  3. API Docs
  4. PagePermissions
Port v2.0.9 published on Monday, Jun 24, 2024 by port-labs
port-labs/pulumi-port

port.PagePermissions

Explore with Pulumi AI

port logo
Port v2.0.9 published on Monday, Jun 24, 2024 by port-labs
port-labs/pulumi-port

    Create PagePermissions Resource

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

    Constructor syntax

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

@overload
def PagePermissions(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    page_identifier: Optional[str] = None,
                    read: Optional[PagePermissionsReadArgs] = None)
    func NewPagePermissions(ctx *Context, name string, args PagePermissionsArgs, opts ...ResourceOption) (*PagePermissions, error)
    public PagePermissions(string name, PagePermissionsArgs args, CustomResourceOptions? opts = null)
    public PagePermissions(String name, PagePermissionsArgs args)
public PagePermissions(String name, PagePermissionsArgs args, CustomResourceOptions options)

    type: port:PagePermissions
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 PagePermissionsArgs
    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 PagePermissionsArgs
    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 PagePermissionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PagePermissionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PagePermissionsArgs
    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 pagePermissionsResource = new Port.PagePermissions("pagePermissionsResource", new()
{
    PageIdentifier = "string",
    Read = new Port.Inputs.PagePermissionsReadArgs
    {
        Roles = new[]
        {
            "string",
        },
        Teams = new[]
        {
            "string",
        },
        Users = new[]
        {
            "string",
        },
    },
});

    example, err := port.NewPagePermissions(ctx, "pagePermissionsResource", &port.PagePermissionsArgs{
	PageIdentifier: pulumi.String("string"),
	Read: &port.PagePermissionsReadArgs{
		Roles: pulumi.StringArray{
			pulumi.String("string"),
		},
		Teams: pulumi.StringArray{
			pulumi.String("string"),
		},
		Users: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    var pagePermissionsResource = new PagePermissions("pagePermissionsResource", PagePermissionsArgs.builder()
    .pageIdentifier("string")
    .read(PagePermissionsReadArgs.builder()
        .roles("string")
        .teams("string")
        .users("string")
        .build())
    .build());

    page_permissions_resource = port.PagePermissions("pagePermissionsResource",
    page_identifier="string",
    read=port.PagePermissionsReadArgs(
        roles=["string"],
        teams=["string"],
        users=["string"],
    ))

    const pagePermissionsResource = new port.PagePermissions("pagePermissionsResource", {
    pageIdentifier: "string",
    read: {
        roles: ["string"],
        teams: ["string"],
        users: ["string"],
    },
});

    type: port:PagePermissions
properties:
    pageIdentifier: string
    read:
        roles:
            - string
        teams:
            - string
        users:
            - string

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

    PageIdentifier string
    Read PagePermissionsReadArgs
    The permission to read the page
    pageIdentifier String
    read PagePermissionsRead
    The permission to read the page
    pageIdentifier string
    read PagePermissionsRead
    The permission to read the page
    page_identifier str
    read PagePermissionsReadArgs
    The permission to read the page
    pageIdentifier String
    read Property Map
    The permission to read the page

    Outputs

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

    Get an existing PagePermissions 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?: PagePermissionsState, opts?: CustomResourceOptions): PagePermissions
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        page_identifier: Optional[str] = None,
        read: Optional[PagePermissionsReadArgs] = None) -> PagePermissions
    func GetPagePermissions(ctx *Context, name string, id IDInput, state *PagePermissionsState, opts ...ResourceOption) (*PagePermissions, error)
    public static PagePermissions Get(string name, Input<string> id, PagePermissionsState? state, CustomResourceOptions? opts = null)
    public static PagePermissions get(String name, Output<String> id, PagePermissionsState 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:
    PageIdentifier string
    Read PagePermissionsReadArgs
    The permission to read the page
    pageIdentifier String
    read PagePermissionsRead
    The permission to read the page
    pageIdentifier string
    read PagePermissionsRead
    The permission to read the page
    page_identifier str
    read PagePermissionsReadArgs
    The permission to read the page
    pageIdentifier String
    read Property Map
    The permission to read the page

    Supporting Types

    PagePermissionsRead, PagePermissionsReadArgs

    Roles List<string>
    The roles with read permission
    Teams List<string>
    The teams with read permission
    Users List<string>
    The users with read permission
    Roles []string
    The roles with read permission
    Teams []string
    The teams with read permission
    Users []string
    The users with read permission
    roles List<String>
    The roles with read permission
    teams List<String>
    The teams with read permission
    users List<String>
    The users with read permission
    roles string[]
    The roles with read permission
    teams string[]
    The teams with read permission
    users string[]
    The users with read permission
    roles Sequence[str]
    The roles with read permission
    teams Sequence[str]
    The teams with read permission
    users Sequence[str]
    The users with read permission
    roles List<String>
    The roles with read permission
    teams List<String>
    The teams with read permission
    users List<String>
    The users with read permission

    Package Details

    Repository
    port port-labs/pulumi-port
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the port-labs Terraform Provider.
    port logo
    Port v2.0.9 published on Monday, Jun 24, 2024 by port-labs
    port-labs/pulumi-port