Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. OpensearchUser
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProjectDatabase.OpensearchUser

Explore with Pulumi AI

ovh logo
OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
ovh/pulumi-ovh

    Import

    OVHcloud Managed OpenSearch clusters users can be imported using the service_name, cluster_id and id of the user, separated by “/” E.g.,

    bash

    $ pulumi import ovh:CloudProjectDatabase/opensearchUser:OpensearchUser my_user service_name/cluster_id/id

    Create OpensearchUser Resource

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

    Constructor syntax

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

@overload
def OpensearchUser(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cluster_id: Optional[str] = None,
                   service_name: Optional[str] = None,
                   acls: Optional[Sequence[_cloudprojectdatabase.OpensearchUserAclArgs]] = None,
                   name: Optional[str] = None,
                   password_reset: Optional[str] = None)
    func NewOpensearchUser(ctx *Context, name string, args OpensearchUserArgs, opts ...ResourceOption) (*OpensearchUser, error)
    public OpensearchUser(string name, OpensearchUserArgs args, CustomResourceOptions? opts = null)
    public OpensearchUser(String name, OpensearchUserArgs args)
public OpensearchUser(String name, OpensearchUserArgs args, CustomResourceOptions options)

    type: ovh:CloudProjectDatabase:OpensearchUser
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 OpensearchUserArgs
    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 OpensearchUserArgs
    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 OpensearchUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpensearchUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpensearchUserArgs
    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 opensearchUserResource = new Ovh.CloudProjectDatabase.OpensearchUser("opensearchUserResource", new()
{
    ClusterId = "string",
    ServiceName = "string",
    Acls = new[]
    {
        new Ovh.CloudProjectDatabase.Inputs.OpensearchUserAclArgs
        {
            Pattern = "string",
            Permission = "string",
        },
    },
    Name = "string",
    PasswordReset = "string",
});

    example, err := CloudProjectDatabase.NewOpensearchUser(ctx, "opensearchUserResource", &CloudProjectDatabase.OpensearchUserArgs{
	ClusterId:   pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Acls: cloudprojectdatabase.OpensearchUserAclArray{
		&cloudprojectdatabase.OpensearchUserAclArgs{
			Pattern:    pulumi.String("string"),
			Permission: pulumi.String("string"),
		},
	},
	Name:          pulumi.String("string"),
	PasswordReset: pulumi.String("string"),
})

    var opensearchUserResource = new OpensearchUser("opensearchUserResource", OpensearchUserArgs.builder()
    .clusterId("string")
    .serviceName("string")
    .acls(OpensearchUserAclArgs.builder()
        .pattern("string")
        .permission("string")
        .build())
    .name("string")
    .passwordReset("string")
    .build());

    opensearch_user_resource = ovh.cloud_project_database.OpensearchUser("opensearchUserResource",
    cluster_id="string",
    service_name="string",
    acls=[{
        "pattern": "string",
        "permission": "string",
    }],
    name="string",
    password_reset="string")

    const opensearchUserResource = new ovh.cloudprojectdatabase.OpensearchUser("opensearchUserResource", {
    clusterId: "string",
    serviceName: "string",
    acls: [{
        pattern: "string",
        permission: "string",
    }],
    name: "string",
    passwordReset: "string",
});

    type: ovh:CloudProjectDatabase:OpensearchUser
properties:
    acls:
        - pattern: string
          permission: string
    clusterId: string
    name: string
    passwordReset: string
    serviceName: string

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

    ClusterId string
    Cluster ID.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Acls List<OpensearchUserAcl>
    Acls of the user.
    Name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ClusterId string
    Cluster ID.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Acls []OpensearchUserAclArgs
    Acls of the user.
    Name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    acls List<OpensearchUserAcl>
    Acls of the user.
    name String
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    clusterId string
    Cluster ID.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    acls OpensearchUserAcl[]
    Acls of the user.
    name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    cluster_id str
    Cluster ID.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    acls Sequence[cloudprojectdatabase.OpensearchUserAclArgs]
    Acls of the user.
    name str
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password_reset str
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    acls List<Property Map>
    Acls of the user.
    name String
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    passwordReset String
    Arbitrary string to change to trigger a password update

    Outputs

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

    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Status string
    Current status of the user.
    CreatedAt string
    Date of the creation of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Status string
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    status String
    Current status of the user.
    createdAt string
    Date of the creation of the user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (Sensitive) Password of the user.
    status string
    Current status of the user.
    created_at str
    Date of the creation of the user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (Sensitive) Password of the user.
    status str
    Current status of the user.
    createdAt String
    Date of the creation of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    status String
    Current status of the user.

    Look up Existing OpensearchUser Resource

    Get an existing OpensearchUser 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?: OpensearchUserState, opts?: CustomResourceOptions): OpensearchUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acls: Optional[Sequence[_cloudprojectdatabase.OpensearchUserAclArgs]] = None,
        cluster_id: Optional[str] = None,
        created_at: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_reset: Optional[str] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None) -> OpensearchUser
    func GetOpensearchUser(ctx *Context, name string, id IDInput, state *OpensearchUserState, opts ...ResourceOption) (*OpensearchUser, error)
    public static OpensearchUser Get(string name, Input<string> id, OpensearchUserState? state, CustomResourceOptions? opts = null)
    public static OpensearchUser get(String name, Output<String> id, OpensearchUserState 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:
    Acls List<OpensearchUserAcl>
    Acls of the user.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    Acls []OpensearchUserAclArgs
    Acls of the user.
    ClusterId string
    Cluster ID.
    CreatedAt string
    Date of the creation of the user.
    Name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Status string
    Current status of the user.
    acls List<OpensearchUserAcl>
    Acls of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.
    acls OpensearchUserAcl[]
    Acls of the user.
    clusterId string
    Cluster ID.
    createdAt string
    Date of the creation of the user.
    name string
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password string
    (Sensitive) Password of the user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status string
    Current status of the user.
    acls Sequence[cloudprojectdatabase.OpensearchUserAclArgs]
    Acls of the user.
    cluster_id str
    Cluster ID.
    created_at str
    Date of the creation of the user.
    name str
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password str
    (Sensitive) Password of the user.
    password_reset str
    Arbitrary string to change to trigger a password update
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status str
    Current status of the user.
    acls List<Property Map>
    Acls of the user.
    clusterId String
    Cluster ID.
    createdAt String
    Date of the creation of the user.
    name String
    Username affected by this acl. A user named "avnadmin" is mapped with already created admin user and reset his password instead of creating a new user.
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    status String
    Current status of the user.

    Supporting Types

    OpensearchUserAcl, OpensearchUserAclArgs

    Pattern string
    Pattern of the ACL.
    Permission string
    Permission of the ACL Available permission:
    Pattern string
    Pattern of the ACL.
    Permission string
    Permission of the ACL Available permission:
    pattern String
    Pattern of the ACL.
    permission String
    Permission of the ACL Available permission:
    pattern string
    Pattern of the ACL.
    permission string
    Permission of the ACL Available permission:
    pattern str
    Pattern of the ACL.
    permission str
    Permission of the ACL Available permission:
    pattern String
    Pattern of the ACL.
    permission String
    Permission of the ACL Available permission:

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v1.0.0 published on Wednesday, Oct 30, 2024 by OVHcloud
    ovh/pulumi-ovh