planetscale.getPasswords

Explore with Pulumi AI

planetscale 0.6.0 published on Sunday, Apr 27, 2025 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";

const example = planetscale.getPasswords({
    organization: "example",
    database: "example_db",
    branch: "main",
});
export const passwords = example;

import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_passwords(organization="example",
    database="example_db",
    branch="main")
pulumi.export("passwords", example)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetPasswords(ctx, &planetscale.GetPasswordsArgs{
			Organization: "example",
			Database:     "example_db",
			Branch:       "main",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("passwords", example)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetPasswords.Invoke(new()
    {
        Organization = "example",
        Database = "example_db",
        Branch = "main",
    });

    return new Dictionary<string, object?>
    {
        ["passwords"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetPasswordsArgs;
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 example = PlanetscaleFunctions.getPasswords(GetPasswordsArgs.builder()
            .organization("example")
            .database("example_db")
            .branch("main")
            .build());

        ctx.export("passwords", example.applyValue(getPasswordsResult -> getPasswordsResult));
    }
}

variables:
  example:
    fn::invoke:
      function: planetscale:getPasswords
      arguments:
        organization: example
        database: example_db
        branch: main
outputs:
  passwords: ${example}

Using getPasswords

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getPasswords(args: GetPasswordsArgs, opts?: InvokeOptions): Promise<GetPasswordsResult>
function getPasswordsOutput(args: GetPasswordsOutputArgs, opts?: InvokeOptions): Output<GetPasswordsResult>

def get_passwords(branch: Optional[str] = None,
                  database: Optional[str] = None,
                  organization: Optional[str] = None,
                  read_only_region_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPasswordsResult
def get_passwords_output(branch: Optional[pulumi.Input[str]] = None,
                  database: Optional[pulumi.Input[str]] = None,
                  organization: Optional[pulumi.Input[str]] = None,
                  read_only_region_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPasswordsResult]

func GetPasswords(ctx *Context, args *GetPasswordsArgs, opts ...InvokeOption) (*GetPasswordsResult, error)
func GetPasswordsOutput(ctx *Context, args *GetPasswordsOutputArgs, opts ...InvokeOption) GetPasswordsResultOutput

> Note: This function is named GetPasswords in the Go SDK.

public static class GetPasswords 
{
    public static Task<GetPasswordsResult> InvokeAsync(GetPasswordsArgs args, InvokeOptions? opts = null)
    public static Output<GetPasswordsResult> Invoke(GetPasswordsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPasswordsResult> getPasswords(GetPasswordsArgs args, InvokeOptions options)
public static Output<GetPasswordsResult> getPasswords(GetPasswordsArgs args, InvokeOptions options)

fn::invoke:
  function: planetscale:index/getPasswords:getPasswords
  arguments:
    # arguments dictionary

The following arguments are supported:

Branch string
Database string
Organization string
ReadOnlyRegionId string

Branch string
Database string
Organization string
ReadOnlyRegionId string

branch String
database String
organization String
readOnlyRegionId String

branch string
database string
organization string
readOnlyRegionId string

branch str
database str
organization str
read_only_region_id str

branch String
database String
organization String
readOnlyRegionId String

getPasswords Result

The following output properties are available:

Branch string
Database string
Id string: The provider-assigned unique ID for this managed resource.
Organization string
Passwords List<GetPasswordsPassword>
ReadOnlyRegionId string

Branch string
Database string
Id string: The provider-assigned unique ID for this managed resource.
Organization string
Passwords []GetPasswordsPassword
ReadOnlyRegionId string

branch String
database String
id String: The provider-assigned unique ID for this managed resource.
organization String
passwords List<GetPasswordsPassword>
readOnlyRegionId String

branch string
database string
id string: The provider-assigned unique ID for this managed resource.
organization string
passwords GetPasswordsPassword[]
readOnlyRegionId string

branch str
database str
id str: The provider-assigned unique ID for this managed resource.
organization str
passwords Sequence[GetPasswordsPassword]
read_only_region_id str

branch String
database String
id String: The provider-assigned unique ID for this managed resource.
organization String
passwords List<Property Map>
readOnlyRegionId String

Supporting Types

GetPasswordsPassword

AccessHostUrl string: The host URL for the password.
Actor GetPasswordsPasswordActor: The actor that created this branch.
Branch string: The branch this password belongs to..
CreatedAt string: When the password was created.
Database string: The database this branch password belongs to.
DatabaseBranch GetPasswordsPasswordDatabaseBranch: The branch this password is allowed to access.
DeletedAt string: When the password was deleted.
ExpiresAt string: When the password will expire.
Id string: The ID for the password.
Name string: The display name for the password.
Organization string: The organization this database branch password belongs to.
ReadOnlyRegionId string: If the password is for a read-only region, the ID of the region.
Region GetPasswordsPasswordRegion: The region in which this password can be used.
Renewable bool: Whether or not the password can be renewed.
Role string: The role for the password.
TtlSeconds double: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
Username string: The username for the password.

AccessHostUrl string: The host URL for the password.
Actor GetPasswordsPasswordActor: The actor that created this branch.
Branch string: The branch this password belongs to..
CreatedAt string: When the password was created.
Database string: The database this branch password belongs to.
DatabaseBranch GetPasswordsPasswordDatabaseBranch: The branch this password is allowed to access.
DeletedAt string: When the password was deleted.
ExpiresAt string: When the password will expire.
Id string: The ID for the password.
Name string: The display name for the password.
Organization string: The organization this database branch password belongs to.
ReadOnlyRegionId string: If the password is for a read-only region, the ID of the region.
Region GetPasswordsPasswordRegion: The region in which this password can be used.
Renewable bool: Whether or not the password can be renewed.
Role string: The role for the password.
TtlSeconds float64: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
Username string: The username for the password.

accessHostUrl String: The host URL for the password.
actor GetPasswordsPasswordActor: The actor that created this branch.
branch String: The branch this password belongs to..
createdAt String: When the password was created.
database String: The database this branch password belongs to.
databaseBranch GetPasswordsPasswordDatabaseBranch: The branch this password is allowed to access.
deletedAt String: When the password was deleted.
expiresAt String: When the password will expire.
id String: The ID for the password.
name String: The display name for the password.
organization String: The organization this database branch password belongs to.
readOnlyRegionId String: If the password is for a read-only region, the ID of the region.
region GetPasswordsPasswordRegion: The region in which this password can be used.
renewable Boolean: Whether or not the password can be renewed.
role String: The role for the password.
ttlSeconds Double: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
username String: The username for the password.

accessHostUrl string: The host URL for the password.
actor GetPasswordsPasswordActor: The actor that created this branch.
branch string: The branch this password belongs to..
createdAt string: When the password was created.
database string: The database this branch password belongs to.
databaseBranch GetPasswordsPasswordDatabaseBranch: The branch this password is allowed to access.
deletedAt string: When the password was deleted.
expiresAt string: When the password will expire.
id string: The ID for the password.
name string: The display name for the password.
organization string: The organization this database branch password belongs to.
readOnlyRegionId string: If the password is for a read-only region, the ID of the region.
region GetPasswordsPasswordRegion: The region in which this password can be used.
renewable boolean: Whether or not the password can be renewed.
role string: The role for the password.
ttlSeconds number: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
username string: The username for the password.

access_host_url str: The host URL for the password.
actor GetPasswordsPasswordActor: The actor that created this branch.
branch str: The branch this password belongs to..
created_at str: When the password was created.
database str: The database this branch password belongs to.
database_branch GetPasswordsPasswordDatabaseBranch: The branch this password is allowed to access.
deleted_at str: When the password was deleted.
expires_at str: When the password will expire.
id str: The ID for the password.
name str: The display name for the password.
organization str: The organization this database branch password belongs to.
read_only_region_id str: If the password is for a read-only region, the ID of the region.
region GetPasswordsPasswordRegion: The region in which this password can be used.
renewable bool: Whether or not the password can be renewed.
role str: The role for the password.
ttl_seconds float: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
username str: The username for the password.

accessHostUrl String: The host URL for the password.
actor Property Map: The actor that created this branch.
branch String: The branch this password belongs to..
createdAt String: When the password was created.
database String: The database this branch password belongs to.
databaseBranch Property Map: The branch this password is allowed to access.
deletedAt String: When the password was deleted.
expiresAt String: When the password will expire.
id String: The ID for the password.
name String: The display name for the password.
organization String: The organization this database branch password belongs to.
readOnlyRegionId String: If the password is for a read-only region, the ID of the region.
region Property Map: The region in which this password can be used.
renewable Boolean: Whether or not the password can be renewed.
role String: The role for the password.
ttlSeconds Number: Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
username String: The username for the password.