Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. SqlUser
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.SqlUser

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    CockroachDB SQL user.

    Create SqlUser Resource

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

    Constructor syntax

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

@overload
def SqlUser(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None)
    func NewSqlUser(ctx *Context, name string, args SqlUserArgs, opts ...ResourceOption) (*SqlUser, error)
    public SqlUser(string name, SqlUserArgs args, CustomResourceOptions? opts = null)
    public SqlUser(String name, SqlUserArgs args)
public SqlUser(String name, SqlUserArgs args, CustomResourceOptions options)

    type: cockroach:SqlUser
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 SqlUserArgs
    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 SqlUserArgs
    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 SqlUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlUserArgs
    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 sqlUserResource = new Cockroach.SqlUser("sqlUserResource", new()
{
    ClusterId = "string",
    Name = "string",
    Password = "string",
});

    example, err := cockroach.NewSqlUser(ctx, "sqlUserResource", &cockroach.SqlUserArgs{
	ClusterId: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Password:  pulumi.String("string"),
})

    var sqlUserResource = new SqlUser("sqlUserResource", SqlUserArgs.builder()
    .clusterId("string")
    .name("string")
    .password("string")
    .build());

    sql_user_resource = cockroach.SqlUser("sqlUserResource",
    cluster_id="string",
    name="string",
    password="string")

    const sqlUserResource = new cockroach.SqlUser("sqlUserResource", {
    clusterId: "string",
    name: "string",
    password: "string",
});

    type: cockroach:SqlUser
properties:
    clusterId: string
    name: string
    password: string

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

    ClusterId string
    Name string
    SQL user name.
    Password string
    ClusterId string
    Name string
    SQL user name.
    Password string
    clusterId String
    name String
    SQL user name.
    password String
    clusterId string
    name string
    SQL user name.
    password string
    cluster_id str
    name str
    SQL user name.
    password str
    clusterId String
    name String
    SQL user name.
    password String

    Outputs

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

    Get an existing SqlUser 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?: SqlUserState, opts?: CustomResourceOptions): SqlUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None) -> SqlUser
    func GetSqlUser(ctx *Context, name string, id IDInput, state *SqlUserState, opts ...ResourceOption) (*SqlUser, error)
    public static SqlUser Get(string name, Input<string> id, SqlUserState? state, CustomResourceOptions? opts = null)
    public static SqlUser get(String name, Output<String> id, SqlUserState 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:
    ClusterId string
    Name string
    SQL user name.
    Password string
    ClusterId string
    Name string
    SQL user name.
    Password string
    clusterId String
    name String
    SQL user name.
    password String
    clusterId string
    name string
    SQL user name.
    password string
    cluster_id str
    name str
    SQL user name.
    password str
    clusterId String
    name String
    SQL user name.
    password String

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach