CockroachDB v0.6.0, Nov 1 24

CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse

cockroach.SqlUser

Explore with Pulumi AI

CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cockroach from "@pulumiverse/cockroach";

const config = new pulumi.Config();
const clusterId = config.require("clusterId");
const sqlUserPassword = config.require("sqlUserPassword");
const cockroach = new cockroach.SqlUser("cockroach", {
    name: "example-sql-user",
    password: sqlUserPassword,
    clusterId: clusterId,
});

import pulumi
import pulumiverse_cockroach as cockroach

config = pulumi.Config()
cluster_id = config.require("clusterId")
sql_user_password = config.require("sqlUserPassword")
cockroach = cockroach.SqlUser("cockroach",
    name="example-sql-user",
    password=sql_user_password,
    cluster_id=cluster_id)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-cockroach/sdk/go/cockroach"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		clusterId := cfg.Require("clusterId")
		sqlUserPassword := cfg.Require("sqlUserPassword")
		_, err := cockroach.NewSqlUser(ctx, "cockroach", &cockroach.SqlUserArgs{
			Name:      pulumi.String("example-sql-user"),
			Password:  pulumi.String(sqlUserPassword),
			ClusterId: pulumi.String(clusterId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cockroach = Pulumiverse.Cockroach;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var clusterId = config.Require("clusterId");
    var sqlUserPassword = config.Require("sqlUserPassword");
    var cockroach = new Cockroach.SqlUser("cockroach", new()
    {
        Name = "example-sql-user",
        Password = sqlUserPassword,
        ClusterId = clusterId,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.SqlUser;
import com.pulumi.cockroach.SqlUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var clusterId = config.get("clusterId");
        final var sqlUserPassword = config.get("sqlUserPassword");
        var cockroach = new SqlUser("cockroach", SqlUserArgs.builder()
            .name("example-sql-user")
            .password(sqlUserPassword)
            .clusterId(clusterId)
            .build());

    }
}

configuration:
  clusterId:
    type: string
  # Remember that even variables marked sensitive will show up
  # in the Terraform state file. Always follow best practices
  # when managing sensitive info.
  # https://developer.hashicorp.com/terraform/tutorials/configuration-language/sensitive-variables#sensitive-values-in-state
  sqlUserPassword:
    type: string
resources:
  cockroach:
    type: cockroach:SqlUser
    properties:
      name: example-sql-user
      password: ${sqlUserPassword}
      clusterId: ${clusterId}

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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

Import

format: :

$ pulumi import cockroach:index/sqlUser:SqlUser bill 1f69fdd2-600a-4cfc-a9ba-16995df0d77d:bill

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: cockroach pulumiverse/pulumi-cockroach
License: Apache-2.0
Notes: This Pulumi package is based on the cockroach Terraform Provider.

CockroachDB v0.6.0 published on Friday, Nov 1, 2024 by pulumiverse

pulumiverse/pulumi-cockroach

cockroach.SqlUser

On this page

On this page

Example Usage

Create SqlUser Resource

Constructor syntax

Parameters

Constructor example

SqlUser Resource Properties

Inputs

Outputs

Look up Existing SqlUser Resource

Import

Package Details

On this page

On this page