1. Packages
  2. Formal Provider
  3. API Docs
  4. NativeUser
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.NativeUser

Explore with Pulumi AI

formal logo
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

    This resource creates a Native User.

    Create NativeUser Resource

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

    Constructor syntax

    new NativeUser(name: string, args: NativeUserArgs, opts?: CustomResourceOptions);
    @overload
    def NativeUser(resource_name: str,
                   args: NativeUserArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def NativeUser(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   native_user_id: Optional[str] = None,
                   native_user_secret: Optional[str] = None,
                   resource_id: Optional[str] = None,
                   termination_protection: Optional[bool] = None,
                   use_as_default: Optional[bool] = None)
    func NewNativeUser(ctx *Context, name string, args NativeUserArgs, opts ...ResourceOption) (*NativeUser, error)
    public NativeUser(string name, NativeUserArgs args, CustomResourceOptions? opts = null)
    public NativeUser(String name, NativeUserArgs args)
    public NativeUser(String name, NativeUserArgs args, CustomResourceOptions options)
    
    type: formal:NativeUser
    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 NativeUserArgs
    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 NativeUserArgs
    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 NativeUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NativeUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NativeUserArgs
    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 nativeUserResource = new Pulumi.NativeUser("nativeUserResource", new()
    {
        NativeUserId = "string",
        NativeUserSecret = "string",
        ResourceId = "string",
        TerminationProtection = false,
        UseAsDefault = false,
    });
    
    example, err := formal.NewNativeUser(ctx, "nativeUserResource", &formal.NativeUserArgs{
    	NativeUserId:          pulumi.String("string"),
    	NativeUserSecret:      pulumi.String("string"),
    	ResourceId:            pulumi.String("string"),
    	TerminationProtection: pulumi.Bool(false),
    	UseAsDefault:          pulumi.Bool(false),
    })
    
    var nativeUserResource = new NativeUser("nativeUserResource", NativeUserArgs.builder()
        .nativeUserId("string")
        .nativeUserSecret("string")
        .resourceId("string")
        .terminationProtection(false)
        .useAsDefault(false)
        .build());
    
    native_user_resource = formal.NativeUser("nativeUserResource",
        native_user_id="string",
        native_user_secret="string",
        resource_id="string",
        termination_protection=False,
        use_as_default=False)
    
    const nativeUserResource = new formal.NativeUser("nativeUserResource", {
        nativeUserId: "string",
        nativeUserSecret: "string",
        resourceId: "string",
        terminationProtection: false,
        useAsDefault: false,
    });
    
    type: formal:NativeUser
    properties:
        nativeUserId: string
        nativeUserSecret: string
        resourceId: string
        terminationProtection: false
        useAsDefault: false
    

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

    NativeUserId string
    The username of the Native User.
    NativeUserSecret string
    The password of the Native User.
    ResourceId string
    The Sidecar ID for the resource this Native User is for.
    TerminationProtection bool
    If set to true, this Native User cannot be deleted.
    UseAsDefault bool
    The password of the Native User.
    NativeUserId string
    The username of the Native User.
    NativeUserSecret string
    The password of the Native User.
    ResourceId string
    The Sidecar ID for the resource this Native User is for.
    TerminationProtection bool
    If set to true, this Native User cannot be deleted.
    UseAsDefault bool
    The password of the Native User.
    nativeUserId String
    The username of the Native User.
    nativeUserSecret String
    The password of the Native User.
    resourceId String
    The Sidecar ID for the resource this Native User is for.
    terminationProtection Boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault Boolean
    The password of the Native User.
    nativeUserId string
    The username of the Native User.
    nativeUserSecret string
    The password of the Native User.
    resourceId string
    The Sidecar ID for the resource this Native User is for.
    terminationProtection boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault boolean
    The password of the Native User.
    native_user_id str
    The username of the Native User.
    native_user_secret str
    The password of the Native User.
    resource_id str
    The Sidecar ID for the resource this Native User is for.
    termination_protection bool
    If set to true, this Native User cannot be deleted.
    use_as_default bool
    The password of the Native User.
    nativeUserId String
    The username of the Native User.
    nativeUserSecret String
    The password of the Native User.
    resourceId String
    The Sidecar ID for the resource this Native User is for.
    terminationProtection Boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault Boolean
    The password of the Native User.

    Outputs

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

    Get an existing NativeUser 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?: NativeUserState, opts?: CustomResourceOptions): NativeUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            native_user_id: Optional[str] = None,
            native_user_secret: Optional[str] = None,
            resource_id: Optional[str] = None,
            termination_protection: Optional[bool] = None,
            use_as_default: Optional[bool] = None) -> NativeUser
    func GetNativeUser(ctx *Context, name string, id IDInput, state *NativeUserState, opts ...ResourceOption) (*NativeUser, error)
    public static NativeUser Get(string name, Input<string> id, NativeUserState? state, CustomResourceOptions? opts = null)
    public static NativeUser get(String name, Output<String> id, NativeUserState state, CustomResourceOptions options)
    resources:  _:    type: formal:NativeUser    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:
    NativeUserId string
    The username of the Native User.
    NativeUserSecret string
    The password of the Native User.
    ResourceId string
    The Sidecar ID for the resource this Native User is for.
    TerminationProtection bool
    If set to true, this Native User cannot be deleted.
    UseAsDefault bool
    The password of the Native User.
    NativeUserId string
    The username of the Native User.
    NativeUserSecret string
    The password of the Native User.
    ResourceId string
    The Sidecar ID for the resource this Native User is for.
    TerminationProtection bool
    If set to true, this Native User cannot be deleted.
    UseAsDefault bool
    The password of the Native User.
    nativeUserId String
    The username of the Native User.
    nativeUserSecret String
    The password of the Native User.
    resourceId String
    The Sidecar ID for the resource this Native User is for.
    terminationProtection Boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault Boolean
    The password of the Native User.
    nativeUserId string
    The username of the Native User.
    nativeUserSecret string
    The password of the Native User.
    resourceId string
    The Sidecar ID for the resource this Native User is for.
    terminationProtection boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault boolean
    The password of the Native User.
    native_user_id str
    The username of the Native User.
    native_user_secret str
    The password of the Native User.
    resource_id str
    The Sidecar ID for the resource this Native User is for.
    termination_protection bool
    If set to true, this Native User cannot be deleted.
    use_as_default bool
    The password of the Native User.
    nativeUserId String
    The username of the Native User.
    nativeUserSecret String
    The password of the Native User.
    resourceId String
    The Sidecar ID for the resource this Native User is for.
    terminationProtection Boolean
    If set to true, this Native User cannot be deleted.
    useAsDefault Boolean
    The password of the Native User.

    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