Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Formal Provider
  3. API Docs
  4. NativeUserLink
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
formalco/pulumi-formal

formal.NativeUserLink

Explore with Pulumi AI

formal logo
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
formalco/pulumi-formal

    This resource creates assigns a Native User to a Formal Identity.

    Create NativeUserLink Resource

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

    Constructor syntax

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

@overload
def NativeUserLink(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   formal_identity_id: Optional[str] = None,
                   formal_identity_type: Optional[str] = None,
                   native_user_id: Optional[str] = None,
                   termination_protection: Optional[bool] = None)
    func NewNativeUserLink(ctx *Context, name string, args NativeUserLinkArgs, opts ...ResourceOption) (*NativeUserLink, error)
    public NativeUserLink(string name, NativeUserLinkArgs args, CustomResourceOptions? opts = null)
    public NativeUserLink(String name, NativeUserLinkArgs args)
public NativeUserLink(String name, NativeUserLinkArgs args, CustomResourceOptions options)

    type: formal:NativeUserLink
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 NativeUserLinkArgs
    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 NativeUserLinkArgs
    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 NativeUserLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NativeUserLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NativeUserLinkArgs
    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 nativeUserLinkResource = new Pulumi.NativeUserLink("nativeUserLinkResource", new()
{
    FormalIdentityId = "string",
    FormalIdentityType = "string",
    NativeUserId = "string",
    TerminationProtection = false,
});

    example, err := formal.NewNativeUserLink(ctx, "nativeUserLinkResource", &formal.NativeUserLinkArgs{
	FormalIdentityId:      pulumi.String("string"),
	FormalIdentityType:    pulumi.String("string"),
	NativeUserId:          pulumi.String("string"),
	TerminationProtection: pulumi.Bool(false),
})

    var nativeUserLinkResource = new NativeUserLink("nativeUserLinkResource", NativeUserLinkArgs.builder()
    .formalIdentityId("string")
    .formalIdentityType("string")
    .nativeUserId("string")
    .terminationProtection(false)
    .build());

    native_user_link_resource = formal.NativeUserLink("nativeUserLinkResource",
    formal_identity_id="string",
    formal_identity_type="string",
    native_user_id="string",
    termination_protection=False)

    const nativeUserLinkResource = new formal.NativeUserLink("nativeUserLinkResource", {
    formalIdentityId: "string",
    formalIdentityType: "string",
    nativeUserId: "string",
    terminationProtection: false,
});

    type: formal:NativeUserLink
properties:
    formalIdentityId: string
    formalIdentityType: string
    nativeUserId: string
    terminationProtection: false

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

    FormalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    FormalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    NativeUserId string
    The Native User ID of the Native User.
    TerminationProtection bool
    If set to true, this Native User link cannot be deleted.
    FormalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    FormalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    NativeUserId string
    The Native User ID of the Native User.
    TerminationProtection bool
    If set to true, this Native User link cannot be deleted.
    formalIdentityId String
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType String
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId String
    The Native User ID of the Native User.
    terminationProtection Boolean
    If set to true, this Native User link cannot be deleted.
    formalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId string
    The Native User ID of the Native User.
    terminationProtection boolean
    If set to true, this Native User link cannot be deleted.
    formal_identity_id str
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formal_identity_type str
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    native_user_id str
    The Native User ID of the Native User.
    termination_protection bool
    If set to true, this Native User link cannot be deleted.
    formalIdentityId String
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType String
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId String
    The Native User ID of the Native User.
    terminationProtection Boolean
    If set to true, this Native User link cannot be deleted.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NativeUserLink resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    The Resource ID of the Native User.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    The Resource ID of the Native User.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    The Resource ID of the Native User.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceId string
    The Resource ID of the Native User.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_id str
    The Resource ID of the Native User.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    The Resource ID of the Native User.

    Look up Existing NativeUserLink Resource

    Get an existing NativeUserLink 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?: NativeUserLinkState, opts?: CustomResourceOptions): NativeUserLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        formal_identity_id: Optional[str] = None,
        formal_identity_type: Optional[str] = None,
        native_user_id: Optional[str] = None,
        resource_id: Optional[str] = None,
        termination_protection: Optional[bool] = None) -> NativeUserLink
    func GetNativeUserLink(ctx *Context, name string, id IDInput, state *NativeUserLinkState, opts ...ResourceOption) (*NativeUserLink, error)
    public static NativeUserLink Get(string name, Input<string> id, NativeUserLinkState? state, CustomResourceOptions? opts = null)
    public static NativeUserLink get(String name, Output<String> id, NativeUserLinkState state, CustomResourceOptions options)
    resources:  _:    type: formal:NativeUserLink    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:
    FormalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    FormalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    NativeUserId string
    The Native User ID of the Native User.
    ResourceId string
    The Resource ID of the Native User.
    TerminationProtection bool
    If set to true, this Native User link cannot be deleted.
    FormalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    FormalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    NativeUserId string
    The Native User ID of the Native User.
    ResourceId string
    The Resource ID of the Native User.
    TerminationProtection bool
    If set to true, this Native User link cannot be deleted.
    formalIdentityId String
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType String
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId String
    The Native User ID of the Native User.
    resourceId String
    The Resource ID of the Native User.
    terminationProtection Boolean
    If set to true, this Native User link cannot be deleted.
    formalIdentityId string
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType string
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId string
    The Native User ID of the Native User.
    resourceId string
    The Resource ID of the Native User.
    terminationProtection boolean
    If set to true, this Native User link cannot be deleted.
    formal_identity_id str
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formal_identity_type str
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    native_user_id str
    The Native User ID of the Native User.
    resource_id str
    The Resource ID of the Native User.
    termination_protection bool
    If set to true, this Native User link cannot be deleted.
    formalIdentityId String
    The Formal ID for the User, Group, or Resource Hostname to be linked.
    formalIdentityType String
    The type of Formal Identity to be linked. Accepted values are user, group, and resource_hostname.
    nativeUserId String
    The Native User ID of the Native User.
    resourceId String
    The Resource ID of the Native User.
    terminationProtection Boolean
    If set to true, this Native User link 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 logo
    Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
    formalco/pulumi-formal