planetscale.getPassword

Explore with Pulumi AI

planetscale 0.5.0 published on Saturday, Apr 5, 2025 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

TypeScript
Python
Go
C#
Java
YAML

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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.GetPasswordArgs;
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.getPassword(GetPasswordArgs.builder()
            .organization("example")
            .database("example_db")
            .branch("main")
            .name("antoine-was-here")
            .build());

        ctx.export("password", example.applyValue(getPasswordResult -> getPasswordResult));
    }
}

variables:
  example:
    fn::invoke:
      function: planetscale:getPassword
      arguments:
        organization: example
        database: example_db
        branch: main
        name: antoine-was-here
outputs:
  password: ${example}

Using getPassword

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 getPassword(args: GetPasswordArgs, opts?: InvokeOptions): Promise<GetPasswordResult>
function getPasswordOutput(args: GetPasswordOutputArgs, opts?: InvokeOptions): Output<GetPasswordResult>

def get_password(branch: Optional[str] = None,
                 database: Optional[str] = None,
                 id: Optional[str] = None,
                 organization: Optional[str] = None,
                 read_only_region_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPasswordResult
def get_password_output(branch: Optional[pulumi.Input[str]] = None,
                 database: Optional[pulumi.Input[str]] = None,
                 id: 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[GetPasswordResult]

func LookupPassword(ctx *Context, args *LookupPasswordArgs, opts ...InvokeOption) (*LookupPasswordResult, error)
func LookupPasswordOutput(ctx *Context, args *LookupPasswordOutputArgs, opts ...InvokeOption) LookupPasswordResultOutput

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

public static class GetPassword 
{
    public static Task<GetPasswordResult> InvokeAsync(GetPasswordArgs args, InvokeOptions? opts = null)
    public static Output<GetPasswordResult> Invoke(GetPasswordInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPasswordResult> getPassword(GetPasswordArgs args, InvokeOptions options)
public static Output<GetPasswordResult> getPassword(GetPasswordArgs args, InvokeOptions options)

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

The following arguments are supported:

Branch string: The branch this password belongs to..
Database string: The database this branch password belongs to.
Id string: The ID 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.

Branch string: The branch this password belongs to..
Database string: The database this branch password belongs to.
Id string: The ID 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.

branch String: The branch this password belongs to..
database String: The database this branch password belongs to.
id String: The ID 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.

branch string: The branch this password belongs to..
database string: The database this branch password belongs to.
id string: The ID 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.

branch str: The branch this password belongs to..
database str: The database this branch password belongs to.
id str: The ID 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.

branch String: The branch this password belongs to..
database String: The database this branch password belongs to.
id String: The ID 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.

getPassword Result

The following output properties are available:

AccessHostUrl string: The host URL for the password.
Actor GetPasswordActor: 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 GetPasswordDatabaseBranch: 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.
Region GetPasswordRegion: 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.
ReadOnlyRegionId string: If the password is for a read-only region, the ID of the region.

AccessHostUrl string: The host URL for the password.
Actor GetPasswordActor: 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 GetPasswordDatabaseBranch: 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.
Region GetPasswordRegion: 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.
ReadOnlyRegionId string: If the password is for a read-only region, the ID of the region.

accessHostUrl String: The host URL for the password.
actor GetPasswordActor: 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 GetPasswordDatabaseBranch: 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.
region GetPasswordRegion: 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.
readOnlyRegionId String: If the password is for a read-only region, the ID of the region.

accessHostUrl string: The host URL for the password.
actor GetPasswordActor: 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 GetPasswordDatabaseBranch: 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.
region GetPasswordRegion: 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.
readOnlyRegionId string: If the password is for a read-only region, the ID of the region.

access_host_url str: The host URL for the password.
actor GetPasswordActor: 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 GetPasswordDatabaseBranch: 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.
region GetPasswordRegion: 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.
read_only_region_id str: If the password is for a read-only region, the ID of the region.

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.
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.
readOnlyRegionId String: If the password is for a read-only region, the ID of the region.