planetscale

package
v0.0.0-...-5f63525 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing planetscale cloud resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Backup 

type Backup struct {
	pulumi.CustomResourceState

	// .
	Actor BackupActorOutput `pulumi:"actor"`
	// The policy used by the backup.
	BackupPolicy BackupBackupPolicyOutput `pulumi:"backupPolicy"`
	// The branch being backed up.
	Branch pulumi.StringOutput `pulumi:"branch"`
	// When the backup was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// The database to which the branch being backed up belongs to.
	Database pulumi.StringOutput `pulumi:"database"`
	// The estimated storage cost of the backup.
	EstimatedStorageCost pulumi.StringOutput `pulumi:"estimatedStorageCost"`
	// The name of the backup.
	Name pulumi.StringOutput `pulumi:"name"`
	// The organization in which the database branch being backed up belongs to.
	Organization pulumi.StringOutput `pulumi:"organization"`
	// Whether or not the backup policy is required.
	Required pulumi.BoolOutput `pulumi:"required"`
	// Branches that have been restored with this backup.
	RestoredBranches pulumi.StringArrayOutput `pulumi:"restoredBranches"`
	// The size of the backup.
	Size pulumi.Float64Output `pulumi:"size"`
	// The current state of the backup.
	State pulumi.StringOutput `pulumi:"state"`
	// When the backup was last updated.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

A PlanetScale backup.

Known limitations: - It is not currently possible to manage backup schedules, only retention periods.

func GetBackup 

func GetBackup(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BackupState, opts ...pulumi.ResourceOption) (*Backup, error)

GetBackup gets an existing Backup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBackup 

func NewBackup(ctx *pulumi.Context,
	name string, args *BackupArgs, opts ...pulumi.ResourceOption) (*Backup, error)

NewBackup registers a new resource with the given unique name, arguments, and options.

func (*Backup) ElementType 

func (*Backup) ElementType() reflect.Type

func (*Backup) ToBackupOutput 

func (i *Backup) ToBackupOutput() BackupOutput

func (*Backup) ToBackupOutputWithContext 

func (i *Backup) ToBackupOutputWithContext(ctx context.Context) BackupOutput

type BackupActor 

type BackupActor struct {
	// The URL of the actor's avatar
	AvatarUrl *string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName *string `pulumi:"displayName"`
	// The ID of the actor
	Id *string `pulumi:"id"`
}

type BackupActorArgs 

type BackupActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringPtrInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringPtrInput `pulumi:"id"`
}

func (BackupActorArgs) ElementType 

func (BackupActorArgs) ElementType() reflect.Type

func (BackupActorArgs) ToBackupActorOutput 

func (i BackupActorArgs) ToBackupActorOutput() BackupActorOutput

func (BackupActorArgs) ToBackupActorOutputWithContext 

func (i BackupActorArgs) ToBackupActorOutputWithContext(ctx context.Context) BackupActorOutput

func (BackupActorArgs) ToBackupActorPtrOutput 

func (i BackupActorArgs) ToBackupActorPtrOutput() BackupActorPtrOutput

func (BackupActorArgs) ToBackupActorPtrOutputWithContext 

func (i BackupActorArgs) ToBackupActorPtrOutputWithContext(ctx context.Context) BackupActorPtrOutput

type BackupActorInput 

type BackupActorInput interface {
	pulumi.Input

	ToBackupActorOutput() BackupActorOutput
	ToBackupActorOutputWithContext(context.Context) BackupActorOutput
}

BackupActorInput is an input type that accepts BackupActorArgs and BackupActorOutput values. You can construct a concrete instance of `BackupActorInput` via: 

BackupActorArgs{...}

type BackupActorOutput 

type BackupActorOutput struct{ *pulumi.OutputState }

func (BackupActorOutput) AvatarUrl 

func (o BackupActorOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (BackupActorOutput) DisplayName 

func (o BackupActorOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (BackupActorOutput) ElementType 

func (BackupActorOutput) ElementType() reflect.Type

func (BackupActorOutput) Id 

func (o BackupActorOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (BackupActorOutput) ToBackupActorOutput 

func (o BackupActorOutput) ToBackupActorOutput() BackupActorOutput

func (BackupActorOutput) ToBackupActorOutputWithContext 

func (o BackupActorOutput) ToBackupActorOutputWithContext(ctx context.Context) BackupActorOutput

func (BackupActorOutput) ToBackupActorPtrOutput 

func (o BackupActorOutput) ToBackupActorPtrOutput() BackupActorPtrOutput

func (BackupActorOutput) ToBackupActorPtrOutputWithContext 

func (o BackupActorOutput) ToBackupActorPtrOutputWithContext(ctx context.Context) BackupActorPtrOutput

type BackupActorPtrInput 

type BackupActorPtrInput interface {
	pulumi.Input

	ToBackupActorPtrOutput() BackupActorPtrOutput
	ToBackupActorPtrOutputWithContext(context.Context) BackupActorPtrOutput
}

BackupActorPtrInput is an input type that accepts BackupActorArgs, BackupActorPtr and BackupActorPtrOutput values. You can construct a concrete instance of `BackupActorPtrInput` via: 

        BackupActorArgs{...}

or:

        nil

func BackupActorPtr 

func BackupActorPtr(v *BackupActorArgs) BackupActorPtrInput

type BackupActorPtrOutput 

type BackupActorPtrOutput struct{ *pulumi.OutputState }

func (BackupActorPtrOutput) AvatarUrl 

func (o BackupActorPtrOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (BackupActorPtrOutput) DisplayName 

func (o BackupActorPtrOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (BackupActorPtrOutput) Elem 

func (o BackupActorPtrOutput) Elem() BackupActorOutput

func (BackupActorPtrOutput) ElementType 

func (BackupActorPtrOutput) ElementType() reflect.Type

func (BackupActorPtrOutput) Id 

func (o BackupActorPtrOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (BackupActorPtrOutput) ToBackupActorPtrOutput 

func (o BackupActorPtrOutput) ToBackupActorPtrOutput() BackupActorPtrOutput

func (BackupActorPtrOutput) ToBackupActorPtrOutputWithContext 

func (o BackupActorPtrOutput) ToBackupActorPtrOutputWithContext(ctx context.Context) BackupActorPtrOutput

type BackupArgs 

type BackupArgs struct {
	// The policy used by the backup.
	BackupPolicy BackupBackupPolicyInput
	// The branch being backed up.
	Branch pulumi.StringInput
	// The database to which the branch being backed up belongs to.
	Database pulumi.StringInput
	// The name of the backup.
	Name pulumi.StringPtrInput
	// The organization in which the database branch being backed up belongs to.
	Organization pulumi.StringInput
}

The set of arguments for constructing a Backup resource.

func (BackupArgs) ElementType 

func (BackupArgs) ElementType() reflect.Type

type BackupArray 

type BackupArray []BackupInput

func (BackupArray) ElementType 

func (BackupArray) ElementType() reflect.Type

func (BackupArray) ToBackupArrayOutput 

func (i BackupArray) ToBackupArrayOutput() BackupArrayOutput

func (BackupArray) ToBackupArrayOutputWithContext 

func (i BackupArray) ToBackupArrayOutputWithContext(ctx context.Context) BackupArrayOutput

type BackupArrayInput 

type BackupArrayInput interface {
	pulumi.Input

	ToBackupArrayOutput() BackupArrayOutput
	ToBackupArrayOutputWithContext(context.Context) BackupArrayOutput
}

BackupArrayInput is an input type that accepts BackupArray and BackupArrayOutput values. You can construct a concrete instance of `BackupArrayInput` via: 

BackupArray{ BackupArgs{...} }

type BackupArrayOutput 

type BackupArrayOutput struct{ *pulumi.OutputState }

func (BackupArrayOutput) ElementType 

func (BackupArrayOutput) ElementType() reflect.Type

func (BackupArrayOutput) Index 

func (o BackupArrayOutput) Index(i pulumi.IntInput) BackupOutput

func (BackupArrayOutput) ToBackupArrayOutput 

func (o BackupArrayOutput) ToBackupArrayOutput() BackupArrayOutput

func (BackupArrayOutput) ToBackupArrayOutputWithContext 

func (o BackupArrayOutput) ToBackupArrayOutputWithContext(ctx context.Context) BackupArrayOutput

type BackupBackupPolicy 

type BackupBackupPolicy struct {
	// When the backup policy was created.
	CreatedAt *string `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy. Not configurable for now.
	FrequencyUnit *string `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy. Not configurable for now.
	FrequencyValue *float64 `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id *string `pulumi:"id"`
	// When the backup was last run.
	LastRanAt *string `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name *string `pulumi:"name"`
	// When the backup will next run.
	NextRunAt *string `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit string `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue float64 `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay *string `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek *string `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target *string `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt *string `pulumi:"updatedAt"`
}

type BackupBackupPolicyArgs 

type BackupBackupPolicyArgs struct {
	// When the backup policy was created.
	CreatedAt pulumi.StringPtrInput `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy. Not configurable for now.
	FrequencyUnit pulumi.StringPtrInput `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy. Not configurable for now.
	FrequencyValue pulumi.Float64PtrInput `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// When the backup was last run.
	LastRanAt pulumi.StringPtrInput `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// When the backup will next run.
	NextRunAt pulumi.StringPtrInput `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit pulumi.StringInput `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue pulumi.Float64Input `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay pulumi.StringPtrInput `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek pulumi.StringPtrInput `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target pulumi.StringPtrInput `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt pulumi.StringPtrInput `pulumi:"updatedAt"`
}

func (BackupBackupPolicyArgs) ElementType 

func (BackupBackupPolicyArgs) ElementType() reflect.Type

func (BackupBackupPolicyArgs) ToBackupBackupPolicyOutput 

func (i BackupBackupPolicyArgs) ToBackupBackupPolicyOutput() BackupBackupPolicyOutput

func (BackupBackupPolicyArgs) ToBackupBackupPolicyOutputWithContext 

func (i BackupBackupPolicyArgs) ToBackupBackupPolicyOutputWithContext(ctx context.Context) BackupBackupPolicyOutput

func (BackupBackupPolicyArgs) ToBackupBackupPolicyPtrOutput 

func (i BackupBackupPolicyArgs) ToBackupBackupPolicyPtrOutput() BackupBackupPolicyPtrOutput

func (BackupBackupPolicyArgs) ToBackupBackupPolicyPtrOutputWithContext 

func (i BackupBackupPolicyArgs) ToBackupBackupPolicyPtrOutputWithContext(ctx context.Context) BackupBackupPolicyPtrOutput

type BackupBackupPolicyInput 

type BackupBackupPolicyInput interface {
	pulumi.Input

	ToBackupBackupPolicyOutput() BackupBackupPolicyOutput
	ToBackupBackupPolicyOutputWithContext(context.Context) BackupBackupPolicyOutput
}

BackupBackupPolicyInput is an input type that accepts BackupBackupPolicyArgs and BackupBackupPolicyOutput values. You can construct a concrete instance of `BackupBackupPolicyInput` via: 

BackupBackupPolicyArgs{...}

type BackupBackupPolicyOutput 

type BackupBackupPolicyOutput struct{ *pulumi.OutputState }

func (BackupBackupPolicyOutput) CreatedAt 

func (o BackupBackupPolicyOutput) CreatedAt() pulumi.StringPtrOutput

When the backup policy was created.

func (BackupBackupPolicyOutput) ElementType 

func (BackupBackupPolicyOutput) ElementType() reflect.Type

func (BackupBackupPolicyOutput) FrequencyUnit 

func (o BackupBackupPolicyOutput) FrequencyUnit() pulumi.StringPtrOutput

The unit for the frequency of the backup policy. Not configurable for now.

func (BackupBackupPolicyOutput) FrequencyValue 

func (o BackupBackupPolicyOutput) FrequencyValue() pulumi.Float64PtrOutput

A number value for the frequency of the backup policy. Not configurable for now.

func (BackupBackupPolicyOutput) Id 

func (o BackupBackupPolicyOutput) Id() pulumi.StringPtrOutput

The ID of the backup policy.

func (BackupBackupPolicyOutput) LastRanAt 

func (o BackupBackupPolicyOutput) LastRanAt() pulumi.StringPtrOutput

When the backup was last run.

func (BackupBackupPolicyOutput) Name 

func (o BackupBackupPolicyOutput) Name() pulumi.StringPtrOutput

The name of the backup policy.

func (BackupBackupPolicyOutput) NextRunAt 

func (o BackupBackupPolicyOutput) NextRunAt() pulumi.StringPtrOutput

When the backup will next run.

func (BackupBackupPolicyOutput) RetentionUnit 

func (o BackupBackupPolicyOutput) RetentionUnit() pulumi.StringOutput

The unit for the retention period of the backup policy.

func (BackupBackupPolicyOutput) RetentionValue 

func (o BackupBackupPolicyOutput) RetentionValue() pulumi.Float64Output

A number value for the retention period of the backup policy.

func (BackupBackupPolicyOutput) ScheduleDay 

func (o BackupBackupPolicyOutput) ScheduleDay() pulumi.StringPtrOutput

Day of the week that the backup is scheduled.

func (BackupBackupPolicyOutput) ScheduleWeek 

func (o BackupBackupPolicyOutput) ScheduleWeek() pulumi.StringPtrOutput

Week of the month that the backup is scheduled.

func (BackupBackupPolicyOutput) Target 

func (o BackupBackupPolicyOutput) Target() pulumi.StringPtrOutput

Whether the backup policy is for a production or development database, or for a database branch.

func (BackupBackupPolicyOutput) ToBackupBackupPolicyOutput 

func (o BackupBackupPolicyOutput) ToBackupBackupPolicyOutput() BackupBackupPolicyOutput

func (BackupBackupPolicyOutput) ToBackupBackupPolicyOutputWithContext 

func (o BackupBackupPolicyOutput) ToBackupBackupPolicyOutputWithContext(ctx context.Context) BackupBackupPolicyOutput

func (BackupBackupPolicyOutput) ToBackupBackupPolicyPtrOutput 

func (o BackupBackupPolicyOutput) ToBackupBackupPolicyPtrOutput() BackupBackupPolicyPtrOutput

func (BackupBackupPolicyOutput) ToBackupBackupPolicyPtrOutputWithContext 

func (o BackupBackupPolicyOutput) ToBackupBackupPolicyPtrOutputWithContext(ctx context.Context) BackupBackupPolicyPtrOutput

func (BackupBackupPolicyOutput) UpdatedAt 

func (o BackupBackupPolicyOutput) UpdatedAt() pulumi.StringPtrOutput

When the backup policy was last updated.

type BackupBackupPolicyPtrInput 

type BackupBackupPolicyPtrInput interface {
	pulumi.Input

	ToBackupBackupPolicyPtrOutput() BackupBackupPolicyPtrOutput
	ToBackupBackupPolicyPtrOutputWithContext(context.Context) BackupBackupPolicyPtrOutput
}

BackupBackupPolicyPtrInput is an input type that accepts BackupBackupPolicyArgs, BackupBackupPolicyPtr and BackupBackupPolicyPtrOutput values. You can construct a concrete instance of `BackupBackupPolicyPtrInput` via: 

        BackupBackupPolicyArgs{...}

or:

        nil

func BackupBackupPolicyPtr 

func BackupBackupPolicyPtr(v *BackupBackupPolicyArgs) BackupBackupPolicyPtrInput

type BackupBackupPolicyPtrOutput 

type BackupBackupPolicyPtrOutput struct{ *pulumi.OutputState }

func (BackupBackupPolicyPtrOutput) CreatedAt 

func (o BackupBackupPolicyPtrOutput) CreatedAt() pulumi.StringPtrOutput

When the backup policy was created.

func (BackupBackupPolicyPtrOutput) Elem 

func (o BackupBackupPolicyPtrOutput) Elem() BackupBackupPolicyOutput

func (BackupBackupPolicyPtrOutput) ElementType 

func (BackupBackupPolicyPtrOutput) ElementType() reflect.Type

func (BackupBackupPolicyPtrOutput) FrequencyUnit 

func (o BackupBackupPolicyPtrOutput) FrequencyUnit() pulumi.StringPtrOutput

The unit for the frequency of the backup policy. Not configurable for now.

func (BackupBackupPolicyPtrOutput) FrequencyValue 

func (o BackupBackupPolicyPtrOutput) FrequencyValue() pulumi.Float64PtrOutput

A number value for the frequency of the backup policy. Not configurable for now.

func (BackupBackupPolicyPtrOutput) Id 

func (o BackupBackupPolicyPtrOutput) Id() pulumi.StringPtrOutput

The ID of the backup policy.

func (BackupBackupPolicyPtrOutput) LastRanAt 

func (o BackupBackupPolicyPtrOutput) LastRanAt() pulumi.StringPtrOutput

When the backup was last run.

func (BackupBackupPolicyPtrOutput) Name 

func (o BackupBackupPolicyPtrOutput) Name() pulumi.StringPtrOutput

The name of the backup policy.

func (BackupBackupPolicyPtrOutput) NextRunAt 

func (o BackupBackupPolicyPtrOutput) NextRunAt() pulumi.StringPtrOutput

When the backup will next run.

func (BackupBackupPolicyPtrOutput) RetentionUnit 

func (o BackupBackupPolicyPtrOutput) RetentionUnit() pulumi.StringPtrOutput

The unit for the retention period of the backup policy.

func (BackupBackupPolicyPtrOutput) RetentionValue 

func (o BackupBackupPolicyPtrOutput) RetentionValue() pulumi.Float64PtrOutput

A number value for the retention period of the backup policy.

func (BackupBackupPolicyPtrOutput) ScheduleDay 

func (o BackupBackupPolicyPtrOutput) ScheduleDay() pulumi.StringPtrOutput

Day of the week that the backup is scheduled.

func (BackupBackupPolicyPtrOutput) ScheduleWeek 

func (o BackupBackupPolicyPtrOutput) ScheduleWeek() pulumi.StringPtrOutput

Week of the month that the backup is scheduled.

func (BackupBackupPolicyPtrOutput) Target 

func (o BackupBackupPolicyPtrOutput) Target() pulumi.StringPtrOutput

Whether the backup policy is for a production or development database, or for a database branch.

func (BackupBackupPolicyPtrOutput) ToBackupBackupPolicyPtrOutput 

func (o BackupBackupPolicyPtrOutput) ToBackupBackupPolicyPtrOutput() BackupBackupPolicyPtrOutput

func (BackupBackupPolicyPtrOutput) ToBackupBackupPolicyPtrOutputWithContext 

func (o BackupBackupPolicyPtrOutput) ToBackupBackupPolicyPtrOutputWithContext(ctx context.Context) BackupBackupPolicyPtrOutput

func (BackupBackupPolicyPtrOutput) UpdatedAt 

func (o BackupBackupPolicyPtrOutput) UpdatedAt() pulumi.StringPtrOutput

When the backup policy was last updated.

type BackupInput 

type BackupInput interface {
	pulumi.Input

	ToBackupOutput() BackupOutput
	ToBackupOutputWithContext(ctx context.Context) BackupOutput
}

type BackupMap 

type BackupMap map[string]BackupInput

func (BackupMap) ElementType 

func (BackupMap) ElementType() reflect.Type

func (BackupMap) ToBackupMapOutput 

func (i BackupMap) ToBackupMapOutput() BackupMapOutput

func (BackupMap) ToBackupMapOutputWithContext 

func (i BackupMap) ToBackupMapOutputWithContext(ctx context.Context) BackupMapOutput

type BackupMapInput 

type BackupMapInput interface {
	pulumi.Input

	ToBackupMapOutput() BackupMapOutput
	ToBackupMapOutputWithContext(context.Context) BackupMapOutput
}

BackupMapInput is an input type that accepts BackupMap and BackupMapOutput values. You can construct a concrete instance of `BackupMapInput` via: 

BackupMap{ "key": BackupArgs{...} }

type BackupMapOutput 

type BackupMapOutput struct{ *pulumi.OutputState }

func (BackupMapOutput) ElementType 

func (BackupMapOutput) ElementType() reflect.Type

func (BackupMapOutput) MapIndex 

func (o BackupMapOutput) MapIndex(k pulumi.StringInput) BackupOutput

func (BackupMapOutput) ToBackupMapOutput 

func (o BackupMapOutput) ToBackupMapOutput() BackupMapOutput

func (BackupMapOutput) ToBackupMapOutputWithContext 

func (o BackupMapOutput) ToBackupMapOutputWithContext(ctx context.Context) BackupMapOutput

type BackupOutput 

type BackupOutput struct{ *pulumi.OutputState }

func (BackupOutput) Actor 

func (o BackupOutput) Actor() BackupActorOutput

.

func (BackupOutput) BackupPolicy 

func (o BackupOutput) BackupPolicy() BackupBackupPolicyOutput

The policy used by the backup.

func (BackupOutput) Branch 

func (o BackupOutput) Branch() pulumi.StringOutput

The branch being backed up.

func (BackupOutput) CreatedAt 

func (o BackupOutput) CreatedAt() pulumi.StringOutput

When the backup was created.

func (BackupOutput) Database 

func (o BackupOutput) Database() pulumi.StringOutput

The database to which the branch being backed up belongs to.

func (BackupOutput) ElementType 

func (BackupOutput) ElementType() reflect.Type

func (BackupOutput) EstimatedStorageCost 

func (o BackupOutput) EstimatedStorageCost() pulumi.StringOutput

The estimated storage cost of the backup.

func (BackupOutput) Name 

func (o BackupOutput) Name() pulumi.StringOutput

The name of the backup.

func (BackupOutput) Organization 

func (o BackupOutput) Organization() pulumi.StringOutput

The organization in which the database branch being backed up belongs to.

func (BackupOutput) Required 

func (o BackupOutput) Required() pulumi.BoolOutput

Whether or not the backup policy is required.

func (BackupOutput) RestoredBranches 

func (o BackupOutput) RestoredBranches() pulumi.StringArrayOutput

Branches that have been restored with this backup.

func (BackupOutput) Size 

func (o BackupOutput) Size() pulumi.Float64Output

The size of the backup.

func (BackupOutput) State 

func (o BackupOutput) State() pulumi.StringOutput

The current state of the backup.

func (BackupOutput) ToBackupOutput 

func (o BackupOutput) ToBackupOutput() BackupOutput

func (BackupOutput) ToBackupOutputWithContext 

func (o BackupOutput) ToBackupOutputWithContext(ctx context.Context) BackupOutput

func (BackupOutput) UpdatedAt 

func (o BackupOutput) UpdatedAt() pulumi.StringOutput

When the backup was last updated.

type BackupState 

type BackupState struct {
	// .
	Actor BackupActorPtrInput
	// The policy used by the backup.
	BackupPolicy BackupBackupPolicyPtrInput
	// The branch being backed up.
	Branch pulumi.StringPtrInput
	// When the backup was created.
	CreatedAt pulumi.StringPtrInput
	// The database to which the branch being backed up belongs to.
	Database pulumi.StringPtrInput
	// The estimated storage cost of the backup.
	EstimatedStorageCost pulumi.StringPtrInput
	// The name of the backup.
	Name pulumi.StringPtrInput
	// The organization in which the database branch being backed up belongs to.
	Organization pulumi.StringPtrInput
	// Whether or not the backup policy is required.
	Required pulumi.BoolPtrInput
	// Branches that have been restored with this backup.
	RestoredBranches pulumi.StringArrayInput
	// The size of the backup.
	Size pulumi.Float64PtrInput
	// The current state of the backup.
	State pulumi.StringPtrInput
	// When the backup was last updated.
	UpdatedAt pulumi.StringPtrInput
}

func (BackupState) ElementType 

func (BackupState) ElementType() reflect.Type

type Branch 

type Branch struct {
	pulumi.CustomResourceState

	// The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.
	AccessHostUrl pulumi.StringOutput `pulumi:"accessHostUrl"`
	// The actor who created this branch.
	Actor BranchActorOutput `pulumi:"actor"`
	// The SKU representing the branch's cluster size.
	ClusterRateName pulumi.StringOutput `pulumi:"clusterRateName"`
	// When the branch was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// The database this branch belongs to.
	Database pulumi.StringOutput `pulumi:"database"`
	// Planetscale app URL for the branch.
	HtmlUrl pulumi.StringOutput `pulumi:"htmlUrl"`
	// The ID of the backup from which the branch was restored.
	InitialRestoreId pulumi.StringOutput `pulumi:"initialRestoreId"`
	// The MySQL address for the branch.
	MysqlAddress pulumi.StringOutput `pulumi:"mysqlAddress"`
	// The address of the MySQL provider for the branch.
	MysqlEdgeAddress pulumi.StringOutput `pulumi:"mysqlEdgeAddress"`
	// The name of the branch.
	Name pulumi.StringOutput `pulumi:"name"`
	// The organization this branch belongs to.
	Organization pulumi.StringOutput `pulumi:"organization"`
	// The name of the parent branch from which the branch was created.
	ParentBranch pulumi.StringOutput `pulumi:"parentBranch"`
	// Whether or not the branch is a production branch.
	Production pulumi.BoolOutput `pulumi:"production"`
	// Whether or not the branch is ready to serve queries.
	Ready pulumi.BoolOutput `pulumi:"ready"`
	// The region in which this branch lives.
	Region BranchRegionOutput `pulumi:"region"`
	// When a user last marked a backup restore checklist as completed.
	RestoreChecklistCompletedAt pulumi.StringOutput `pulumi:"restoreChecklistCompletedAt"`
	// todo
	RestoredFromBranch BranchRestoredFromBranchOutput `pulumi:"restoredFromBranch"`
	// When the schema for the branch was last updated.
	SchemaLastUpdatedAt pulumi.StringOutput `pulumi:"schemaLastUpdatedAt"`
	// The number of shards in the branch.
	ShardCount pulumi.Float64Output `pulumi:"shardCount"`
	// Whether or not the branch is sharded.
	Sharded pulumi.BoolOutput `pulumi:"sharded"`
	// When the branch was last updated.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
}

A PlanetScale branch.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.NewBranch(ctx, "example", &planetscale.BranchArgs{
			Database:     pulumi.String("example_db"),
			Organization: pulumi.String("example"),
			ParentBranch: pulumi.String("main"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetBranch 

func GetBranch(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BranchState, opts ...pulumi.ResourceOption) (*Branch, error)

GetBranch gets an existing Branch resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBranch 

func NewBranch(ctx *pulumi.Context,
	name string, args *BranchArgs, opts ...pulumi.ResourceOption) (*Branch, error)

NewBranch registers a new resource with the given unique name, arguments, and options.

func (*Branch) ElementType 

func (*Branch) ElementType() reflect.Type

func (*Branch) ToBranchOutput 

func (i *Branch) ToBranchOutput() BranchOutput

func (*Branch) ToBranchOutputWithContext 

func (i *Branch) ToBranchOutputWithContext(ctx context.Context) BranchOutput

type BranchActor 

type BranchActor struct {
	// The URL of the actor's avatar
	AvatarUrl *string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName *string `pulumi:"displayName"`
	// The ID of the actor
	Id *string `pulumi:"id"`
}

type BranchActorArgs 

type BranchActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringPtrInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringPtrInput `pulumi:"id"`
}

func (BranchActorArgs) ElementType 

func (BranchActorArgs) ElementType() reflect.Type

func (BranchActorArgs) ToBranchActorOutput 

func (i BranchActorArgs) ToBranchActorOutput() BranchActorOutput

func (BranchActorArgs) ToBranchActorOutputWithContext 

func (i BranchActorArgs) ToBranchActorOutputWithContext(ctx context.Context) BranchActorOutput

func (BranchActorArgs) ToBranchActorPtrOutput 

func (i BranchActorArgs) ToBranchActorPtrOutput() BranchActorPtrOutput

func (BranchActorArgs) ToBranchActorPtrOutputWithContext 

func (i BranchActorArgs) ToBranchActorPtrOutputWithContext(ctx context.Context) BranchActorPtrOutput

type BranchActorInput 

type BranchActorInput interface {
	pulumi.Input

	ToBranchActorOutput() BranchActorOutput
	ToBranchActorOutputWithContext(context.Context) BranchActorOutput
}

BranchActorInput is an input type that accepts BranchActorArgs and BranchActorOutput values. You can construct a concrete instance of `BranchActorInput` via: 

BranchActorArgs{...}

type BranchActorOutput 

type BranchActorOutput struct{ *pulumi.OutputState }

func (BranchActorOutput) AvatarUrl 

func (o BranchActorOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (BranchActorOutput) DisplayName 

func (o BranchActorOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (BranchActorOutput) ElementType 

func (BranchActorOutput) ElementType() reflect.Type

func (BranchActorOutput) Id 

func (o BranchActorOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (BranchActorOutput) ToBranchActorOutput 

func (o BranchActorOutput) ToBranchActorOutput() BranchActorOutput

func (BranchActorOutput) ToBranchActorOutputWithContext 

func (o BranchActorOutput) ToBranchActorOutputWithContext(ctx context.Context) BranchActorOutput

func (BranchActorOutput) ToBranchActorPtrOutput 

func (o BranchActorOutput) ToBranchActorPtrOutput() BranchActorPtrOutput

func (BranchActorOutput) ToBranchActorPtrOutputWithContext 

func (o BranchActorOutput) ToBranchActorPtrOutputWithContext(ctx context.Context) BranchActorPtrOutput

type BranchActorPtrInput 

type BranchActorPtrInput interface {
	pulumi.Input

	ToBranchActorPtrOutput() BranchActorPtrOutput
	ToBranchActorPtrOutputWithContext(context.Context) BranchActorPtrOutput
}

BranchActorPtrInput is an input type that accepts BranchActorArgs, BranchActorPtr and BranchActorPtrOutput values. You can construct a concrete instance of `BranchActorPtrInput` via: 

        BranchActorArgs{...}

or:

        nil

func BranchActorPtr 

func BranchActorPtr(v *BranchActorArgs) BranchActorPtrInput

type BranchActorPtrOutput 

type BranchActorPtrOutput struct{ *pulumi.OutputState }

func (BranchActorPtrOutput) AvatarUrl 

func (o BranchActorPtrOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (BranchActorPtrOutput) DisplayName 

func (o BranchActorPtrOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (BranchActorPtrOutput) Elem 

func (o BranchActorPtrOutput) Elem() BranchActorOutput

func (BranchActorPtrOutput) ElementType 

func (BranchActorPtrOutput) ElementType() reflect.Type

func (BranchActorPtrOutput) Id 

func (o BranchActorPtrOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (BranchActorPtrOutput) ToBranchActorPtrOutput 

func (o BranchActorPtrOutput) ToBranchActorPtrOutput() BranchActorPtrOutput

func (BranchActorPtrOutput) ToBranchActorPtrOutputWithContext 

func (o BranchActorPtrOutput) ToBranchActorPtrOutputWithContext(ctx context.Context) BranchActorPtrOutput

type BranchArgs 

type BranchArgs struct {
	// The database this branch belongs to.
	Database pulumi.StringInput
	// The name of the branch.
	Name pulumi.StringPtrInput
	// The organization this branch belongs to.
	Organization pulumi.StringInput
	// The name of the parent branch from which the branch was created.
	ParentBranch pulumi.StringInput
	// Whether or not the branch is a production branch.
	Production pulumi.BoolPtrInput
}

The set of arguments for constructing a Branch resource.

func (BranchArgs) ElementType 

func (BranchArgs) ElementType() reflect.Type

type BranchArray 

type BranchArray []BranchInput

func (BranchArray) ElementType 

func (BranchArray) ElementType() reflect.Type

func (BranchArray) ToBranchArrayOutput 

func (i BranchArray) ToBranchArrayOutput() BranchArrayOutput

func (BranchArray) ToBranchArrayOutputWithContext 

func (i BranchArray) ToBranchArrayOutputWithContext(ctx context.Context) BranchArrayOutput

type BranchArrayInput 

type BranchArrayInput interface {
	pulumi.Input

	ToBranchArrayOutput() BranchArrayOutput
	ToBranchArrayOutputWithContext(context.Context) BranchArrayOutput
}

BranchArrayInput is an input type that accepts BranchArray and BranchArrayOutput values. You can construct a concrete instance of `BranchArrayInput` via: 

BranchArray{ BranchArgs{...} }

type BranchArrayOutput 

type BranchArrayOutput struct{ *pulumi.OutputState }

func (BranchArrayOutput) ElementType 

func (BranchArrayOutput) ElementType() reflect.Type

func (BranchArrayOutput) Index 

func (o BranchArrayOutput) Index(i pulumi.IntInput) BranchOutput

func (BranchArrayOutput) ToBranchArrayOutput 

func (o BranchArrayOutput) ToBranchArrayOutput() BranchArrayOutput

func (BranchArrayOutput) ToBranchArrayOutputWithContext 

func (o BranchArrayOutput) ToBranchArrayOutputWithContext(ctx context.Context) BranchArrayOutput

type BranchInput 

type BranchInput interface {
	pulumi.Input

	ToBranchOutput() BranchOutput
	ToBranchOutputWithContext(ctx context.Context) BranchOutput
}

type BranchMap 

type BranchMap map[string]BranchInput

func (BranchMap) ElementType 

func (BranchMap) ElementType() reflect.Type

func (BranchMap) ToBranchMapOutput 

func (i BranchMap) ToBranchMapOutput() BranchMapOutput

func (BranchMap) ToBranchMapOutputWithContext 

func (i BranchMap) ToBranchMapOutputWithContext(ctx context.Context) BranchMapOutput

type BranchMapInput 

type BranchMapInput interface {
	pulumi.Input

	ToBranchMapOutput() BranchMapOutput
	ToBranchMapOutputWithContext(context.Context) BranchMapOutput
}

BranchMapInput is an input type that accepts BranchMap and BranchMapOutput values. You can construct a concrete instance of `BranchMapInput` via: 

BranchMap{ "key": BranchArgs{...} }

type BranchMapOutput 

type BranchMapOutput struct{ *pulumi.OutputState }

func (BranchMapOutput) ElementType 

func (BranchMapOutput) ElementType() reflect.Type

func (BranchMapOutput) MapIndex 

func (o BranchMapOutput) MapIndex(k pulumi.StringInput) BranchOutput

func (BranchMapOutput) ToBranchMapOutput 

func (o BranchMapOutput) ToBranchMapOutput() BranchMapOutput

func (BranchMapOutput) ToBranchMapOutputWithContext 

func (o BranchMapOutput) ToBranchMapOutputWithContext(ctx context.Context) BranchMapOutput

type BranchOutput 

type BranchOutput struct{ *pulumi.OutputState }

func (BranchOutput) AccessHostUrl 

func (o BranchOutput) AccessHostUrl() pulumi.StringOutput

The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.

func (BranchOutput) Actor 

func (o BranchOutput) Actor() BranchActorOutput

The actor who created this branch.

func (BranchOutput) ClusterRateName 

func (o BranchOutput) ClusterRateName() pulumi.StringOutput

The SKU representing the branch's cluster size.

func (BranchOutput) CreatedAt 

func (o BranchOutput) CreatedAt() pulumi.StringOutput

When the branch was created.

func (BranchOutput) Database 

func (o BranchOutput) Database() pulumi.StringOutput

The database this branch belongs to.

func (BranchOutput) ElementType 

func (BranchOutput) ElementType() reflect.Type

func (BranchOutput) HtmlUrl 

func (o BranchOutput) HtmlUrl() pulumi.StringOutput

Planetscale app URL for the branch.

func (BranchOutput) InitialRestoreId 

func (o BranchOutput) InitialRestoreId() pulumi.StringOutput

The ID of the backup from which the branch was restored.

func (BranchOutput) MysqlAddress 

func (o BranchOutput) MysqlAddress() pulumi.StringOutput

The MySQL address for the branch.

func (BranchOutput) MysqlEdgeAddress 

func (o BranchOutput) MysqlEdgeAddress() pulumi.StringOutput

The address of the MySQL provider for the branch.

func (BranchOutput) Name 

func (o BranchOutput) Name() pulumi.StringOutput

The name of the branch.

func (BranchOutput) Organization 

func (o BranchOutput) Organization() pulumi.StringOutput

The organization this branch belongs to.

func (BranchOutput) ParentBranch 

func (o BranchOutput) ParentBranch() pulumi.StringOutput

The name of the parent branch from which the branch was created.

func (BranchOutput) Production 

func (o BranchOutput) Production() pulumi.BoolOutput

Whether or not the branch is a production branch.

func (BranchOutput) Ready 

func (o BranchOutput) Ready() pulumi.BoolOutput

Whether or not the branch is ready to serve queries.

func (BranchOutput) Region 

func (o BranchOutput) Region() BranchRegionOutput

The region in which this branch lives.

func (BranchOutput) RestoreChecklistCompletedAt 

func (o BranchOutput) RestoreChecklistCompletedAt() pulumi.StringOutput

When a user last marked a backup restore checklist as completed.

func (BranchOutput) RestoredFromBranch 

func (o BranchOutput) RestoredFromBranch() BranchRestoredFromBranchOutput

todo

func (BranchOutput) SchemaLastUpdatedAt 

func (o BranchOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the schema for the branch was last updated.

func (BranchOutput) ShardCount 

func (o BranchOutput) ShardCount() pulumi.Float64Output

The number of shards in the branch.

func (BranchOutput) Sharded 

func (o BranchOutput) Sharded() pulumi.BoolOutput

Whether or not the branch is sharded.

func (BranchOutput) ToBranchOutput 

func (o BranchOutput) ToBranchOutput() BranchOutput

func (BranchOutput) ToBranchOutputWithContext 

func (o BranchOutput) ToBranchOutputWithContext(ctx context.Context) BranchOutput

func (BranchOutput) UpdatedAt 

func (o BranchOutput) UpdatedAt() pulumi.StringOutput

When the branch was last updated.

type BranchRegion 

type BranchRegion struct {
	// Name of the region.
	DisplayName *string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled *bool `pulumi:"enabled"`
	// The ID of the region.
	Id *string `pulumi:"id"`
	// Location of the region.
	Location *string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider *string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug *string `pulumi:"slug"`
}

type BranchRegionArgs 

type BranchRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringPtrInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringPtrInput `pulumi:"slug"`
}

func (BranchRegionArgs) ElementType 

func (BranchRegionArgs) ElementType() reflect.Type

func (BranchRegionArgs) ToBranchRegionOutput 

func (i BranchRegionArgs) ToBranchRegionOutput() BranchRegionOutput

func (BranchRegionArgs) ToBranchRegionOutputWithContext 

func (i BranchRegionArgs) ToBranchRegionOutputWithContext(ctx context.Context) BranchRegionOutput

func (BranchRegionArgs) ToBranchRegionPtrOutput 

func (i BranchRegionArgs) ToBranchRegionPtrOutput() BranchRegionPtrOutput

func (BranchRegionArgs) ToBranchRegionPtrOutputWithContext 

func (i BranchRegionArgs) ToBranchRegionPtrOutputWithContext(ctx context.Context) BranchRegionPtrOutput

type BranchRegionInput 

type BranchRegionInput interface {
	pulumi.Input

	ToBranchRegionOutput() BranchRegionOutput
	ToBranchRegionOutputWithContext(context.Context) BranchRegionOutput
}

BranchRegionInput is an input type that accepts BranchRegionArgs and BranchRegionOutput values. You can construct a concrete instance of `BranchRegionInput` via: 

BranchRegionArgs{...}

type BranchRegionOutput 

type BranchRegionOutput struct{ *pulumi.OutputState }

func (BranchRegionOutput) DisplayName 

func (o BranchRegionOutput) DisplayName() pulumi.StringPtrOutput

Name of the region.

func (BranchRegionOutput) ElementType 

func (BranchRegionOutput) ElementType() reflect.Type

func (BranchRegionOutput) Enabled 

func (o BranchRegionOutput) Enabled() pulumi.BoolPtrOutput

Whether or not the region is currently active.

func (BranchRegionOutput) Id 

func (o BranchRegionOutput) Id() pulumi.StringPtrOutput

The ID of the region.

func (BranchRegionOutput) Location 

func (o BranchRegionOutput) Location() pulumi.StringPtrOutput

Location of the region.

func (BranchRegionOutput) Provider 

func (o BranchRegionOutput) Provider() pulumi.StringPtrOutput

Provider for the region (ex. AWS).

func (BranchRegionOutput) PublicIpAddresses 

func (o BranchRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (BranchRegionOutput) Slug 

func (o BranchRegionOutput) Slug() pulumi.StringPtrOutput

The slug of the region.

func (BranchRegionOutput) ToBranchRegionOutput 

func (o BranchRegionOutput) ToBranchRegionOutput() BranchRegionOutput

func (BranchRegionOutput) ToBranchRegionOutputWithContext 

func (o BranchRegionOutput) ToBranchRegionOutputWithContext(ctx context.Context) BranchRegionOutput

func (BranchRegionOutput) ToBranchRegionPtrOutput 

func (o BranchRegionOutput) ToBranchRegionPtrOutput() BranchRegionPtrOutput

func (BranchRegionOutput) ToBranchRegionPtrOutputWithContext 

func (o BranchRegionOutput) ToBranchRegionPtrOutputWithContext(ctx context.Context) BranchRegionPtrOutput

type BranchRegionPtrInput 

type BranchRegionPtrInput interface {
	pulumi.Input

	ToBranchRegionPtrOutput() BranchRegionPtrOutput
	ToBranchRegionPtrOutputWithContext(context.Context) BranchRegionPtrOutput
}

BranchRegionPtrInput is an input type that accepts BranchRegionArgs, BranchRegionPtr and BranchRegionPtrOutput values. You can construct a concrete instance of `BranchRegionPtrInput` via: 

        BranchRegionArgs{...}

or:

        nil

func BranchRegionPtr 

func BranchRegionPtr(v *BranchRegionArgs) BranchRegionPtrInput

type BranchRegionPtrOutput 

type BranchRegionPtrOutput struct{ *pulumi.OutputState }

func (BranchRegionPtrOutput) DisplayName 

func (o BranchRegionPtrOutput) DisplayName() pulumi.StringPtrOutput

Name of the region.

func (BranchRegionPtrOutput) Elem 

func (o BranchRegionPtrOutput) Elem() BranchRegionOutput

func (BranchRegionPtrOutput) ElementType 

func (BranchRegionPtrOutput) ElementType() reflect.Type

func (BranchRegionPtrOutput) Enabled 

func (o BranchRegionPtrOutput) Enabled() pulumi.BoolPtrOutput

Whether or not the region is currently active.

func (BranchRegionPtrOutput) Id 

func (o BranchRegionPtrOutput) Id() pulumi.StringPtrOutput

The ID of the region.

func (BranchRegionPtrOutput) Location 

func (o BranchRegionPtrOutput) Location() pulumi.StringPtrOutput

Location of the region.

func (BranchRegionPtrOutput) Provider 

func (o BranchRegionPtrOutput) Provider() pulumi.StringPtrOutput

Provider for the region (ex. AWS).

func (BranchRegionPtrOutput) PublicIpAddresses 

func (o BranchRegionPtrOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (BranchRegionPtrOutput) Slug 

func (o BranchRegionPtrOutput) Slug() pulumi.StringPtrOutput

The slug of the region.

func (BranchRegionPtrOutput) ToBranchRegionPtrOutput 

func (o BranchRegionPtrOutput) ToBranchRegionPtrOutput() BranchRegionPtrOutput

func (BranchRegionPtrOutput) ToBranchRegionPtrOutputWithContext 

func (o BranchRegionPtrOutput) ToBranchRegionPtrOutputWithContext(ctx context.Context) BranchRegionPtrOutput

type BranchRestoredFromBranch 

type BranchRestoredFromBranch struct {
	// When the resource was created.
	CreatedAt *string `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt *string `pulumi:"deletedAt"`
	// The ID for the resource.
	Id *string `pulumi:"id"`
	// The name for the resource.
	Name *string `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt *string `pulumi:"updatedAt"`
}

type BranchRestoredFromBranchArgs 

type BranchRestoredFromBranchArgs struct {
	// When the resource was created.
	CreatedAt pulumi.StringPtrInput `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt pulumi.StringPtrInput `pulumi:"deletedAt"`
	// The ID for the resource.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The name for the resource.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt pulumi.StringPtrInput `pulumi:"updatedAt"`
}

func (BranchRestoredFromBranchArgs) ElementType 

func (BranchRestoredFromBranchArgs) ElementType() reflect.Type

func (BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchOutput 

func (i BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchOutput() BranchRestoredFromBranchOutput

func (BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchOutputWithContext 

func (i BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchOutputWithContext(ctx context.Context) BranchRestoredFromBranchOutput

func (BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchPtrOutput 

func (i BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchPtrOutput() BranchRestoredFromBranchPtrOutput

func (BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchPtrOutputWithContext 

func (i BranchRestoredFromBranchArgs) ToBranchRestoredFromBranchPtrOutputWithContext(ctx context.Context) BranchRestoredFromBranchPtrOutput

type BranchRestoredFromBranchInput 

type BranchRestoredFromBranchInput interface {
	pulumi.Input

	ToBranchRestoredFromBranchOutput() BranchRestoredFromBranchOutput
	ToBranchRestoredFromBranchOutputWithContext(context.Context) BranchRestoredFromBranchOutput
}

BranchRestoredFromBranchInput is an input type that accepts BranchRestoredFromBranchArgs and BranchRestoredFromBranchOutput values. You can construct a concrete instance of `BranchRestoredFromBranchInput` via: 

BranchRestoredFromBranchArgs{...}

type BranchRestoredFromBranchOutput 

type BranchRestoredFromBranchOutput struct{ *pulumi.OutputState }

func (BranchRestoredFromBranchOutput) CreatedAt 

func (o BranchRestoredFromBranchOutput) CreatedAt() pulumi.StringPtrOutput

When the resource was created.

func (BranchRestoredFromBranchOutput) DeletedAt 

func (o BranchRestoredFromBranchOutput) DeletedAt() pulumi.StringPtrOutput

When the resource was deleted, if deleted.

func (BranchRestoredFromBranchOutput) ElementType 

func (BranchRestoredFromBranchOutput) ElementType() reflect.Type

func (BranchRestoredFromBranchOutput) Id 

func (o BranchRestoredFromBranchOutput) Id() pulumi.StringPtrOutput

The ID for the resource.

func (BranchRestoredFromBranchOutput) Name 

func (o BranchRestoredFromBranchOutput) Name() pulumi.StringPtrOutput

The name for the resource.

func (BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchOutput 

func (o BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchOutput() BranchRestoredFromBranchOutput

func (BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchOutputWithContext 

func (o BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchOutputWithContext(ctx context.Context) BranchRestoredFromBranchOutput

func (BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchPtrOutput 

func (o BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchPtrOutput() BranchRestoredFromBranchPtrOutput

func (BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchPtrOutputWithContext 

func (o BranchRestoredFromBranchOutput) ToBranchRestoredFromBranchPtrOutputWithContext(ctx context.Context) BranchRestoredFromBranchPtrOutput

func (BranchRestoredFromBranchOutput) UpdatedAt 

func (o BranchRestoredFromBranchOutput) UpdatedAt() pulumi.StringPtrOutput

When the resource was last updated.

type BranchRestoredFromBranchPtrInput 

type BranchRestoredFromBranchPtrInput interface {
	pulumi.Input

	ToBranchRestoredFromBranchPtrOutput() BranchRestoredFromBranchPtrOutput
	ToBranchRestoredFromBranchPtrOutputWithContext(context.Context) BranchRestoredFromBranchPtrOutput
}

BranchRestoredFromBranchPtrInput is an input type that accepts BranchRestoredFromBranchArgs, BranchRestoredFromBranchPtr and BranchRestoredFromBranchPtrOutput values. You can construct a concrete instance of `BranchRestoredFromBranchPtrInput` via: 

        BranchRestoredFromBranchArgs{...}

or:

        nil

func BranchRestoredFromBranchPtr 

func BranchRestoredFromBranchPtr(v *BranchRestoredFromBranchArgs) BranchRestoredFromBranchPtrInput

type BranchRestoredFromBranchPtrOutput 

type BranchRestoredFromBranchPtrOutput struct{ *pulumi.OutputState }

func (BranchRestoredFromBranchPtrOutput) CreatedAt 

func (o BranchRestoredFromBranchPtrOutput) CreatedAt() pulumi.StringPtrOutput

When the resource was created.

func (BranchRestoredFromBranchPtrOutput) DeletedAt 

func (o BranchRestoredFromBranchPtrOutput) DeletedAt() pulumi.StringPtrOutput

When the resource was deleted, if deleted.

func (BranchRestoredFromBranchPtrOutput) Elem 

func (o BranchRestoredFromBranchPtrOutput) Elem() BranchRestoredFromBranchOutput

func (BranchRestoredFromBranchPtrOutput) ElementType 

func (BranchRestoredFromBranchPtrOutput) ElementType() reflect.Type

func (BranchRestoredFromBranchPtrOutput) Id 

func (o BranchRestoredFromBranchPtrOutput) Id() pulumi.StringPtrOutput

The ID for the resource.

func (BranchRestoredFromBranchPtrOutput) Name 

func (o BranchRestoredFromBranchPtrOutput) Name() pulumi.StringPtrOutput

The name for the resource.

func (BranchRestoredFromBranchPtrOutput) ToBranchRestoredFromBranchPtrOutput 

func (o BranchRestoredFromBranchPtrOutput) ToBranchRestoredFromBranchPtrOutput() BranchRestoredFromBranchPtrOutput

func (BranchRestoredFromBranchPtrOutput) ToBranchRestoredFromBranchPtrOutputWithContext 

func (o BranchRestoredFromBranchPtrOutput) ToBranchRestoredFromBranchPtrOutputWithContext(ctx context.Context) BranchRestoredFromBranchPtrOutput

func (BranchRestoredFromBranchPtrOutput) UpdatedAt 

func (o BranchRestoredFromBranchPtrOutput) UpdatedAt() pulumi.StringPtrOutput

When the resource was last updated.

type BranchState 

type BranchState struct {
	// The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.
	AccessHostUrl pulumi.StringPtrInput
	// The actor who created this branch.
	Actor BranchActorPtrInput
	// The SKU representing the branch's cluster size.
	ClusterRateName pulumi.StringPtrInput
	// When the branch was created.
	CreatedAt pulumi.StringPtrInput
	// The database this branch belongs to.
	Database pulumi.StringPtrInput
	// Planetscale app URL for the branch.
	HtmlUrl pulumi.StringPtrInput
	// The ID of the backup from which the branch was restored.
	InitialRestoreId pulumi.StringPtrInput
	// The MySQL address for the branch.
	MysqlAddress pulumi.StringPtrInput
	// The address of the MySQL provider for the branch.
	MysqlEdgeAddress pulumi.StringPtrInput
	// The name of the branch.
	Name pulumi.StringPtrInput
	// The organization this branch belongs to.
	Organization pulumi.StringPtrInput
	// The name of the parent branch from which the branch was created.
	ParentBranch pulumi.StringPtrInput
	// Whether or not the branch is a production branch.
	Production pulumi.BoolPtrInput
	// Whether or not the branch is ready to serve queries.
	Ready pulumi.BoolPtrInput
	// The region in which this branch lives.
	Region BranchRegionPtrInput
	// When a user last marked a backup restore checklist as completed.
	RestoreChecklistCompletedAt pulumi.StringPtrInput
	// todo
	RestoredFromBranch BranchRestoredFromBranchPtrInput
	// When the schema for the branch was last updated.
	SchemaLastUpdatedAt pulumi.StringPtrInput
	// The number of shards in the branch.
	ShardCount pulumi.Float64PtrInput
	// Whether or not the branch is sharded.
	Sharded pulumi.BoolPtrInput
	// When the branch was last updated.
	UpdatedAt pulumi.StringPtrInput
}

func (BranchState) ElementType 

func (BranchState) ElementType() reflect.Type

type Database 

type Database struct {
	pulumi.CustomResourceState

	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching pulumi.BoolOutput `pulumi:"allowDataBranching"`
	// If the database has reached its backup restored branch limit.
	AtBackupRestoreBranchesLimit pulumi.BoolOutput `pulumi:"atBackupRestoreBranchesLimit"`
	// If the database has reached its development branch limit.
	AtDevelopmentBranchLimit pulumi.BoolOutput `pulumi:"atDevelopmentBranchLimit"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations pulumi.BoolOutput `pulumi:"automaticMigrations"`
	// The total number of database branches.
	BranchesCount pulumi.Float64Output `pulumi:"branchesCount"`
	// The URL to retrieve this database's branches via the API.
	BranchesUrl pulumi.StringOutput `pulumi:"branchesUrl"`
	// The size of the database cluster plan.
	ClusterSize pulumi.StringOutput `pulumi:"clusterSize"`
	// When the database was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// If the database was created from an import, describes the import process.
	DataImport DatabaseDataImportOutput `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch pulumi.StringOutput `pulumi:"defaultBranch"`
	// Number of read only regions in the default branch.
	DefaultBranchReadOnlyRegionsCount pulumi.Float64Output `pulumi:"defaultBranchReadOnlyRegionsCount"`
	// Number of shards in the default branch.
	DefaultBranchShardCount pulumi.Float64Output `pulumi:"defaultBranchShardCount"`
	// Number of tables in the default branch schema.
	DefaultBranchTableCount pulumi.Float64Output `pulumi:"defaultBranchTableCount"`
	// The total number of database development branches.
	DevelopmentBranchesCount pulumi.Float64Output `pulumi:"developmentBranchesCount"`
	// The total number of database development branches.
	HtmlUrl pulumi.StringOutput `pulumi:"htmlUrl"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries pulumi.BoolOutput `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount pulumi.Float64Output `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework pulumi.StringOutput `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName pulumi.StringOutput `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion pulumi.BoolOutput `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name pulumi.StringOutput `pulumi:"name"`
	// The organization this database belongs to.
	Organization pulumi.StringOutput `pulumi:"organization"`
	// The database plan.
	Plan pulumi.StringOutput `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole pulumi.BoolOutput `pulumi:"productionBranchWebConsole"`
	// The total number of database production branches.
	ProductionBranchesCount pulumi.Float64Output `pulumi:"productionBranchesCount"`
	// If the database is ready to be used.
	Ready pulumi.BoolOutput `pulumi:"ready"`
	// The region the database lives in.
	Region pulumi.StringOutput `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy pulumi.BoolOutput `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion pulumi.BoolOutput `pulumi:"restrictBranchRegion"`
	// When the default branch schema was last changed.
	SchemaLastUpdatedAt pulumi.StringOutput `pulumi:"schemaLastUpdatedAt"`
	// If the database is sharded.
	Sharded pulumi.BoolOutput `pulumi:"sharded"`
	// State of the database.
	State pulumi.StringOutput `pulumi:"state"`
	// When the database was last updated.
	UpdatedAt pulumi.StringOutput `pulumi:"updatedAt"`
	// The URL to the database API endpoint.
	Url pulumi.StringOutput `pulumi:"url"`
}

A PlanetScale database.

Known limitations: - When the provider is configured with a service token, the service token needs to manually be granted permission on this database resource. This can be done in the UI or via the CLI (`pscale service-token add-access`).

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.NewDatabase(ctx, "example", &planetscale.DatabaseArgs{
			Organization: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetDatabase 

func GetDatabase(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DatabaseState, opts ...pulumi.ResourceOption) (*Database, error)

GetDatabase gets an existing Database resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDatabase 

func NewDatabase(ctx *pulumi.Context,
	name string, args *DatabaseArgs, opts ...pulumi.ResourceOption) (*Database, error)

NewDatabase registers a new resource with the given unique name, arguments, and options.

func (*Database) ElementType 

func (*Database) ElementType() reflect.Type

func (*Database) ToDatabaseOutput 

func (i *Database) ToDatabaseOutput() DatabaseOutput

func (*Database) ToDatabaseOutputWithContext 

func (i *Database) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

type DatabaseArgs 

type DatabaseArgs struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching pulumi.BoolPtrInput
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations pulumi.BoolPtrInput
	// The size of the database cluster plan.
	ClusterSize pulumi.StringPtrInput
	// The default branch for the database.
	DefaultBranch pulumi.StringPtrInput
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries pulumi.BoolPtrInput
	// The total number of ongoing issues within a database.
	IssuesCount pulumi.Float64PtrInput
	// Framework used for applying migrations.
	MigrationFramework pulumi.StringPtrInput
	// Table name to use for copying schema migration data.
	MigrationTableName pulumi.StringPtrInput
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion pulumi.BoolPtrInput
	// The name of this database.
	Name pulumi.StringPtrInput
	// The organization this database belongs to.
	Organization pulumi.StringInput
	// The database plan.
	Plan pulumi.StringPtrInput
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole pulumi.BoolPtrInput
	// The region the database lives in.
	Region pulumi.StringPtrInput
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy pulumi.BoolPtrInput
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion pulumi.BoolPtrInput
}

The set of arguments for constructing a Database resource.

func (DatabaseArgs) ElementType 

func (DatabaseArgs) ElementType() reflect.Type

type DatabaseArray 

type DatabaseArray []DatabaseInput

func (DatabaseArray) ElementType 

func (DatabaseArray) ElementType() reflect.Type

func (DatabaseArray) ToDatabaseArrayOutput 

func (i DatabaseArray) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArray) ToDatabaseArrayOutputWithContext 

func (i DatabaseArray) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseArrayInput 

type DatabaseArrayInput interface {
	pulumi.Input

	ToDatabaseArrayOutput() DatabaseArrayOutput
	ToDatabaseArrayOutputWithContext(context.Context) DatabaseArrayOutput
}

DatabaseArrayInput is an input type that accepts DatabaseArray and DatabaseArrayOutput values. You can construct a concrete instance of `DatabaseArrayInput` via: 

DatabaseArray{ DatabaseArgs{...} }

type DatabaseArrayOutput 

type DatabaseArrayOutput struct{ *pulumi.OutputState }

func (DatabaseArrayOutput) ElementType 

func (DatabaseArrayOutput) ElementType() reflect.Type

func (DatabaseArrayOutput) Index 

func (o DatabaseArrayOutput) Index(i pulumi.IntInput) DatabaseOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutput 

func (o DatabaseArrayOutput) ToDatabaseArrayOutput() DatabaseArrayOutput

func (DatabaseArrayOutput) ToDatabaseArrayOutputWithContext 

func (o DatabaseArrayOutput) ToDatabaseArrayOutputWithContext(ctx context.Context) DatabaseArrayOutput

type DatabaseDataImport 

type DatabaseDataImport struct {
	// Connection information for the source of the data for the import.
	DataSource *DatabaseDataImportDataSource `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt *string `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors *string `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt *string `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State *string `pulumi:"state"`
}

type DatabaseDataImportArgs 

type DatabaseDataImportArgs struct {
	// Connection information for the source of the data for the import.
	DataSource DatabaseDataImportDataSourcePtrInput `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt pulumi.StringPtrInput `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors pulumi.StringPtrInput `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt pulumi.StringPtrInput `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State pulumi.StringPtrInput `pulumi:"state"`
}

func (DatabaseDataImportArgs) ElementType 

func (DatabaseDataImportArgs) ElementType() reflect.Type

func (DatabaseDataImportArgs) ToDatabaseDataImportOutput 

func (i DatabaseDataImportArgs) ToDatabaseDataImportOutput() DatabaseDataImportOutput

func (DatabaseDataImportArgs) ToDatabaseDataImportOutputWithContext 

func (i DatabaseDataImportArgs) ToDatabaseDataImportOutputWithContext(ctx context.Context) DatabaseDataImportOutput

func (DatabaseDataImportArgs) ToDatabaseDataImportPtrOutput 

func (i DatabaseDataImportArgs) ToDatabaseDataImportPtrOutput() DatabaseDataImportPtrOutput

func (DatabaseDataImportArgs) ToDatabaseDataImportPtrOutputWithContext 

func (i DatabaseDataImportArgs) ToDatabaseDataImportPtrOutputWithContext(ctx context.Context) DatabaseDataImportPtrOutput

type DatabaseDataImportDataSource 

type DatabaseDataImportDataSource struct {
	// The name of the database imported from.
	Database string `pulumi:"database"`
	// The hostname where the database lives.
	Hostname string `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port string `pulumi:"port"`
}

type DatabaseDataImportDataSourceArgs 

type DatabaseDataImportDataSourceArgs struct {
	// The name of the database imported from.
	Database pulumi.StringInput `pulumi:"database"`
	// The hostname where the database lives.
	Hostname pulumi.StringInput `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port pulumi.StringInput `pulumi:"port"`
}

func (DatabaseDataImportDataSourceArgs) ElementType 

func (DatabaseDataImportDataSourceArgs) ElementType() reflect.Type

func (DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourceOutput 

func (i DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourceOutput() DatabaseDataImportDataSourceOutput

func (DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourceOutputWithContext 

func (i DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) DatabaseDataImportDataSourceOutput

func (DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourcePtrOutput 

func (i DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourcePtrOutput() DatabaseDataImportDataSourcePtrOutput

func (DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourcePtrOutputWithContext 

func (i DatabaseDataImportDataSourceArgs) ToDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) DatabaseDataImportDataSourcePtrOutput

type DatabaseDataImportDataSourceInput 

type DatabaseDataImportDataSourceInput interface {
	pulumi.Input

	ToDatabaseDataImportDataSourceOutput() DatabaseDataImportDataSourceOutput
	ToDatabaseDataImportDataSourceOutputWithContext(context.Context) DatabaseDataImportDataSourceOutput
}

DatabaseDataImportDataSourceInput is an input type that accepts DatabaseDataImportDataSourceArgs and DatabaseDataImportDataSourceOutput values. You can construct a concrete instance of `DatabaseDataImportDataSourceInput` via: 

DatabaseDataImportDataSourceArgs{...}

type DatabaseDataImportDataSourceOutput 

type DatabaseDataImportDataSourceOutput struct{ *pulumi.OutputState }

func (DatabaseDataImportDataSourceOutput) Database 

func (o DatabaseDataImportDataSourceOutput) Database() pulumi.StringOutput

The name of the database imported from.

func (DatabaseDataImportDataSourceOutput) ElementType 

func (DatabaseDataImportDataSourceOutput) ElementType() reflect.Type

func (DatabaseDataImportDataSourceOutput) Hostname 

func (o DatabaseDataImportDataSourceOutput) Hostname() pulumi.StringOutput

The hostname where the database lives.

func (DatabaseDataImportDataSourceOutput) Port 

func (o DatabaseDataImportDataSourceOutput) Port() pulumi.StringOutput

The port on which the database listens on the host.

func (DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourceOutput 

func (o DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourceOutput() DatabaseDataImportDataSourceOutput

func (DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourceOutputWithContext 

func (o DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) DatabaseDataImportDataSourceOutput

func (DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourcePtrOutput 

func (o DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourcePtrOutput() DatabaseDataImportDataSourcePtrOutput

func (DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourcePtrOutputWithContext 

func (o DatabaseDataImportDataSourceOutput) ToDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) DatabaseDataImportDataSourcePtrOutput

type DatabaseDataImportDataSourcePtrInput 

type DatabaseDataImportDataSourcePtrInput interface {
	pulumi.Input

	ToDatabaseDataImportDataSourcePtrOutput() DatabaseDataImportDataSourcePtrOutput
	ToDatabaseDataImportDataSourcePtrOutputWithContext(context.Context) DatabaseDataImportDataSourcePtrOutput
}

DatabaseDataImportDataSourcePtrInput is an input type that accepts DatabaseDataImportDataSourceArgs, DatabaseDataImportDataSourcePtr and DatabaseDataImportDataSourcePtrOutput values. You can construct a concrete instance of `DatabaseDataImportDataSourcePtrInput` via: 

        DatabaseDataImportDataSourceArgs{...}

or:

        nil

func DatabaseDataImportDataSourcePtr 

func DatabaseDataImportDataSourcePtr(v *DatabaseDataImportDataSourceArgs) DatabaseDataImportDataSourcePtrInput

type DatabaseDataImportDataSourcePtrOutput 

type DatabaseDataImportDataSourcePtrOutput struct{ *pulumi.OutputState }

func (DatabaseDataImportDataSourcePtrOutput) Database 

func (o DatabaseDataImportDataSourcePtrOutput) Database() pulumi.StringPtrOutput

The name of the database imported from.

func (DatabaseDataImportDataSourcePtrOutput) Elem 

func (o DatabaseDataImportDataSourcePtrOutput) Elem() DatabaseDataImportDataSourceOutput

func (DatabaseDataImportDataSourcePtrOutput) ElementType 

func (DatabaseDataImportDataSourcePtrOutput) ElementType() reflect.Type

func (DatabaseDataImportDataSourcePtrOutput) Hostname 

func (o DatabaseDataImportDataSourcePtrOutput) Hostname() pulumi.StringPtrOutput

The hostname where the database lives.

func (DatabaseDataImportDataSourcePtrOutput) Port 

func (o DatabaseDataImportDataSourcePtrOutput) Port() pulumi.StringPtrOutput

The port on which the database listens on the host.

func (DatabaseDataImportDataSourcePtrOutput) ToDatabaseDataImportDataSourcePtrOutput 

func (o DatabaseDataImportDataSourcePtrOutput) ToDatabaseDataImportDataSourcePtrOutput() DatabaseDataImportDataSourcePtrOutput

func (DatabaseDataImportDataSourcePtrOutput) ToDatabaseDataImportDataSourcePtrOutputWithContext 

func (o DatabaseDataImportDataSourcePtrOutput) ToDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) DatabaseDataImportDataSourcePtrOutput

type DatabaseDataImportInput 

type DatabaseDataImportInput interface {
	pulumi.Input

	ToDatabaseDataImportOutput() DatabaseDataImportOutput
	ToDatabaseDataImportOutputWithContext(context.Context) DatabaseDataImportOutput
}

DatabaseDataImportInput is an input type that accepts DatabaseDataImportArgs and DatabaseDataImportOutput values. You can construct a concrete instance of `DatabaseDataImportInput` via: 

DatabaseDataImportArgs{...}

type DatabaseDataImportOutput 

type DatabaseDataImportOutput struct{ *pulumi.OutputState }

func (DatabaseDataImportOutput) DataSource 

func (o DatabaseDataImportOutput) DataSource() DatabaseDataImportDataSourcePtrOutput

Connection information for the source of the data for the import.

func (DatabaseDataImportOutput) ElementType 

func (DatabaseDataImportOutput) ElementType() reflect.Type

func (DatabaseDataImportOutput) FinishedAt 

func (o DatabaseDataImportOutput) FinishedAt() pulumi.StringPtrOutput

When the import finished.

func (DatabaseDataImportOutput) ImportCheckErrors 

func (o DatabaseDataImportOutput) ImportCheckErrors() pulumi.StringPtrOutput

Errors encountered while preparing the import.

func (DatabaseDataImportOutput) StartedAt 

func (o DatabaseDataImportOutput) StartedAt() pulumi.StringPtrOutput

When the import started.

func (DatabaseDataImportOutput) State 

func (o DatabaseDataImportOutput) State() pulumi.StringPtrOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (DatabaseDataImportOutput) ToDatabaseDataImportOutput 

func (o DatabaseDataImportOutput) ToDatabaseDataImportOutput() DatabaseDataImportOutput

func (DatabaseDataImportOutput) ToDatabaseDataImportOutputWithContext 

func (o DatabaseDataImportOutput) ToDatabaseDataImportOutputWithContext(ctx context.Context) DatabaseDataImportOutput

func (DatabaseDataImportOutput) ToDatabaseDataImportPtrOutput 

func (o DatabaseDataImportOutput) ToDatabaseDataImportPtrOutput() DatabaseDataImportPtrOutput

func (DatabaseDataImportOutput) ToDatabaseDataImportPtrOutputWithContext 

func (o DatabaseDataImportOutput) ToDatabaseDataImportPtrOutputWithContext(ctx context.Context) DatabaseDataImportPtrOutput

type DatabaseDataImportPtrInput 

type DatabaseDataImportPtrInput interface {
	pulumi.Input

	ToDatabaseDataImportPtrOutput() DatabaseDataImportPtrOutput
	ToDatabaseDataImportPtrOutputWithContext(context.Context) DatabaseDataImportPtrOutput
}

DatabaseDataImportPtrInput is an input type that accepts DatabaseDataImportArgs, DatabaseDataImportPtr and DatabaseDataImportPtrOutput values. You can construct a concrete instance of `DatabaseDataImportPtrInput` via: 

        DatabaseDataImportArgs{...}

or:

        nil

func DatabaseDataImportPtr 

func DatabaseDataImportPtr(v *DatabaseDataImportArgs) DatabaseDataImportPtrInput

type DatabaseDataImportPtrOutput 

type DatabaseDataImportPtrOutput struct{ *pulumi.OutputState }

func (DatabaseDataImportPtrOutput) DataSource 

func (o DatabaseDataImportPtrOutput) DataSource() DatabaseDataImportDataSourcePtrOutput

Connection information for the source of the data for the import.

func (DatabaseDataImportPtrOutput) Elem 

func (o DatabaseDataImportPtrOutput) Elem() DatabaseDataImportOutput

func (DatabaseDataImportPtrOutput) ElementType 

func (DatabaseDataImportPtrOutput) ElementType() reflect.Type

func (DatabaseDataImportPtrOutput) FinishedAt 

func (o DatabaseDataImportPtrOutput) FinishedAt() pulumi.StringPtrOutput

When the import finished.

func (DatabaseDataImportPtrOutput) ImportCheckErrors 

func (o DatabaseDataImportPtrOutput) ImportCheckErrors() pulumi.StringPtrOutput

Errors encountered while preparing the import.

func (DatabaseDataImportPtrOutput) StartedAt 

func (o DatabaseDataImportPtrOutput) StartedAt() pulumi.StringPtrOutput

When the import started.

func (DatabaseDataImportPtrOutput) State 

func (o DatabaseDataImportPtrOutput) State() pulumi.StringPtrOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (DatabaseDataImportPtrOutput) ToDatabaseDataImportPtrOutput 

func (o DatabaseDataImportPtrOutput) ToDatabaseDataImportPtrOutput() DatabaseDataImportPtrOutput

func (DatabaseDataImportPtrOutput) ToDatabaseDataImportPtrOutputWithContext 

func (o DatabaseDataImportPtrOutput) ToDatabaseDataImportPtrOutputWithContext(ctx context.Context) DatabaseDataImportPtrOutput

type DatabaseInput 

type DatabaseInput interface {
	pulumi.Input

	ToDatabaseOutput() DatabaseOutput
	ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput
}

type DatabaseMap 

type DatabaseMap map[string]DatabaseInput

func (DatabaseMap) ElementType 

func (DatabaseMap) ElementType() reflect.Type

func (DatabaseMap) ToDatabaseMapOutput 

func (i DatabaseMap) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMap) ToDatabaseMapOutputWithContext 

func (i DatabaseMap) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseMapInput 

type DatabaseMapInput interface {
	pulumi.Input

	ToDatabaseMapOutput() DatabaseMapOutput
	ToDatabaseMapOutputWithContext(context.Context) DatabaseMapOutput
}

DatabaseMapInput is an input type that accepts DatabaseMap and DatabaseMapOutput values. You can construct a concrete instance of `DatabaseMapInput` via: 

DatabaseMap{ "key": DatabaseArgs{...} }

type DatabaseMapOutput 

type DatabaseMapOutput struct{ *pulumi.OutputState }

func (DatabaseMapOutput) ElementType 

func (DatabaseMapOutput) ElementType() reflect.Type

func (DatabaseMapOutput) MapIndex 

func (o DatabaseMapOutput) MapIndex(k pulumi.StringInput) DatabaseOutput

func (DatabaseMapOutput) ToDatabaseMapOutput 

func (o DatabaseMapOutput) ToDatabaseMapOutput() DatabaseMapOutput

func (DatabaseMapOutput) ToDatabaseMapOutputWithContext 

func (o DatabaseMapOutput) ToDatabaseMapOutputWithContext(ctx context.Context) DatabaseMapOutput

type DatabaseOutput 

type DatabaseOutput struct{ *pulumi.OutputState }

func (DatabaseOutput) AllowDataBranching 

func (o DatabaseOutput) AllowDataBranching() pulumi.BoolOutput

Whether seeding branches with data is enabled for all branches.

func (DatabaseOutput) AtBackupRestoreBranchesLimit 

func (o DatabaseOutput) AtBackupRestoreBranchesLimit() pulumi.BoolOutput

If the database has reached its backup restored branch limit.

func (DatabaseOutput) AtDevelopmentBranchLimit 

func (o DatabaseOutput) AtDevelopmentBranchLimit() pulumi.BoolOutput

If the database has reached its development branch limit.

func (DatabaseOutput) AutomaticMigrations 

func (o DatabaseOutput) AutomaticMigrations() pulumi.BoolOutput

Whether to automatically manage Rails migrations during deploy requests.

func (DatabaseOutput) BranchesCount 

func (o DatabaseOutput) BranchesCount() pulumi.Float64Output

The total number of database branches.

func (DatabaseOutput) BranchesUrl 

func (o DatabaseOutput) BranchesUrl() pulumi.StringOutput

The URL to retrieve this database's branches via the API.

func (DatabaseOutput) ClusterSize 

func (o DatabaseOutput) ClusterSize() pulumi.StringOutput

The size of the database cluster plan.

func (DatabaseOutput) CreatedAt 

func (o DatabaseOutput) CreatedAt() pulumi.StringOutput

When the database was created.

func (DatabaseOutput) DataImport 

func (o DatabaseOutput) DataImport() DatabaseDataImportOutput

If the database was created from an import, describes the import process.

func (DatabaseOutput) DefaultBranch 

func (o DatabaseOutput) DefaultBranch() pulumi.StringOutput

The default branch for the database.

func (DatabaseOutput) DefaultBranchReadOnlyRegionsCount 

func (o DatabaseOutput) DefaultBranchReadOnlyRegionsCount() pulumi.Float64Output

Number of read only regions in the default branch.

func (DatabaseOutput) DefaultBranchShardCount 

func (o DatabaseOutput) DefaultBranchShardCount() pulumi.Float64Output

Number of shards in the default branch.

func (DatabaseOutput) DefaultBranchTableCount 

func (o DatabaseOutput) DefaultBranchTableCount() pulumi.Float64Output

Number of tables in the default branch schema.

func (DatabaseOutput) DevelopmentBranchesCount 

func (o DatabaseOutput) DevelopmentBranchesCount() pulumi.Float64Output

The total number of database development branches.

func (DatabaseOutput) ElementType 

func (DatabaseOutput) ElementType() reflect.Type

func (DatabaseOutput) HtmlUrl 

func (o DatabaseOutput) HtmlUrl() pulumi.StringOutput

The total number of database development branches.

func (DatabaseOutput) InsightsRawQueries 

func (o DatabaseOutput) InsightsRawQueries() pulumi.BoolOutput

The URL to see this database's branches in the web UI.

func (DatabaseOutput) IssuesCount 

func (o DatabaseOutput) IssuesCount() pulumi.Float64Output

The total number of ongoing issues within a database.

func (DatabaseOutput) MigrationFramework 

func (o DatabaseOutput) MigrationFramework() pulumi.StringOutput

Framework used for applying migrations.

func (DatabaseOutput) MigrationTableName 

func (o DatabaseOutput) MigrationTableName() pulumi.StringOutput

Table name to use for copying schema migration data.

func (DatabaseOutput) MultipleAdminsRequiredForDeletion 

func (o DatabaseOutput) MultipleAdminsRequiredForDeletion() pulumi.BoolOutput

If the database requires multiple admins for deletion.

func (DatabaseOutput) Name 

func (o DatabaseOutput) Name() pulumi.StringOutput

The name of this database.

func (DatabaseOutput) Organization 

func (o DatabaseOutput) Organization() pulumi.StringOutput

The organization this database belongs to.

func (DatabaseOutput) Plan 

func (o DatabaseOutput) Plan() pulumi.StringOutput

The database plan.

func (DatabaseOutput) ProductionBranchWebConsole 

func (o DatabaseOutput) ProductionBranchWebConsole() pulumi.BoolOutput

Whether web console is enabled for production branches.

func (DatabaseOutput) ProductionBranchesCount 

func (o DatabaseOutput) ProductionBranchesCount() pulumi.Float64Output

The total number of database production branches.

func (DatabaseOutput) Ready 

func (o DatabaseOutput) Ready() pulumi.BoolOutput

If the database is ready to be used.

func (DatabaseOutput) Region 

func (o DatabaseOutput) Region() pulumi.StringOutput

The region the database lives in.

func (DatabaseOutput) RequireApprovalForDeploy 

func (o DatabaseOutput) RequireApprovalForDeploy() pulumi.BoolOutput

Whether an approval is required to deploy schema changes to this database.

func (DatabaseOutput) RestrictBranchRegion 

func (o DatabaseOutput) RestrictBranchRegion() pulumi.BoolOutput

Whether to restrict branch creation to one region.

func (DatabaseOutput) SchemaLastUpdatedAt 

func (o DatabaseOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the default branch schema was last changed.

func (DatabaseOutput) Sharded 

func (o DatabaseOutput) Sharded() pulumi.BoolOutput

If the database is sharded.

func (DatabaseOutput) State 

func (o DatabaseOutput) State() pulumi.StringOutput

State of the database.

func (DatabaseOutput) ToDatabaseOutput 

func (o DatabaseOutput) ToDatabaseOutput() DatabaseOutput

func (DatabaseOutput) ToDatabaseOutputWithContext 

func (o DatabaseOutput) ToDatabaseOutputWithContext(ctx context.Context) DatabaseOutput

func (DatabaseOutput) UpdatedAt 

func (o DatabaseOutput) UpdatedAt() pulumi.StringOutput

When the database was last updated.

func (DatabaseOutput) Url 

func (o DatabaseOutput) Url() pulumi.StringOutput

The URL to the database API endpoint.

type DatabaseState 

type DatabaseState struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching pulumi.BoolPtrInput
	// If the database has reached its backup restored branch limit.
	AtBackupRestoreBranchesLimit pulumi.BoolPtrInput
	// If the database has reached its development branch limit.
	AtDevelopmentBranchLimit pulumi.BoolPtrInput
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations pulumi.BoolPtrInput
	// The total number of database branches.
	BranchesCount pulumi.Float64PtrInput
	// The URL to retrieve this database's branches via the API.
	BranchesUrl pulumi.StringPtrInput
	// The size of the database cluster plan.
	ClusterSize pulumi.StringPtrInput
	// When the database was created.
	CreatedAt pulumi.StringPtrInput
	// If the database was created from an import, describes the import process.
	DataImport DatabaseDataImportPtrInput
	// The default branch for the database.
	DefaultBranch pulumi.StringPtrInput
	// Number of read only regions in the default branch.
	DefaultBranchReadOnlyRegionsCount pulumi.Float64PtrInput
	// Number of shards in the default branch.
	DefaultBranchShardCount pulumi.Float64PtrInput
	// Number of tables in the default branch schema.
	DefaultBranchTableCount pulumi.Float64PtrInput
	// The total number of database development branches.
	DevelopmentBranchesCount pulumi.Float64PtrInput
	// The total number of database development branches.
	HtmlUrl pulumi.StringPtrInput
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries pulumi.BoolPtrInput
	// The total number of ongoing issues within a database.
	IssuesCount pulumi.Float64PtrInput
	// Framework used for applying migrations.
	MigrationFramework pulumi.StringPtrInput
	// Table name to use for copying schema migration data.
	MigrationTableName pulumi.StringPtrInput
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion pulumi.BoolPtrInput
	// The name of this database.
	Name pulumi.StringPtrInput
	// The organization this database belongs to.
	Organization pulumi.StringPtrInput
	// The database plan.
	Plan pulumi.StringPtrInput
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole pulumi.BoolPtrInput
	// The total number of database production branches.
	ProductionBranchesCount pulumi.Float64PtrInput
	// If the database is ready to be used.
	Ready pulumi.BoolPtrInput
	// The region the database lives in.
	Region pulumi.StringPtrInput
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy pulumi.BoolPtrInput
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion pulumi.BoolPtrInput
	// When the default branch schema was last changed.
	SchemaLastUpdatedAt pulumi.StringPtrInput
	// If the database is sharded.
	Sharded pulumi.BoolPtrInput
	// State of the database.
	State pulumi.StringPtrInput
	// When the database was last updated.
	UpdatedAt pulumi.StringPtrInput
	// The URL to the database API endpoint.
	Url pulumi.StringPtrInput
}

func (DatabaseState) ElementType 

func (DatabaseState) ElementType() reflect.Type

type GetBackupActor 

type GetBackupActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetBackupActorArgs 

type GetBackupActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetBackupActorArgs) ElementType 

func (GetBackupActorArgs) ElementType() reflect.Type

func (GetBackupActorArgs) ToGetBackupActorOutput 

func (i GetBackupActorArgs) ToGetBackupActorOutput() GetBackupActorOutput

func (GetBackupActorArgs) ToGetBackupActorOutputWithContext 

func (i GetBackupActorArgs) ToGetBackupActorOutputWithContext(ctx context.Context) GetBackupActorOutput

type GetBackupActorInput 

type GetBackupActorInput interface {
	pulumi.Input

	ToGetBackupActorOutput() GetBackupActorOutput
	ToGetBackupActorOutputWithContext(context.Context) GetBackupActorOutput
}

GetBackupActorInput is an input type that accepts GetBackupActorArgs and GetBackupActorOutput values. You can construct a concrete instance of `GetBackupActorInput` via: 

GetBackupActorArgs{...}

type GetBackupActorOutput 

type GetBackupActorOutput struct{ *pulumi.OutputState }

func (GetBackupActorOutput) AvatarUrl 

func (o GetBackupActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetBackupActorOutput) DisplayName 

func (o GetBackupActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetBackupActorOutput) ElementType 

func (GetBackupActorOutput) ElementType() reflect.Type

func (GetBackupActorOutput) Id 

func (o GetBackupActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetBackupActorOutput) ToGetBackupActorOutput 

func (o GetBackupActorOutput) ToGetBackupActorOutput() GetBackupActorOutput

func (GetBackupActorOutput) ToGetBackupActorOutputWithContext 

func (o GetBackupActorOutput) ToGetBackupActorOutputWithContext(ctx context.Context) GetBackupActorOutput

type GetBackupBackupPolicy 

type GetBackupBackupPolicy struct {
	// When the backup policy was created.
	CreatedAt string `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy.
	FrequencyUnit string `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy.
	FrequencyValue float64 `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id string `pulumi:"id"`
	// When the backup was last run.
	LastRanAt string `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name string `pulumi:"name"`
	// When the backup will next run.
	NextRunAt string `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit string `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue float64 `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay string `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek string `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target string `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBackupBackupPolicyArgs 

type GetBackupBackupPolicyArgs struct {
	// When the backup policy was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy.
	FrequencyUnit pulumi.StringInput `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy.
	FrequencyValue pulumi.Float64Input `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id pulumi.StringInput `pulumi:"id"`
	// When the backup was last run.
	LastRanAt pulumi.StringInput `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name pulumi.StringInput `pulumi:"name"`
	// When the backup will next run.
	NextRunAt pulumi.StringInput `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit pulumi.StringInput `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue pulumi.Float64Input `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay pulumi.StringInput `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek pulumi.StringInput `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target pulumi.StringInput `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBackupBackupPolicyArgs) ElementType 

func (GetBackupBackupPolicyArgs) ElementType() reflect.Type

func (GetBackupBackupPolicyArgs) ToGetBackupBackupPolicyOutput 

func (i GetBackupBackupPolicyArgs) ToGetBackupBackupPolicyOutput() GetBackupBackupPolicyOutput

func (GetBackupBackupPolicyArgs) ToGetBackupBackupPolicyOutputWithContext 

func (i GetBackupBackupPolicyArgs) ToGetBackupBackupPolicyOutputWithContext(ctx context.Context) GetBackupBackupPolicyOutput

type GetBackupBackupPolicyInput 

type GetBackupBackupPolicyInput interface {
	pulumi.Input

	ToGetBackupBackupPolicyOutput() GetBackupBackupPolicyOutput
	ToGetBackupBackupPolicyOutputWithContext(context.Context) GetBackupBackupPolicyOutput
}

GetBackupBackupPolicyInput is an input type that accepts GetBackupBackupPolicyArgs and GetBackupBackupPolicyOutput values. You can construct a concrete instance of `GetBackupBackupPolicyInput` via: 

GetBackupBackupPolicyArgs{...}

type GetBackupBackupPolicyOutput 

type GetBackupBackupPolicyOutput struct{ *pulumi.OutputState }

func (GetBackupBackupPolicyOutput) CreatedAt 

func (o GetBackupBackupPolicyOutput) CreatedAt() pulumi.StringOutput

When the backup policy was created.

func (GetBackupBackupPolicyOutput) ElementType 

func (GetBackupBackupPolicyOutput) ElementType() reflect.Type

func (GetBackupBackupPolicyOutput) FrequencyUnit 

func (o GetBackupBackupPolicyOutput) FrequencyUnit() pulumi.StringOutput

The unit for the frequency of the backup policy.

func (GetBackupBackupPolicyOutput) FrequencyValue 

func (o GetBackupBackupPolicyOutput) FrequencyValue() pulumi.Float64Output

A number value for the frequency of the backup policy.

func (GetBackupBackupPolicyOutput) Id 

func (o GetBackupBackupPolicyOutput) Id() pulumi.StringOutput

The ID of the backup policy.

func (GetBackupBackupPolicyOutput) LastRanAt 

func (o GetBackupBackupPolicyOutput) LastRanAt() pulumi.StringOutput

When the backup was last run.

func (GetBackupBackupPolicyOutput) Name 

func (o GetBackupBackupPolicyOutput) Name() pulumi.StringOutput

The name of the backup policy.

func (GetBackupBackupPolicyOutput) NextRunAt 

func (o GetBackupBackupPolicyOutput) NextRunAt() pulumi.StringOutput

When the backup will next run.

func (GetBackupBackupPolicyOutput) RetentionUnit 

func (o GetBackupBackupPolicyOutput) RetentionUnit() pulumi.StringOutput

The unit for the retention period of the backup policy.

func (GetBackupBackupPolicyOutput) RetentionValue 

func (o GetBackupBackupPolicyOutput) RetentionValue() pulumi.Float64Output

A number value for the retention period of the backup policy.

func (GetBackupBackupPolicyOutput) ScheduleDay 

func (o GetBackupBackupPolicyOutput) ScheduleDay() pulumi.StringOutput

Day of the week that the backup is scheduled.

func (GetBackupBackupPolicyOutput) ScheduleWeek 

func (o GetBackupBackupPolicyOutput) ScheduleWeek() pulumi.StringOutput

Week of the month that the backup is scheduled.

func (GetBackupBackupPolicyOutput) Target 

func (o GetBackupBackupPolicyOutput) Target() pulumi.StringOutput

Whether the backup policy is for a production or development database, or for a database branch.

func (GetBackupBackupPolicyOutput) ToGetBackupBackupPolicyOutput 

func (o GetBackupBackupPolicyOutput) ToGetBackupBackupPolicyOutput() GetBackupBackupPolicyOutput

func (GetBackupBackupPolicyOutput) ToGetBackupBackupPolicyOutputWithContext 

func (o GetBackupBackupPolicyOutput) ToGetBackupBackupPolicyOutputWithContext(ctx context.Context) GetBackupBackupPolicyOutput

func (GetBackupBackupPolicyOutput) UpdatedAt 

func (o GetBackupBackupPolicyOutput) UpdatedAt() pulumi.StringOutput

When the backup policy was last updated.

type GetBackupsArgs 

type GetBackupsArgs struct {
	Branch       string `pulumi:"branch"`
	Database     string `pulumi:"database"`
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getBackups.

type GetBackupsBackup 

type GetBackupsBackup struct {
	// The actor that created the backup.
	Actor GetBackupsBackupActor `pulumi:"actor"`
	// The backup policy being followed.
	BackupPolicy GetBackupsBackupBackupPolicy `pulumi:"backupPolicy"`
	// The branch this backup belongs to.
	Branch string `pulumi:"branch"`
	// When the backup was created.
	CreatedAt string `pulumi:"createdAt"`
	// The database this backup belongs to.
	Database string `pulumi:"database"`
	// The estimated storage cost of the backup.
	EstimatedStorageCost string `pulumi:"estimatedStorageCost"`
	// The ID of the backup.
	Id string `pulumi:"id"`
	// The name of the backup.
	Name string `pulumi:"name"`
	// The organization this backup belongs to.
	Organization string `pulumi:"organization"`
	// Whether or not the backup policy is required.
	Required bool `pulumi:"required"`
	// Branches that have been restored with this backup.
	RestoredBranches []string `pulumi:"restoredBranches"`
	// The size of the backup.
	Size float64 `pulumi:"size"`
	// The current state of the backup.
	State string `pulumi:"state"`
	// When the backup was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBackupsBackupActor 

type GetBackupsBackupActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetBackupsBackupActorArgs 

type GetBackupsBackupActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetBackupsBackupActorArgs) ElementType 

func (GetBackupsBackupActorArgs) ElementType() reflect.Type

func (GetBackupsBackupActorArgs) ToGetBackupsBackupActorOutput 

func (i GetBackupsBackupActorArgs) ToGetBackupsBackupActorOutput() GetBackupsBackupActorOutput

func (GetBackupsBackupActorArgs) ToGetBackupsBackupActorOutputWithContext 

func (i GetBackupsBackupActorArgs) ToGetBackupsBackupActorOutputWithContext(ctx context.Context) GetBackupsBackupActorOutput

type GetBackupsBackupActorInput 

type GetBackupsBackupActorInput interface {
	pulumi.Input

	ToGetBackupsBackupActorOutput() GetBackupsBackupActorOutput
	ToGetBackupsBackupActorOutputWithContext(context.Context) GetBackupsBackupActorOutput
}

GetBackupsBackupActorInput is an input type that accepts GetBackupsBackupActorArgs and GetBackupsBackupActorOutput values. You can construct a concrete instance of `GetBackupsBackupActorInput` via: 

GetBackupsBackupActorArgs{...}

type GetBackupsBackupActorOutput 

type GetBackupsBackupActorOutput struct{ *pulumi.OutputState }

func (GetBackupsBackupActorOutput) AvatarUrl 

func (o GetBackupsBackupActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetBackupsBackupActorOutput) DisplayName 

func (o GetBackupsBackupActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetBackupsBackupActorOutput) ElementType 

func (GetBackupsBackupActorOutput) ElementType() reflect.Type

func (GetBackupsBackupActorOutput) Id 

func (o GetBackupsBackupActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetBackupsBackupActorOutput) ToGetBackupsBackupActorOutput 

func (o GetBackupsBackupActorOutput) ToGetBackupsBackupActorOutput() GetBackupsBackupActorOutput

func (GetBackupsBackupActorOutput) ToGetBackupsBackupActorOutputWithContext 

func (o GetBackupsBackupActorOutput) ToGetBackupsBackupActorOutputWithContext(ctx context.Context) GetBackupsBackupActorOutput

type GetBackupsBackupArgs 

type GetBackupsBackupArgs struct {
	// The actor that created the backup.
	Actor GetBackupsBackupActorInput `pulumi:"actor"`
	// The backup policy being followed.
	BackupPolicy GetBackupsBackupBackupPolicyInput `pulumi:"backupPolicy"`
	// The branch this backup belongs to.
	Branch pulumi.StringInput `pulumi:"branch"`
	// When the backup was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The database this backup belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// The estimated storage cost of the backup.
	EstimatedStorageCost pulumi.StringInput `pulumi:"estimatedStorageCost"`
	// The ID of the backup.
	Id pulumi.StringInput `pulumi:"id"`
	// The name of the backup.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this backup belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// Whether or not the backup policy is required.
	Required pulumi.BoolInput `pulumi:"required"`
	// Branches that have been restored with this backup.
	RestoredBranches pulumi.StringArrayInput `pulumi:"restoredBranches"`
	// The size of the backup.
	Size pulumi.Float64Input `pulumi:"size"`
	// The current state of the backup.
	State pulumi.StringInput `pulumi:"state"`
	// When the backup was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBackupsBackupArgs) ElementType 

func (GetBackupsBackupArgs) ElementType() reflect.Type

func (GetBackupsBackupArgs) ToGetBackupsBackupOutput 

func (i GetBackupsBackupArgs) ToGetBackupsBackupOutput() GetBackupsBackupOutput

func (GetBackupsBackupArgs) ToGetBackupsBackupOutputWithContext 

func (i GetBackupsBackupArgs) ToGetBackupsBackupOutputWithContext(ctx context.Context) GetBackupsBackupOutput

type GetBackupsBackupArray 

type GetBackupsBackupArray []GetBackupsBackupInput

func (GetBackupsBackupArray) ElementType 

func (GetBackupsBackupArray) ElementType() reflect.Type

func (GetBackupsBackupArray) ToGetBackupsBackupArrayOutput 

func (i GetBackupsBackupArray) ToGetBackupsBackupArrayOutput() GetBackupsBackupArrayOutput

func (GetBackupsBackupArray) ToGetBackupsBackupArrayOutputWithContext 

func (i GetBackupsBackupArray) ToGetBackupsBackupArrayOutputWithContext(ctx context.Context) GetBackupsBackupArrayOutput

type GetBackupsBackupArrayInput 

type GetBackupsBackupArrayInput interface {
	pulumi.Input

	ToGetBackupsBackupArrayOutput() GetBackupsBackupArrayOutput
	ToGetBackupsBackupArrayOutputWithContext(context.Context) GetBackupsBackupArrayOutput
}

GetBackupsBackupArrayInput is an input type that accepts GetBackupsBackupArray and GetBackupsBackupArrayOutput values. You can construct a concrete instance of `GetBackupsBackupArrayInput` via: 

GetBackupsBackupArray{ GetBackupsBackupArgs{...} }

type GetBackupsBackupArrayOutput 

type GetBackupsBackupArrayOutput struct{ *pulumi.OutputState }

func (GetBackupsBackupArrayOutput) ElementType 

func (GetBackupsBackupArrayOutput) ElementType() reflect.Type

func (GetBackupsBackupArrayOutput) Index 

func (o GetBackupsBackupArrayOutput) Index(i pulumi.IntInput) GetBackupsBackupOutput

func (GetBackupsBackupArrayOutput) ToGetBackupsBackupArrayOutput 

func (o GetBackupsBackupArrayOutput) ToGetBackupsBackupArrayOutput() GetBackupsBackupArrayOutput

func (GetBackupsBackupArrayOutput) ToGetBackupsBackupArrayOutputWithContext 

func (o GetBackupsBackupArrayOutput) ToGetBackupsBackupArrayOutputWithContext(ctx context.Context) GetBackupsBackupArrayOutput

type GetBackupsBackupBackupPolicy 

type GetBackupsBackupBackupPolicy struct {
	// When the backup policy was created.
	CreatedAt string `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy.
	FrequencyUnit string `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy.
	FrequencyValue float64 `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id string `pulumi:"id"`
	// When the backup was last run.
	LastRanAt string `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name string `pulumi:"name"`
	// When the backup will next run.
	NextRunAt string `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit string `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue float64 `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay string `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek string `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target string `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBackupsBackupBackupPolicyArgs 

type GetBackupsBackupBackupPolicyArgs struct {
	// When the backup policy was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The unit for the frequency of the backup policy.
	FrequencyUnit pulumi.StringInput `pulumi:"frequencyUnit"`
	// A number value for the frequency of the backup policy.
	FrequencyValue pulumi.Float64Input `pulumi:"frequencyValue"`
	// The ID of the backup policy.
	Id pulumi.StringInput `pulumi:"id"`
	// When the backup was last run.
	LastRanAt pulumi.StringInput `pulumi:"lastRanAt"`
	// The name of the backup policy.
	Name pulumi.StringInput `pulumi:"name"`
	// When the backup will next run.
	NextRunAt pulumi.StringInput `pulumi:"nextRunAt"`
	// The unit for the retention period of the backup policy.
	RetentionUnit pulumi.StringInput `pulumi:"retentionUnit"`
	// A number value for the retention period of the backup policy.
	RetentionValue pulumi.Float64Input `pulumi:"retentionValue"`
	// Day of the week that the backup is scheduled.
	ScheduleDay pulumi.StringInput `pulumi:"scheduleDay"`
	// Week of the month that the backup is scheduled.
	ScheduleWeek pulumi.StringInput `pulumi:"scheduleWeek"`
	// Whether the backup policy is for a production or development database, or for a database branch.
	Target pulumi.StringInput `pulumi:"target"`
	// When the backup policy was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBackupsBackupBackupPolicyArgs) ElementType 

func (GetBackupsBackupBackupPolicyArgs) ElementType() reflect.Type

func (GetBackupsBackupBackupPolicyArgs) ToGetBackupsBackupBackupPolicyOutput 

func (i GetBackupsBackupBackupPolicyArgs) ToGetBackupsBackupBackupPolicyOutput() GetBackupsBackupBackupPolicyOutput

func (GetBackupsBackupBackupPolicyArgs) ToGetBackupsBackupBackupPolicyOutputWithContext 

func (i GetBackupsBackupBackupPolicyArgs) ToGetBackupsBackupBackupPolicyOutputWithContext(ctx context.Context) GetBackupsBackupBackupPolicyOutput

type GetBackupsBackupBackupPolicyInput 

type GetBackupsBackupBackupPolicyInput interface {
	pulumi.Input

	ToGetBackupsBackupBackupPolicyOutput() GetBackupsBackupBackupPolicyOutput
	ToGetBackupsBackupBackupPolicyOutputWithContext(context.Context) GetBackupsBackupBackupPolicyOutput
}

GetBackupsBackupBackupPolicyInput is an input type that accepts GetBackupsBackupBackupPolicyArgs and GetBackupsBackupBackupPolicyOutput values. You can construct a concrete instance of `GetBackupsBackupBackupPolicyInput` via: 

GetBackupsBackupBackupPolicyArgs{...}

type GetBackupsBackupBackupPolicyOutput 

type GetBackupsBackupBackupPolicyOutput struct{ *pulumi.OutputState }

func (GetBackupsBackupBackupPolicyOutput) CreatedAt 

func (o GetBackupsBackupBackupPolicyOutput) CreatedAt() pulumi.StringOutput

When the backup policy was created.

func (GetBackupsBackupBackupPolicyOutput) ElementType 

func (GetBackupsBackupBackupPolicyOutput) ElementType() reflect.Type

func (GetBackupsBackupBackupPolicyOutput) FrequencyUnit 

func (o GetBackupsBackupBackupPolicyOutput) FrequencyUnit() pulumi.StringOutput

The unit for the frequency of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) FrequencyValue 

func (o GetBackupsBackupBackupPolicyOutput) FrequencyValue() pulumi.Float64Output

A number value for the frequency of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) Id 

func (o GetBackupsBackupBackupPolicyOutput) Id() pulumi.StringOutput

The ID of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) LastRanAt 

func (o GetBackupsBackupBackupPolicyOutput) LastRanAt() pulumi.StringOutput

When the backup was last run.

func (GetBackupsBackupBackupPolicyOutput) Name 

func (o GetBackupsBackupBackupPolicyOutput) Name() pulumi.StringOutput

The name of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) NextRunAt 

func (o GetBackupsBackupBackupPolicyOutput) NextRunAt() pulumi.StringOutput

When the backup will next run.

func (GetBackupsBackupBackupPolicyOutput) RetentionUnit 

func (o GetBackupsBackupBackupPolicyOutput) RetentionUnit() pulumi.StringOutput

The unit for the retention period of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) RetentionValue 

func (o GetBackupsBackupBackupPolicyOutput) RetentionValue() pulumi.Float64Output

A number value for the retention period of the backup policy.

func (GetBackupsBackupBackupPolicyOutput) ScheduleDay 

func (o GetBackupsBackupBackupPolicyOutput) ScheduleDay() pulumi.StringOutput

Day of the week that the backup is scheduled.

func (GetBackupsBackupBackupPolicyOutput) ScheduleWeek 

func (o GetBackupsBackupBackupPolicyOutput) ScheduleWeek() pulumi.StringOutput

Week of the month that the backup is scheduled.

func (GetBackupsBackupBackupPolicyOutput) Target 

func (o GetBackupsBackupBackupPolicyOutput) Target() pulumi.StringOutput

Whether the backup policy is for a production or development database, or for a database branch.

func (GetBackupsBackupBackupPolicyOutput) ToGetBackupsBackupBackupPolicyOutput 

func (o GetBackupsBackupBackupPolicyOutput) ToGetBackupsBackupBackupPolicyOutput() GetBackupsBackupBackupPolicyOutput

func (GetBackupsBackupBackupPolicyOutput) ToGetBackupsBackupBackupPolicyOutputWithContext 

func (o GetBackupsBackupBackupPolicyOutput) ToGetBackupsBackupBackupPolicyOutputWithContext(ctx context.Context) GetBackupsBackupBackupPolicyOutput

func (GetBackupsBackupBackupPolicyOutput) UpdatedAt 

func (o GetBackupsBackupBackupPolicyOutput) UpdatedAt() pulumi.StringOutput

When the backup policy was last updated.

type GetBackupsBackupInput 

type GetBackupsBackupInput interface {
	pulumi.Input

	ToGetBackupsBackupOutput() GetBackupsBackupOutput
	ToGetBackupsBackupOutputWithContext(context.Context) GetBackupsBackupOutput
}

GetBackupsBackupInput is an input type that accepts GetBackupsBackupArgs and GetBackupsBackupOutput values. You can construct a concrete instance of `GetBackupsBackupInput` via: 

GetBackupsBackupArgs{...}

type GetBackupsBackupOutput 

type GetBackupsBackupOutput struct{ *pulumi.OutputState }

func (GetBackupsBackupOutput) Actor 

func (o GetBackupsBackupOutput) Actor() GetBackupsBackupActorOutput

The actor that created the backup.

func (GetBackupsBackupOutput) BackupPolicy 

func (o GetBackupsBackupOutput) BackupPolicy() GetBackupsBackupBackupPolicyOutput

The backup policy being followed.

func (GetBackupsBackupOutput) Branch 

func (o GetBackupsBackupOutput) Branch() pulumi.StringOutput

The branch this backup belongs to.

func (GetBackupsBackupOutput) CreatedAt 

func (o GetBackupsBackupOutput) CreatedAt() pulumi.StringOutput

When the backup was created.

func (GetBackupsBackupOutput) Database 

func (o GetBackupsBackupOutput) Database() pulumi.StringOutput

The database this backup belongs to.

func (GetBackupsBackupOutput) ElementType 

func (GetBackupsBackupOutput) ElementType() reflect.Type

func (GetBackupsBackupOutput) EstimatedStorageCost 

func (o GetBackupsBackupOutput) EstimatedStorageCost() pulumi.StringOutput

The estimated storage cost of the backup.

func (GetBackupsBackupOutput) Id 

func (o GetBackupsBackupOutput) Id() pulumi.StringOutput

The ID of the backup.

func (GetBackupsBackupOutput) Name 

func (o GetBackupsBackupOutput) Name() pulumi.StringOutput

The name of the backup.

func (GetBackupsBackupOutput) Organization 

func (o GetBackupsBackupOutput) Organization() pulumi.StringOutput

The organization this backup belongs to.

func (GetBackupsBackupOutput) Required 

func (o GetBackupsBackupOutput) Required() pulumi.BoolOutput

Whether or not the backup policy is required.

func (GetBackupsBackupOutput) RestoredBranches 

func (o GetBackupsBackupOutput) RestoredBranches() pulumi.StringArrayOutput

Branches that have been restored with this backup.

func (GetBackupsBackupOutput) Size 

func (o GetBackupsBackupOutput) Size() pulumi.Float64Output

The size of the backup.

func (GetBackupsBackupOutput) State 

func (o GetBackupsBackupOutput) State() pulumi.StringOutput

The current state of the backup.

func (GetBackupsBackupOutput) ToGetBackupsBackupOutput 

func (o GetBackupsBackupOutput) ToGetBackupsBackupOutput() GetBackupsBackupOutput

func (GetBackupsBackupOutput) ToGetBackupsBackupOutputWithContext 

func (o GetBackupsBackupOutput) ToGetBackupsBackupOutputWithContext(ctx context.Context) GetBackupsBackupOutput

func (GetBackupsBackupOutput) UpdatedAt 

func (o GetBackupsBackupOutput) UpdatedAt() pulumi.StringOutput

When the backup was last updated.

type GetBackupsOutputArgs 

type GetBackupsOutputArgs struct {
	Branch       pulumi.StringInput `pulumi:"branch"`
	Database     pulumi.StringInput `pulumi:"database"`
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getBackups.

func (GetBackupsOutputArgs) ElementType 

func (GetBackupsOutputArgs) ElementType() reflect.Type

type GetBackupsResult 

type GetBackupsResult struct {
	Backups  []GetBackupsBackup `pulumi:"backups"`
	Branch   string             `pulumi:"branch"`
	Database string             `pulumi:"database"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	Organization string `pulumi:"organization"`
}

A collection of values returned by getBackups.

func GetBackups 

func GetBackups(ctx *pulumi.Context, args *GetBackupsArgs, opts ...pulumi.InvokeOption) (*GetBackupsResult, error)

A list of PlanetScale backups.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

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

```

type GetBackupsResultOutput 

type GetBackupsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBackups.

func GetBackupsOutput 

func GetBackupsOutput(ctx *pulumi.Context, args GetBackupsOutputArgs, opts ...pulumi.InvokeOption) GetBackupsResultOutput

func (GetBackupsResultOutput) Backups 

func (o GetBackupsResultOutput) Backups() GetBackupsBackupArrayOutput

func (GetBackupsResultOutput) Branch 

func (o GetBackupsResultOutput) Branch() pulumi.StringOutput

func (GetBackupsResultOutput) Database 

func (o GetBackupsResultOutput) Database() pulumi.StringOutput

func (GetBackupsResultOutput) ElementType 

func (GetBackupsResultOutput) ElementType() reflect.Type

func (GetBackupsResultOutput) Id 

func (o GetBackupsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetBackupsResultOutput) Organization 

func (o GetBackupsResultOutput) Organization() pulumi.StringOutput

func (GetBackupsResultOutput) ToGetBackupsResultOutput 

func (o GetBackupsResultOutput) ToGetBackupsResultOutput() GetBackupsResultOutput

func (GetBackupsResultOutput) ToGetBackupsResultOutputWithContext 

func (o GetBackupsResultOutput) ToGetBackupsResultOutputWithContext(ctx context.Context) GetBackupsResultOutput

type GetBranchActor 

type GetBranchActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetBranchActorArgs 

type GetBranchActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetBranchActorArgs) ElementType 

func (GetBranchActorArgs) ElementType() reflect.Type

func (GetBranchActorArgs) ToGetBranchActorOutput 

func (i GetBranchActorArgs) ToGetBranchActorOutput() GetBranchActorOutput

func (GetBranchActorArgs) ToGetBranchActorOutputWithContext 

func (i GetBranchActorArgs) ToGetBranchActorOutputWithContext(ctx context.Context) GetBranchActorOutput

type GetBranchActorInput 

type GetBranchActorInput interface {
	pulumi.Input

	ToGetBranchActorOutput() GetBranchActorOutput
	ToGetBranchActorOutputWithContext(context.Context) GetBranchActorOutput
}

GetBranchActorInput is an input type that accepts GetBranchActorArgs and GetBranchActorOutput values. You can construct a concrete instance of `GetBranchActorInput` via: 

GetBranchActorArgs{...}

type GetBranchActorOutput 

type GetBranchActorOutput struct{ *pulumi.OutputState }

func (GetBranchActorOutput) AvatarUrl 

func (o GetBranchActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetBranchActorOutput) DisplayName 

func (o GetBranchActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetBranchActorOutput) ElementType 

func (GetBranchActorOutput) ElementType() reflect.Type

func (GetBranchActorOutput) Id 

func (o GetBranchActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetBranchActorOutput) ToGetBranchActorOutput 

func (o GetBranchActorOutput) ToGetBranchActorOutput() GetBranchActorOutput

func (GetBranchActorOutput) ToGetBranchActorOutputWithContext 

func (o GetBranchActorOutput) ToGetBranchActorOutputWithContext(ctx context.Context) GetBranchActorOutput

type GetBranchRegion 

type GetBranchRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetBranchRegionArgs 

type GetBranchRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetBranchRegionArgs) ElementType 

func (GetBranchRegionArgs) ElementType() reflect.Type

func (GetBranchRegionArgs) ToGetBranchRegionOutput 

func (i GetBranchRegionArgs) ToGetBranchRegionOutput() GetBranchRegionOutput

func (GetBranchRegionArgs) ToGetBranchRegionOutputWithContext 

func (i GetBranchRegionArgs) ToGetBranchRegionOutputWithContext(ctx context.Context) GetBranchRegionOutput

type GetBranchRegionInput 

type GetBranchRegionInput interface {
	pulumi.Input

	ToGetBranchRegionOutput() GetBranchRegionOutput
	ToGetBranchRegionOutputWithContext(context.Context) GetBranchRegionOutput
}

GetBranchRegionInput is an input type that accepts GetBranchRegionArgs and GetBranchRegionOutput values. You can construct a concrete instance of `GetBranchRegionInput` via: 

GetBranchRegionArgs{...}

type GetBranchRegionOutput 

type GetBranchRegionOutput struct{ *pulumi.OutputState }

func (GetBranchRegionOutput) DisplayName 

func (o GetBranchRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetBranchRegionOutput) ElementType 

func (GetBranchRegionOutput) ElementType() reflect.Type

func (GetBranchRegionOutput) Enabled 

func (o GetBranchRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetBranchRegionOutput) Id 

func (o GetBranchRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetBranchRegionOutput) Location 

func (o GetBranchRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetBranchRegionOutput) Provider 

func (o GetBranchRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetBranchRegionOutput) PublicIpAddresses 

func (o GetBranchRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetBranchRegionOutput) Slug 

func (o GetBranchRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetBranchRegionOutput) ToGetBranchRegionOutput 

func (o GetBranchRegionOutput) ToGetBranchRegionOutput() GetBranchRegionOutput

func (GetBranchRegionOutput) ToGetBranchRegionOutputWithContext 

func (o GetBranchRegionOutput) ToGetBranchRegionOutputWithContext(ctx context.Context) GetBranchRegionOutput

type GetBranchRestoredFromBranch 

type GetBranchRestoredFromBranch struct {
	// When the resource was created.
	CreatedAt string `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt string `pulumi:"deletedAt"`
	// The ID for the resource.
	Id string `pulumi:"id"`
	// The name for the resource.
	Name string `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBranchRestoredFromBranchArgs 

type GetBranchRestoredFromBranchArgs struct {
	// When the resource was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt pulumi.StringInput `pulumi:"deletedAt"`
	// The ID for the resource.
	Id pulumi.StringInput `pulumi:"id"`
	// The name for the resource.
	Name pulumi.StringInput `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBranchRestoredFromBranchArgs) ElementType 

func (GetBranchRestoredFromBranchArgs) ElementType() reflect.Type

func (GetBranchRestoredFromBranchArgs) ToGetBranchRestoredFromBranchOutput 

func (i GetBranchRestoredFromBranchArgs) ToGetBranchRestoredFromBranchOutput() GetBranchRestoredFromBranchOutput

func (GetBranchRestoredFromBranchArgs) ToGetBranchRestoredFromBranchOutputWithContext 

func (i GetBranchRestoredFromBranchArgs) ToGetBranchRestoredFromBranchOutputWithContext(ctx context.Context) GetBranchRestoredFromBranchOutput

type GetBranchRestoredFromBranchInput 

type GetBranchRestoredFromBranchInput interface {
	pulumi.Input

	ToGetBranchRestoredFromBranchOutput() GetBranchRestoredFromBranchOutput
	ToGetBranchRestoredFromBranchOutputWithContext(context.Context) GetBranchRestoredFromBranchOutput
}

GetBranchRestoredFromBranchInput is an input type that accepts GetBranchRestoredFromBranchArgs and GetBranchRestoredFromBranchOutput values. You can construct a concrete instance of `GetBranchRestoredFromBranchInput` via: 

GetBranchRestoredFromBranchArgs{...}

type GetBranchRestoredFromBranchOutput 

type GetBranchRestoredFromBranchOutput struct{ *pulumi.OutputState }

func (GetBranchRestoredFromBranchOutput) CreatedAt 

func (o GetBranchRestoredFromBranchOutput) CreatedAt() pulumi.StringOutput

When the resource was created.

func (GetBranchRestoredFromBranchOutput) DeletedAt 

func (o GetBranchRestoredFromBranchOutput) DeletedAt() pulumi.StringOutput

When the resource was deleted, if deleted.

func (GetBranchRestoredFromBranchOutput) ElementType 

func (GetBranchRestoredFromBranchOutput) ElementType() reflect.Type

func (GetBranchRestoredFromBranchOutput) Id 

func (o GetBranchRestoredFromBranchOutput) Id() pulumi.StringOutput

The ID for the resource.

func (GetBranchRestoredFromBranchOutput) Name 

func (o GetBranchRestoredFromBranchOutput) Name() pulumi.StringOutput

The name for the resource.

func (GetBranchRestoredFromBranchOutput) ToGetBranchRestoredFromBranchOutput 

func (o GetBranchRestoredFromBranchOutput) ToGetBranchRestoredFromBranchOutput() GetBranchRestoredFromBranchOutput

func (GetBranchRestoredFromBranchOutput) ToGetBranchRestoredFromBranchOutputWithContext 

func (o GetBranchRestoredFromBranchOutput) ToGetBranchRestoredFromBranchOutputWithContext(ctx context.Context) GetBranchRestoredFromBranchOutput

func (GetBranchRestoredFromBranchOutput) UpdatedAt 

func (o GetBranchRestoredFromBranchOutput) UpdatedAt() pulumi.StringOutput

When the resource was last updated.

type GetBranchSchemaArgs 

type GetBranchSchemaArgs struct {
	Branch       string  `pulumi:"branch"`
	Database     string  `pulumi:"database"`
	Keyspace     *string `pulumi:"keyspace"`
	Organization string  `pulumi:"organization"`
}

A collection of arguments for invoking getBranchSchema.

type GetBranchSchemaLintArgs 

type GetBranchSchemaLintArgs struct {
	Branch       string `pulumi:"branch"`
	Database     string `pulumi:"database"`
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getBranchSchemaLint.

type GetBranchSchemaLintError 

type GetBranchSchemaLintError struct {
	// A list of invalid auto-incremented columns.
	AutoIncrementColumnNames []string `pulumi:"autoIncrementColumnNames"`
	// The charset of the schema.
	CharsetName string `pulumi:"charsetName"`
	// The name of the invalid check constraint.
	CheckConstraintName string `pulumi:"checkConstraintName"`
	// The column in a table relevant to the error.
	ColumnName string `pulumi:"columnName"`
	// A link to the documentation related to the error.
	DocsUrl string `pulumi:"docsUrl"`
	// The engine of the schema.
	EngineName string `pulumi:"engineName"`
	// The name of the invalid enum value.
	EnumValue string `pulumi:"enumValue"`
	// A description for the error that occurred.
	ErrorDescription string `pulumi:"errorDescription"`
	// A list of invalid foreign key columns in a table.
	ForeignKeyColumnNames []string `pulumi:"foreignKeyColumnNames"`
	// The path for an invalid JSON column.
	JsonPath string `pulumi:"jsonPath"`
	// The keyspace of the schema with the error.
	KeyspaceName string `pulumi:"keyspaceName"`
	// Code representing.
	LintError string `pulumi:"lintError"`
	// The name of the invalid partition in the schema.
	PartitionName string `pulumi:"partitionName"`
	// The name of the invalid partitioning type.
	PartitioningType string `pulumi:"partitioningType"`
	// The subject for the errors.
	SubjectType string `pulumi:"subjectType"`
	// The table with the error.
	TableName string `pulumi:"tableName"`
	// The name of the vindex for the schema.
	VindexName string `pulumi:"vindexName"`
}

type GetBranchSchemaLintErrorArgs 

type GetBranchSchemaLintErrorArgs struct {
	// A list of invalid auto-incremented columns.
	AutoIncrementColumnNames pulumi.StringArrayInput `pulumi:"autoIncrementColumnNames"`
	// The charset of the schema.
	CharsetName pulumi.StringInput `pulumi:"charsetName"`
	// The name of the invalid check constraint.
	CheckConstraintName pulumi.StringInput `pulumi:"checkConstraintName"`
	// The column in a table relevant to the error.
	ColumnName pulumi.StringInput `pulumi:"columnName"`
	// A link to the documentation related to the error.
	DocsUrl pulumi.StringInput `pulumi:"docsUrl"`
	// The engine of the schema.
	EngineName pulumi.StringInput `pulumi:"engineName"`
	// The name of the invalid enum value.
	EnumValue pulumi.StringInput `pulumi:"enumValue"`
	// A description for the error that occurred.
	ErrorDescription pulumi.StringInput `pulumi:"errorDescription"`
	// A list of invalid foreign key columns in a table.
	ForeignKeyColumnNames pulumi.StringArrayInput `pulumi:"foreignKeyColumnNames"`
	// The path for an invalid JSON column.
	JsonPath pulumi.StringInput `pulumi:"jsonPath"`
	// The keyspace of the schema with the error.
	KeyspaceName pulumi.StringInput `pulumi:"keyspaceName"`
	// Code representing.
	LintError pulumi.StringInput `pulumi:"lintError"`
	// The name of the invalid partition in the schema.
	PartitionName pulumi.StringInput `pulumi:"partitionName"`
	// The name of the invalid partitioning type.
	PartitioningType pulumi.StringInput `pulumi:"partitioningType"`
	// The subject for the errors.
	SubjectType pulumi.StringInput `pulumi:"subjectType"`
	// The table with the error.
	TableName pulumi.StringInput `pulumi:"tableName"`
	// The name of the vindex for the schema.
	VindexName pulumi.StringInput `pulumi:"vindexName"`
}

func (GetBranchSchemaLintErrorArgs) ElementType 

func (GetBranchSchemaLintErrorArgs) ElementType() reflect.Type

func (GetBranchSchemaLintErrorArgs) ToGetBranchSchemaLintErrorOutput 

func (i GetBranchSchemaLintErrorArgs) ToGetBranchSchemaLintErrorOutput() GetBranchSchemaLintErrorOutput

func (GetBranchSchemaLintErrorArgs) ToGetBranchSchemaLintErrorOutputWithContext 

func (i GetBranchSchemaLintErrorArgs) ToGetBranchSchemaLintErrorOutputWithContext(ctx context.Context) GetBranchSchemaLintErrorOutput

type GetBranchSchemaLintErrorArray 

type GetBranchSchemaLintErrorArray []GetBranchSchemaLintErrorInput

func (GetBranchSchemaLintErrorArray) ElementType 

func (GetBranchSchemaLintErrorArray) ElementType() reflect.Type

func (GetBranchSchemaLintErrorArray) ToGetBranchSchemaLintErrorArrayOutput 

func (i GetBranchSchemaLintErrorArray) ToGetBranchSchemaLintErrorArrayOutput() GetBranchSchemaLintErrorArrayOutput

func (GetBranchSchemaLintErrorArray) ToGetBranchSchemaLintErrorArrayOutputWithContext 

func (i GetBranchSchemaLintErrorArray) ToGetBranchSchemaLintErrorArrayOutputWithContext(ctx context.Context) GetBranchSchemaLintErrorArrayOutput

type GetBranchSchemaLintErrorArrayInput 

type GetBranchSchemaLintErrorArrayInput interface {
	pulumi.Input

	ToGetBranchSchemaLintErrorArrayOutput() GetBranchSchemaLintErrorArrayOutput
	ToGetBranchSchemaLintErrorArrayOutputWithContext(context.Context) GetBranchSchemaLintErrorArrayOutput
}

GetBranchSchemaLintErrorArrayInput is an input type that accepts GetBranchSchemaLintErrorArray and GetBranchSchemaLintErrorArrayOutput values. You can construct a concrete instance of `GetBranchSchemaLintErrorArrayInput` via: 

GetBranchSchemaLintErrorArray{ GetBranchSchemaLintErrorArgs{...} }

type GetBranchSchemaLintErrorArrayOutput 

type GetBranchSchemaLintErrorArrayOutput struct{ *pulumi.OutputState }

func (GetBranchSchemaLintErrorArrayOutput) ElementType 

func (GetBranchSchemaLintErrorArrayOutput) ElementType() reflect.Type

func (GetBranchSchemaLintErrorArrayOutput) Index 

func (o GetBranchSchemaLintErrorArrayOutput) Index(i pulumi.IntInput) GetBranchSchemaLintErrorOutput

func (GetBranchSchemaLintErrorArrayOutput) ToGetBranchSchemaLintErrorArrayOutput 

func (o GetBranchSchemaLintErrorArrayOutput) ToGetBranchSchemaLintErrorArrayOutput() GetBranchSchemaLintErrorArrayOutput

func (GetBranchSchemaLintErrorArrayOutput) ToGetBranchSchemaLintErrorArrayOutputWithContext 

func (o GetBranchSchemaLintErrorArrayOutput) ToGetBranchSchemaLintErrorArrayOutputWithContext(ctx context.Context) GetBranchSchemaLintErrorArrayOutput

type GetBranchSchemaLintErrorInput 

type GetBranchSchemaLintErrorInput interface {
	pulumi.Input

	ToGetBranchSchemaLintErrorOutput() GetBranchSchemaLintErrorOutput
	ToGetBranchSchemaLintErrorOutputWithContext(context.Context) GetBranchSchemaLintErrorOutput
}

GetBranchSchemaLintErrorInput is an input type that accepts GetBranchSchemaLintErrorArgs and GetBranchSchemaLintErrorOutput values. You can construct a concrete instance of `GetBranchSchemaLintErrorInput` via: 

GetBranchSchemaLintErrorArgs{...}

type GetBranchSchemaLintErrorOutput 

type GetBranchSchemaLintErrorOutput struct{ *pulumi.OutputState }

func (GetBranchSchemaLintErrorOutput) AutoIncrementColumnNames 

func (o GetBranchSchemaLintErrorOutput) AutoIncrementColumnNames() pulumi.StringArrayOutput

A list of invalid auto-incremented columns.

func (GetBranchSchemaLintErrorOutput) CharsetName 

func (o GetBranchSchemaLintErrorOutput) CharsetName() pulumi.StringOutput

The charset of the schema.

func (GetBranchSchemaLintErrorOutput) CheckConstraintName 

func (o GetBranchSchemaLintErrorOutput) CheckConstraintName() pulumi.StringOutput

The name of the invalid check constraint.

func (GetBranchSchemaLintErrorOutput) ColumnName 

func (o GetBranchSchemaLintErrorOutput) ColumnName() pulumi.StringOutput

The column in a table relevant to the error.

func (GetBranchSchemaLintErrorOutput) DocsUrl 

func (o GetBranchSchemaLintErrorOutput) DocsUrl() pulumi.StringOutput

A link to the documentation related to the error.

func (GetBranchSchemaLintErrorOutput) ElementType 

func (GetBranchSchemaLintErrorOutput) ElementType() reflect.Type

func (GetBranchSchemaLintErrorOutput) EngineName 

func (o GetBranchSchemaLintErrorOutput) EngineName() pulumi.StringOutput

The engine of the schema.

func (GetBranchSchemaLintErrorOutput) EnumValue 

func (o GetBranchSchemaLintErrorOutput) EnumValue() pulumi.StringOutput

The name of the invalid enum value.

func (GetBranchSchemaLintErrorOutput) ErrorDescription 

func (o GetBranchSchemaLintErrorOutput) ErrorDescription() pulumi.StringOutput

A description for the error that occurred.

func (GetBranchSchemaLintErrorOutput) ForeignKeyColumnNames 

func (o GetBranchSchemaLintErrorOutput) ForeignKeyColumnNames() pulumi.StringArrayOutput

A list of invalid foreign key columns in a table.

func (GetBranchSchemaLintErrorOutput) JsonPath 

func (o GetBranchSchemaLintErrorOutput) JsonPath() pulumi.StringOutput

The path for an invalid JSON column.

func (GetBranchSchemaLintErrorOutput) KeyspaceName 

func (o GetBranchSchemaLintErrorOutput) KeyspaceName() pulumi.StringOutput

The keyspace of the schema with the error.

func (GetBranchSchemaLintErrorOutput) LintError 

func (o GetBranchSchemaLintErrorOutput) LintError() pulumi.StringOutput

Code representing.

func (GetBranchSchemaLintErrorOutput) PartitionName 

func (o GetBranchSchemaLintErrorOutput) PartitionName() pulumi.StringOutput

The name of the invalid partition in the schema.

func (GetBranchSchemaLintErrorOutput) PartitioningType 

func (o GetBranchSchemaLintErrorOutput) PartitioningType() pulumi.StringOutput

The name of the invalid partitioning type.

func (GetBranchSchemaLintErrorOutput) SubjectType 

func (o GetBranchSchemaLintErrorOutput) SubjectType() pulumi.StringOutput

The subject for the errors.

func (GetBranchSchemaLintErrorOutput) TableName 

func (o GetBranchSchemaLintErrorOutput) TableName() pulumi.StringOutput

The table with the error.

func (GetBranchSchemaLintErrorOutput) ToGetBranchSchemaLintErrorOutput 

func (o GetBranchSchemaLintErrorOutput) ToGetBranchSchemaLintErrorOutput() GetBranchSchemaLintErrorOutput

func (GetBranchSchemaLintErrorOutput) ToGetBranchSchemaLintErrorOutputWithContext 

func (o GetBranchSchemaLintErrorOutput) ToGetBranchSchemaLintErrorOutputWithContext(ctx context.Context) GetBranchSchemaLintErrorOutput

func (GetBranchSchemaLintErrorOutput) VindexName 

func (o GetBranchSchemaLintErrorOutput) VindexName() pulumi.StringOutput

The name of the vindex for the schema.

type GetBranchSchemaLintOutputArgs 

type GetBranchSchemaLintOutputArgs struct {
	Branch       pulumi.StringInput `pulumi:"branch"`
	Database     pulumi.StringInput `pulumi:"database"`
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getBranchSchemaLint.

func (GetBranchSchemaLintOutputArgs) ElementType 

func (GetBranchSchemaLintOutputArgs) ElementType() reflect.Type

type GetBranchSchemaLintResult 

type GetBranchSchemaLintResult struct {
	Branch   string                     `pulumi:"branch"`
	Database string                     `pulumi:"database"`
	Errors   []GetBranchSchemaLintError `pulumi:"errors"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	Organization string `pulumi:"organization"`
}

A collection of values returned by getBranchSchemaLint.

func GetBranchSchemaLint 

func GetBranchSchemaLint(ctx *pulumi.Context, args *GetBranchSchemaLintArgs, opts ...pulumi.InvokeOption) (*GetBranchSchemaLintResult, error)

Linting errors for the schema of a PlanetScale branch.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

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

```

type GetBranchSchemaLintResultOutput 

type GetBranchSchemaLintResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBranchSchemaLint.

func GetBranchSchemaLintOutput 

func GetBranchSchemaLintOutput(ctx *pulumi.Context, args GetBranchSchemaLintOutputArgs, opts ...pulumi.InvokeOption) GetBranchSchemaLintResultOutput

func (GetBranchSchemaLintResultOutput) Branch 

func (o GetBranchSchemaLintResultOutput) Branch() pulumi.StringOutput

func (GetBranchSchemaLintResultOutput) Database 

func (o GetBranchSchemaLintResultOutput) Database() pulumi.StringOutput

func (GetBranchSchemaLintResultOutput) ElementType 

func (GetBranchSchemaLintResultOutput) ElementType() reflect.Type

func (GetBranchSchemaLintResultOutput) Errors 

func (o GetBranchSchemaLintResultOutput) Errors() GetBranchSchemaLintErrorArrayOutput

func (GetBranchSchemaLintResultOutput) Id 

func (o GetBranchSchemaLintResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetBranchSchemaLintResultOutput) Organization 

func (o GetBranchSchemaLintResultOutput) Organization() pulumi.StringOutput

func (GetBranchSchemaLintResultOutput) ToGetBranchSchemaLintResultOutput 

func (o GetBranchSchemaLintResultOutput) ToGetBranchSchemaLintResultOutput() GetBranchSchemaLintResultOutput

func (GetBranchSchemaLintResultOutput) ToGetBranchSchemaLintResultOutputWithContext 

func (o GetBranchSchemaLintResultOutput) ToGetBranchSchemaLintResultOutputWithContext(ctx context.Context) GetBranchSchemaLintResultOutput

type GetBranchSchemaOutputArgs 

type GetBranchSchemaOutputArgs struct {
	Branch       pulumi.StringInput    `pulumi:"branch"`
	Database     pulumi.StringInput    `pulumi:"database"`
	Keyspace     pulumi.StringPtrInput `pulumi:"keyspace"`
	Organization pulumi.StringInput    `pulumi:"organization"`
}

A collection of arguments for invoking getBranchSchema.

func (GetBranchSchemaOutputArgs) ElementType 

func (GetBranchSchemaOutputArgs) ElementType() reflect.Type

type GetBranchSchemaResult 

type GetBranchSchemaResult struct {
	Branch   string `pulumi:"branch"`
	Database string `pulumi:"database"`
	// The provider-assigned unique ID for this managed resource.
	Id           string                 `pulumi:"id"`
	Keyspace     *string                `pulumi:"keyspace"`
	Organization string                 `pulumi:"organization"`
	Tables       []GetBranchSchemaTable `pulumi:"tables"`
}

A collection of values returned by getBranchSchema.

func GetBranchSchema 

func GetBranchSchema(ctx *pulumi.Context, args *GetBranchSchemaArgs, opts ...pulumi.InvokeOption) (*GetBranchSchemaResult, error)

The schema of a PlanetScale branch.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

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

```

type GetBranchSchemaResultOutput 

type GetBranchSchemaResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBranchSchema.

func GetBranchSchemaOutput 

func GetBranchSchemaOutput(ctx *pulumi.Context, args GetBranchSchemaOutputArgs, opts ...pulumi.InvokeOption) GetBranchSchemaResultOutput

func (GetBranchSchemaResultOutput) Branch 

func (o GetBranchSchemaResultOutput) Branch() pulumi.StringOutput

func (GetBranchSchemaResultOutput) Database 

func (o GetBranchSchemaResultOutput) Database() pulumi.StringOutput

func (GetBranchSchemaResultOutput) ElementType 

func (GetBranchSchemaResultOutput) ElementType() reflect.Type

func (GetBranchSchemaResultOutput) Id 

func (o GetBranchSchemaResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetBranchSchemaResultOutput) Keyspace 

func (o GetBranchSchemaResultOutput) Keyspace() pulumi.StringPtrOutput

func (GetBranchSchemaResultOutput) Organization 

func (o GetBranchSchemaResultOutput) Organization() pulumi.StringOutput

func (GetBranchSchemaResultOutput) Tables 

func (o GetBranchSchemaResultOutput) Tables() GetBranchSchemaTableArrayOutput

func (GetBranchSchemaResultOutput) ToGetBranchSchemaResultOutput 

func (o GetBranchSchemaResultOutput) ToGetBranchSchemaResultOutput() GetBranchSchemaResultOutput

func (GetBranchSchemaResultOutput) ToGetBranchSchemaResultOutputWithContext 

func (o GetBranchSchemaResultOutput) ToGetBranchSchemaResultOutputWithContext(ctx context.Context) GetBranchSchemaResultOutput

type GetBranchSchemaTable 

type GetBranchSchemaTable struct {
	// Syntax highlighted HTML for the table's schema.
	Html string `pulumi:"html"`
	// Name of the table.
	Name string `pulumi:"name"`
	// The table's schema.
	Raw string `pulumi:"raw"`
}

type GetBranchSchemaTableArgs 

type GetBranchSchemaTableArgs struct {
	// Syntax highlighted HTML for the table's schema.
	Html pulumi.StringInput `pulumi:"html"`
	// Name of the table.
	Name pulumi.StringInput `pulumi:"name"`
	// The table's schema.
	Raw pulumi.StringInput `pulumi:"raw"`
}

func (GetBranchSchemaTableArgs) ElementType 

func (GetBranchSchemaTableArgs) ElementType() reflect.Type

func (GetBranchSchemaTableArgs) ToGetBranchSchemaTableOutput 

func (i GetBranchSchemaTableArgs) ToGetBranchSchemaTableOutput() GetBranchSchemaTableOutput

func (GetBranchSchemaTableArgs) ToGetBranchSchemaTableOutputWithContext 

func (i GetBranchSchemaTableArgs) ToGetBranchSchemaTableOutputWithContext(ctx context.Context) GetBranchSchemaTableOutput

type GetBranchSchemaTableArray 

type GetBranchSchemaTableArray []GetBranchSchemaTableInput

func (GetBranchSchemaTableArray) ElementType 

func (GetBranchSchemaTableArray) ElementType() reflect.Type

func (GetBranchSchemaTableArray) ToGetBranchSchemaTableArrayOutput 

func (i GetBranchSchemaTableArray) ToGetBranchSchemaTableArrayOutput() GetBranchSchemaTableArrayOutput

func (GetBranchSchemaTableArray) ToGetBranchSchemaTableArrayOutputWithContext 

func (i GetBranchSchemaTableArray) ToGetBranchSchemaTableArrayOutputWithContext(ctx context.Context) GetBranchSchemaTableArrayOutput

type GetBranchSchemaTableArrayInput 

type GetBranchSchemaTableArrayInput interface {
	pulumi.Input

	ToGetBranchSchemaTableArrayOutput() GetBranchSchemaTableArrayOutput
	ToGetBranchSchemaTableArrayOutputWithContext(context.Context) GetBranchSchemaTableArrayOutput
}

GetBranchSchemaTableArrayInput is an input type that accepts GetBranchSchemaTableArray and GetBranchSchemaTableArrayOutput values. You can construct a concrete instance of `GetBranchSchemaTableArrayInput` via: 

GetBranchSchemaTableArray{ GetBranchSchemaTableArgs{...} }

type GetBranchSchemaTableArrayOutput 

type GetBranchSchemaTableArrayOutput struct{ *pulumi.OutputState }

func (GetBranchSchemaTableArrayOutput) ElementType 

func (GetBranchSchemaTableArrayOutput) ElementType() reflect.Type

func (GetBranchSchemaTableArrayOutput) Index 

func (o GetBranchSchemaTableArrayOutput) Index(i pulumi.IntInput) GetBranchSchemaTableOutput

func (GetBranchSchemaTableArrayOutput) ToGetBranchSchemaTableArrayOutput 

func (o GetBranchSchemaTableArrayOutput) ToGetBranchSchemaTableArrayOutput() GetBranchSchemaTableArrayOutput

func (GetBranchSchemaTableArrayOutput) ToGetBranchSchemaTableArrayOutputWithContext 

func (o GetBranchSchemaTableArrayOutput) ToGetBranchSchemaTableArrayOutputWithContext(ctx context.Context) GetBranchSchemaTableArrayOutput

type GetBranchSchemaTableInput 

type GetBranchSchemaTableInput interface {
	pulumi.Input

	ToGetBranchSchemaTableOutput() GetBranchSchemaTableOutput
	ToGetBranchSchemaTableOutputWithContext(context.Context) GetBranchSchemaTableOutput
}

GetBranchSchemaTableInput is an input type that accepts GetBranchSchemaTableArgs and GetBranchSchemaTableOutput values. You can construct a concrete instance of `GetBranchSchemaTableInput` via: 

GetBranchSchemaTableArgs{...}

type GetBranchSchemaTableOutput 

type GetBranchSchemaTableOutput struct{ *pulumi.OutputState }

func (GetBranchSchemaTableOutput) ElementType 

func (GetBranchSchemaTableOutput) ElementType() reflect.Type

func (GetBranchSchemaTableOutput) Html 

func (o GetBranchSchemaTableOutput) Html() pulumi.StringOutput

Syntax highlighted HTML for the table's schema.

func (GetBranchSchemaTableOutput) Name 

func (o GetBranchSchemaTableOutput) Name() pulumi.StringOutput

Name of the table.

func (GetBranchSchemaTableOutput) Raw 

func (o GetBranchSchemaTableOutput) Raw() pulumi.StringOutput

The table's schema.

func (GetBranchSchemaTableOutput) ToGetBranchSchemaTableOutput 

func (o GetBranchSchemaTableOutput) ToGetBranchSchemaTableOutput() GetBranchSchemaTableOutput

func (GetBranchSchemaTableOutput) ToGetBranchSchemaTableOutputWithContext 

func (o GetBranchSchemaTableOutput) ToGetBranchSchemaTableOutputWithContext(ctx context.Context) GetBranchSchemaTableOutput

type GetBranchesArgs 

type GetBranchesArgs struct {
	Database     string `pulumi:"database"`
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getBranches.

type GetBranchesBranch 

type GetBranchesBranch struct {
	// The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.
	AccessHostUrl string `pulumi:"accessHostUrl"`
	// The actor who created this branch.
	Actor GetBranchesBranchActor `pulumi:"actor"`
	// The SKU representing the branch's cluster size.
	ClusterRateName string `pulumi:"clusterRateName"`
	// When the branch was created.
	CreatedAt string `pulumi:"createdAt"`
	// The database this branch belongs to.
	Database string `pulumi:"database"`
	// Planetscale app URL for the branch.
	HtmlUrl string `pulumi:"htmlUrl"`
	// The ID of the branch.
	Id string `pulumi:"id"`
	// The ID of the backup from which the branch was restored.
	InitialRestoreId string `pulumi:"initialRestoreId"`
	// The MySQL address for the branch.
	MysqlAddress string `pulumi:"mysqlAddress"`
	// The address of the MySQL provider for the branch.
	MysqlEdgeAddress string `pulumi:"mysqlEdgeAddress"`
	// The name of the branch.
	Name string `pulumi:"name"`
	// The organization this branch belongs to.
	Organization string `pulumi:"organization"`
	// The name of the parent branch from which the branch was created.
	ParentBranch string `pulumi:"parentBranch"`
	// Whether or not the branch is a production branch.
	Production bool `pulumi:"production"`
	// Whether or not the branch is ready to serve queries.
	Ready bool `pulumi:"ready"`
	// The region in which this branch lives.
	Region GetBranchesBranchRegion `pulumi:"region"`
	// When a user last marked a backup restore checklist as completed.
	RestoreChecklistCompletedAt string                              `pulumi:"restoreChecklistCompletedAt"`
	RestoredFromBranch          GetBranchesBranchRestoredFromBranch `pulumi:"restoredFromBranch"`
	// When the schema for the branch was last updated.
	SchemaLastUpdatedAt string `pulumi:"schemaLastUpdatedAt"`
	// The number of shards in the branch.
	ShardCount float64 `pulumi:"shardCount"`
	// Whether or not the branch is sharded.
	Sharded bool `pulumi:"sharded"`
	// When the branch was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBranchesBranchActor 

type GetBranchesBranchActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetBranchesBranchActorArgs 

type GetBranchesBranchActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetBranchesBranchActorArgs) ElementType 

func (GetBranchesBranchActorArgs) ElementType() reflect.Type

func (GetBranchesBranchActorArgs) ToGetBranchesBranchActorOutput 

func (i GetBranchesBranchActorArgs) ToGetBranchesBranchActorOutput() GetBranchesBranchActorOutput

func (GetBranchesBranchActorArgs) ToGetBranchesBranchActorOutputWithContext 

func (i GetBranchesBranchActorArgs) ToGetBranchesBranchActorOutputWithContext(ctx context.Context) GetBranchesBranchActorOutput

type GetBranchesBranchActorInput 

type GetBranchesBranchActorInput interface {
	pulumi.Input

	ToGetBranchesBranchActorOutput() GetBranchesBranchActorOutput
	ToGetBranchesBranchActorOutputWithContext(context.Context) GetBranchesBranchActorOutput
}

GetBranchesBranchActorInput is an input type that accepts GetBranchesBranchActorArgs and GetBranchesBranchActorOutput values. You can construct a concrete instance of `GetBranchesBranchActorInput` via: 

GetBranchesBranchActorArgs{...}

type GetBranchesBranchActorOutput 

type GetBranchesBranchActorOutput struct{ *pulumi.OutputState }

func (GetBranchesBranchActorOutput) AvatarUrl 

func (o GetBranchesBranchActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetBranchesBranchActorOutput) DisplayName 

func (o GetBranchesBranchActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetBranchesBranchActorOutput) ElementType 

func (GetBranchesBranchActorOutput) ElementType() reflect.Type

func (GetBranchesBranchActorOutput) Id 

func (o GetBranchesBranchActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetBranchesBranchActorOutput) ToGetBranchesBranchActorOutput 

func (o GetBranchesBranchActorOutput) ToGetBranchesBranchActorOutput() GetBranchesBranchActorOutput

func (GetBranchesBranchActorOutput) ToGetBranchesBranchActorOutputWithContext 

func (o GetBranchesBranchActorOutput) ToGetBranchesBranchActorOutputWithContext(ctx context.Context) GetBranchesBranchActorOutput

type GetBranchesBranchArgs 

type GetBranchesBranchArgs struct {
	// The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.
	AccessHostUrl pulumi.StringInput `pulumi:"accessHostUrl"`
	// The actor who created this branch.
	Actor GetBranchesBranchActorInput `pulumi:"actor"`
	// The SKU representing the branch's cluster size.
	ClusterRateName pulumi.StringInput `pulumi:"clusterRateName"`
	// When the branch was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The database this branch belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// Planetscale app URL for the branch.
	HtmlUrl pulumi.StringInput `pulumi:"htmlUrl"`
	// The ID of the branch.
	Id pulumi.StringInput `pulumi:"id"`
	// The ID of the backup from which the branch was restored.
	InitialRestoreId pulumi.StringInput `pulumi:"initialRestoreId"`
	// The MySQL address for the branch.
	MysqlAddress pulumi.StringInput `pulumi:"mysqlAddress"`
	// The address of the MySQL provider for the branch.
	MysqlEdgeAddress pulumi.StringInput `pulumi:"mysqlEdgeAddress"`
	// The name of the branch.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this branch belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// The name of the parent branch from which the branch was created.
	ParentBranch pulumi.StringInput `pulumi:"parentBranch"`
	// Whether or not the branch is a production branch.
	Production pulumi.BoolInput `pulumi:"production"`
	// Whether or not the branch is ready to serve queries.
	Ready pulumi.BoolInput `pulumi:"ready"`
	// The region in which this branch lives.
	Region GetBranchesBranchRegionInput `pulumi:"region"`
	// When a user last marked a backup restore checklist as completed.
	RestoreChecklistCompletedAt pulumi.StringInput                       `pulumi:"restoreChecklistCompletedAt"`
	RestoredFromBranch          GetBranchesBranchRestoredFromBranchInput `pulumi:"restoredFromBranch"`
	// When the schema for the branch was last updated.
	SchemaLastUpdatedAt pulumi.StringInput `pulumi:"schemaLastUpdatedAt"`
	// The number of shards in the branch.
	ShardCount pulumi.Float64Input `pulumi:"shardCount"`
	// Whether or not the branch is sharded.
	Sharded pulumi.BoolInput `pulumi:"sharded"`
	// When the branch was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBranchesBranchArgs) ElementType 

func (GetBranchesBranchArgs) ElementType() reflect.Type

func (GetBranchesBranchArgs) ToGetBranchesBranchOutput 

func (i GetBranchesBranchArgs) ToGetBranchesBranchOutput() GetBranchesBranchOutput

func (GetBranchesBranchArgs) ToGetBranchesBranchOutputWithContext 

func (i GetBranchesBranchArgs) ToGetBranchesBranchOutputWithContext(ctx context.Context) GetBranchesBranchOutput

type GetBranchesBranchArray 

type GetBranchesBranchArray []GetBranchesBranchInput

func (GetBranchesBranchArray) ElementType 

func (GetBranchesBranchArray) ElementType() reflect.Type

func (GetBranchesBranchArray) ToGetBranchesBranchArrayOutput 

func (i GetBranchesBranchArray) ToGetBranchesBranchArrayOutput() GetBranchesBranchArrayOutput

func (GetBranchesBranchArray) ToGetBranchesBranchArrayOutputWithContext 

func (i GetBranchesBranchArray) ToGetBranchesBranchArrayOutputWithContext(ctx context.Context) GetBranchesBranchArrayOutput

type GetBranchesBranchArrayInput 

type GetBranchesBranchArrayInput interface {
	pulumi.Input

	ToGetBranchesBranchArrayOutput() GetBranchesBranchArrayOutput
	ToGetBranchesBranchArrayOutputWithContext(context.Context) GetBranchesBranchArrayOutput
}

GetBranchesBranchArrayInput is an input type that accepts GetBranchesBranchArray and GetBranchesBranchArrayOutput values. You can construct a concrete instance of `GetBranchesBranchArrayInput` via: 

GetBranchesBranchArray{ GetBranchesBranchArgs{...} }

type GetBranchesBranchArrayOutput 

type GetBranchesBranchArrayOutput struct{ *pulumi.OutputState }

func (GetBranchesBranchArrayOutput) ElementType 

func (GetBranchesBranchArrayOutput) ElementType() reflect.Type

func (GetBranchesBranchArrayOutput) Index 

func (o GetBranchesBranchArrayOutput) Index(i pulumi.IntInput) GetBranchesBranchOutput

func (GetBranchesBranchArrayOutput) ToGetBranchesBranchArrayOutput 

func (o GetBranchesBranchArrayOutput) ToGetBranchesBranchArrayOutput() GetBranchesBranchArrayOutput

func (GetBranchesBranchArrayOutput) ToGetBranchesBranchArrayOutputWithContext 

func (o GetBranchesBranchArrayOutput) ToGetBranchesBranchArrayOutputWithContext(ctx context.Context) GetBranchesBranchArrayOutput

type GetBranchesBranchInput 

type GetBranchesBranchInput interface {
	pulumi.Input

	ToGetBranchesBranchOutput() GetBranchesBranchOutput
	ToGetBranchesBranchOutputWithContext(context.Context) GetBranchesBranchOutput
}

GetBranchesBranchInput is an input type that accepts GetBranchesBranchArgs and GetBranchesBranchOutput values. You can construct a concrete instance of `GetBranchesBranchInput` via: 

GetBranchesBranchArgs{...}

type GetBranchesBranchOutput 

type GetBranchesBranchOutput struct{ *pulumi.OutputState }

func (GetBranchesBranchOutput) AccessHostUrl 

func (o GetBranchesBranchOutput) AccessHostUrl() pulumi.StringOutput

The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.

func (GetBranchesBranchOutput) Actor 

func (o GetBranchesBranchOutput) Actor() GetBranchesBranchActorOutput

The actor who created this branch.

func (GetBranchesBranchOutput) ClusterRateName 

func (o GetBranchesBranchOutput) ClusterRateName() pulumi.StringOutput

The SKU representing the branch's cluster size.

func (GetBranchesBranchOutput) CreatedAt 

func (o GetBranchesBranchOutput) CreatedAt() pulumi.StringOutput

When the branch was created.

func (GetBranchesBranchOutput) Database 

func (o GetBranchesBranchOutput) Database() pulumi.StringOutput

The database this branch belongs to.

func (GetBranchesBranchOutput) ElementType 

func (GetBranchesBranchOutput) ElementType() reflect.Type

func (GetBranchesBranchOutput) HtmlUrl 

func (o GetBranchesBranchOutput) HtmlUrl() pulumi.StringOutput

Planetscale app URL for the branch.

func (GetBranchesBranchOutput) Id 

func (o GetBranchesBranchOutput) Id() pulumi.StringOutput

The ID of the branch.

func (GetBranchesBranchOutput) InitialRestoreId 

func (o GetBranchesBranchOutput) InitialRestoreId() pulumi.StringOutput

The ID of the backup from which the branch was restored.

func (GetBranchesBranchOutput) MysqlAddress 

func (o GetBranchesBranchOutput) MysqlAddress() pulumi.StringOutput

The MySQL address for the branch.

func (GetBranchesBranchOutput) MysqlEdgeAddress 

func (o GetBranchesBranchOutput) MysqlEdgeAddress() pulumi.StringOutput

The address of the MySQL provider for the branch.

func (GetBranchesBranchOutput) Name 

func (o GetBranchesBranchOutput) Name() pulumi.StringOutput

The name of the branch.

func (GetBranchesBranchOutput) Organization 

func (o GetBranchesBranchOutput) Organization() pulumi.StringOutput

The organization this branch belongs to.

func (GetBranchesBranchOutput) ParentBranch 

func (o GetBranchesBranchOutput) ParentBranch() pulumi.StringOutput

The name of the parent branch from which the branch was created.

func (GetBranchesBranchOutput) Production 

func (o GetBranchesBranchOutput) Production() pulumi.BoolOutput

Whether or not the branch is a production branch.

func (GetBranchesBranchOutput) Ready 

func (o GetBranchesBranchOutput) Ready() pulumi.BoolOutput

Whether or not the branch is ready to serve queries.

func (GetBranchesBranchOutput) Region 

func (o GetBranchesBranchOutput) Region() GetBranchesBranchRegionOutput

The region in which this branch lives.

func (GetBranchesBranchOutput) RestoreChecklistCompletedAt 

func (o GetBranchesBranchOutput) RestoreChecklistCompletedAt() pulumi.StringOutput

When a user last marked a backup restore checklist as completed.

func (GetBranchesBranchOutput) RestoredFromBranch 

func (o GetBranchesBranchOutput) RestoredFromBranch() GetBranchesBranchRestoredFromBranchOutput

func (GetBranchesBranchOutput) SchemaLastUpdatedAt 

func (o GetBranchesBranchOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the schema for the branch was last updated.

func (GetBranchesBranchOutput) ShardCount 

func (o GetBranchesBranchOutput) ShardCount() pulumi.Float64Output

The number of shards in the branch.

func (GetBranchesBranchOutput) Sharded 

func (o GetBranchesBranchOutput) Sharded() pulumi.BoolOutput

Whether or not the branch is sharded.

func (GetBranchesBranchOutput) ToGetBranchesBranchOutput 

func (o GetBranchesBranchOutput) ToGetBranchesBranchOutput() GetBranchesBranchOutput

func (GetBranchesBranchOutput) ToGetBranchesBranchOutputWithContext 

func (o GetBranchesBranchOutput) ToGetBranchesBranchOutputWithContext(ctx context.Context) GetBranchesBranchOutput

func (GetBranchesBranchOutput) UpdatedAt 

func (o GetBranchesBranchOutput) UpdatedAt() pulumi.StringOutput

When the branch was last updated.

type GetBranchesBranchRegion 

type GetBranchesBranchRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetBranchesBranchRegionArgs 

type GetBranchesBranchRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetBranchesBranchRegionArgs) ElementType 

func (GetBranchesBranchRegionArgs) ElementType() reflect.Type

func (GetBranchesBranchRegionArgs) ToGetBranchesBranchRegionOutput 

func (i GetBranchesBranchRegionArgs) ToGetBranchesBranchRegionOutput() GetBranchesBranchRegionOutput

func (GetBranchesBranchRegionArgs) ToGetBranchesBranchRegionOutputWithContext 

func (i GetBranchesBranchRegionArgs) ToGetBranchesBranchRegionOutputWithContext(ctx context.Context) GetBranchesBranchRegionOutput

type GetBranchesBranchRegionInput 

type GetBranchesBranchRegionInput interface {
	pulumi.Input

	ToGetBranchesBranchRegionOutput() GetBranchesBranchRegionOutput
	ToGetBranchesBranchRegionOutputWithContext(context.Context) GetBranchesBranchRegionOutput
}

GetBranchesBranchRegionInput is an input type that accepts GetBranchesBranchRegionArgs and GetBranchesBranchRegionOutput values. You can construct a concrete instance of `GetBranchesBranchRegionInput` via: 

GetBranchesBranchRegionArgs{...}

type GetBranchesBranchRegionOutput 

type GetBranchesBranchRegionOutput struct{ *pulumi.OutputState }

func (GetBranchesBranchRegionOutput) DisplayName 

func (o GetBranchesBranchRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetBranchesBranchRegionOutput) ElementType 

func (GetBranchesBranchRegionOutput) ElementType() reflect.Type

func (GetBranchesBranchRegionOutput) Enabled 

func (o GetBranchesBranchRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetBranchesBranchRegionOutput) Id 

func (o GetBranchesBranchRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetBranchesBranchRegionOutput) Location 

func (o GetBranchesBranchRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetBranchesBranchRegionOutput) Provider 

func (o GetBranchesBranchRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetBranchesBranchRegionOutput) PublicIpAddresses 

func (o GetBranchesBranchRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetBranchesBranchRegionOutput) Slug 

func (o GetBranchesBranchRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetBranchesBranchRegionOutput) ToGetBranchesBranchRegionOutput 

func (o GetBranchesBranchRegionOutput) ToGetBranchesBranchRegionOutput() GetBranchesBranchRegionOutput

func (GetBranchesBranchRegionOutput) ToGetBranchesBranchRegionOutputWithContext 

func (o GetBranchesBranchRegionOutput) ToGetBranchesBranchRegionOutputWithContext(ctx context.Context) GetBranchesBranchRegionOutput

type GetBranchesBranchRestoredFromBranch 

type GetBranchesBranchRestoredFromBranch struct {
	// When the resource was created.
	CreatedAt string `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt string `pulumi:"deletedAt"`
	// The ID for the resource.
	Id string `pulumi:"id"`
	// The name for the resource.
	Name string `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetBranchesBranchRestoredFromBranchArgs 

type GetBranchesBranchRestoredFromBranchArgs struct {
	// When the resource was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// When the resource was deleted, if deleted.
	DeletedAt pulumi.StringInput `pulumi:"deletedAt"`
	// The ID for the resource.
	Id pulumi.StringInput `pulumi:"id"`
	// The name for the resource.
	Name pulumi.StringInput `pulumi:"name"`
	// When the resource was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetBranchesBranchRestoredFromBranchArgs) ElementType 

func (GetBranchesBranchRestoredFromBranchArgs) ElementType() reflect.Type

func (GetBranchesBranchRestoredFromBranchArgs) ToGetBranchesBranchRestoredFromBranchOutput 

func (i GetBranchesBranchRestoredFromBranchArgs) ToGetBranchesBranchRestoredFromBranchOutput() GetBranchesBranchRestoredFromBranchOutput

func (GetBranchesBranchRestoredFromBranchArgs) ToGetBranchesBranchRestoredFromBranchOutputWithContext 

func (i GetBranchesBranchRestoredFromBranchArgs) ToGetBranchesBranchRestoredFromBranchOutputWithContext(ctx context.Context) GetBranchesBranchRestoredFromBranchOutput

type GetBranchesBranchRestoredFromBranchInput 

type GetBranchesBranchRestoredFromBranchInput interface {
	pulumi.Input

	ToGetBranchesBranchRestoredFromBranchOutput() GetBranchesBranchRestoredFromBranchOutput
	ToGetBranchesBranchRestoredFromBranchOutputWithContext(context.Context) GetBranchesBranchRestoredFromBranchOutput
}

GetBranchesBranchRestoredFromBranchInput is an input type that accepts GetBranchesBranchRestoredFromBranchArgs and GetBranchesBranchRestoredFromBranchOutput values. You can construct a concrete instance of `GetBranchesBranchRestoredFromBranchInput` via: 

GetBranchesBranchRestoredFromBranchArgs{...}

type GetBranchesBranchRestoredFromBranchOutput 

type GetBranchesBranchRestoredFromBranchOutput struct{ *pulumi.OutputState }

func (GetBranchesBranchRestoredFromBranchOutput) CreatedAt 

func (o GetBranchesBranchRestoredFromBranchOutput) CreatedAt() pulumi.StringOutput

When the resource was created.

func (GetBranchesBranchRestoredFromBranchOutput) DeletedAt 

func (o GetBranchesBranchRestoredFromBranchOutput) DeletedAt() pulumi.StringOutput

When the resource was deleted, if deleted.

func (GetBranchesBranchRestoredFromBranchOutput) ElementType 

func (GetBranchesBranchRestoredFromBranchOutput) ElementType() reflect.Type

func (GetBranchesBranchRestoredFromBranchOutput) Id 

func (o GetBranchesBranchRestoredFromBranchOutput) Id() pulumi.StringOutput

The ID for the resource.

func (GetBranchesBranchRestoredFromBranchOutput) Name 

func (o GetBranchesBranchRestoredFromBranchOutput) Name() pulumi.StringOutput

The name for the resource.

func (GetBranchesBranchRestoredFromBranchOutput) ToGetBranchesBranchRestoredFromBranchOutput 

func (o GetBranchesBranchRestoredFromBranchOutput) ToGetBranchesBranchRestoredFromBranchOutput() GetBranchesBranchRestoredFromBranchOutput

func (GetBranchesBranchRestoredFromBranchOutput) ToGetBranchesBranchRestoredFromBranchOutputWithContext 

func (o GetBranchesBranchRestoredFromBranchOutput) ToGetBranchesBranchRestoredFromBranchOutputWithContext(ctx context.Context) GetBranchesBranchRestoredFromBranchOutput

func (GetBranchesBranchRestoredFromBranchOutput) UpdatedAt 

func (o GetBranchesBranchRestoredFromBranchOutput) UpdatedAt() pulumi.StringOutput

When the resource was last updated.

type GetBranchesOutputArgs 

type GetBranchesOutputArgs struct {
	Database     pulumi.StringInput `pulumi:"database"`
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getBranches.

func (GetBranchesOutputArgs) ElementType 

func (GetBranchesOutputArgs) ElementType() reflect.Type

type GetBranchesResult 

type GetBranchesResult struct {
	Branches []GetBranchesBranch `pulumi:"branches"`
	Database string              `pulumi:"database"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	Organization string `pulumi:"organization"`
}

A collection of values returned by getBranches.

func GetBranches 

func GetBranches(ctx *pulumi.Context, args *GetBranchesArgs, opts ...pulumi.InvokeOption) (*GetBranchesResult, error)

A list of PlanetScale branches.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetBranches(ctx, &planetscale.GetBranchesArgs{
			Organization: "example.com",
			Database:     "example_db",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("branches", example)
		return nil
	})
}

```

type GetBranchesResultOutput 

type GetBranchesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBranches.

func GetBranchesOutput 

func GetBranchesOutput(ctx *pulumi.Context, args GetBranchesOutputArgs, opts ...pulumi.InvokeOption) GetBranchesResultOutput

func (GetBranchesResultOutput) Branches 

func (o GetBranchesResultOutput) Branches() GetBranchesBranchArrayOutput

func (GetBranchesResultOutput) Database 

func (o GetBranchesResultOutput) Database() pulumi.StringOutput

func (GetBranchesResultOutput) ElementType 

func (GetBranchesResultOutput) ElementType() reflect.Type

func (GetBranchesResultOutput) Id 

func (o GetBranchesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetBranchesResultOutput) Organization 

func (o GetBranchesResultOutput) Organization() pulumi.StringOutput

func (GetBranchesResultOutput) ToGetBranchesResultOutput 

func (o GetBranchesResultOutput) ToGetBranchesResultOutput() GetBranchesResultOutput

func (GetBranchesResultOutput) ToGetBranchesResultOutputWithContext 

func (o GetBranchesResultOutput) ToGetBranchesResultOutputWithContext(ctx context.Context) GetBranchesResultOutput

type GetDatabaseDataImport 

type GetDatabaseDataImport struct {
	// Connection information for the source of the data for the import.
	DataSource GetDatabaseDataImportDataSource `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt string `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors string `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt string `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State string `pulumi:"state"`
}

type GetDatabaseDataImportArgs 

type GetDatabaseDataImportArgs struct {
	// Connection information for the source of the data for the import.
	DataSource GetDatabaseDataImportDataSourceInput `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt pulumi.StringInput `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors pulumi.StringInput `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt pulumi.StringInput `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State pulumi.StringInput `pulumi:"state"`
}

func (GetDatabaseDataImportArgs) ElementType 

func (GetDatabaseDataImportArgs) ElementType() reflect.Type

func (GetDatabaseDataImportArgs) ToGetDatabaseDataImportOutput 

func (i GetDatabaseDataImportArgs) ToGetDatabaseDataImportOutput() GetDatabaseDataImportOutput

func (GetDatabaseDataImportArgs) ToGetDatabaseDataImportOutputWithContext 

func (i GetDatabaseDataImportArgs) ToGetDatabaseDataImportOutputWithContext(ctx context.Context) GetDatabaseDataImportOutput

func (GetDatabaseDataImportArgs) ToGetDatabaseDataImportPtrOutput 

func (i GetDatabaseDataImportArgs) ToGetDatabaseDataImportPtrOutput() GetDatabaseDataImportPtrOutput

func (GetDatabaseDataImportArgs) ToGetDatabaseDataImportPtrOutputWithContext 

func (i GetDatabaseDataImportArgs) ToGetDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabaseDataImportPtrOutput

type GetDatabaseDataImportDataSource 

type GetDatabaseDataImportDataSource struct {
	// The name of the database imported from.
	Database string `pulumi:"database"`
	// The hostname where the database lives.
	Hostname string `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port string `pulumi:"port"`
}

type GetDatabaseDataImportDataSourceArgs 

type GetDatabaseDataImportDataSourceArgs struct {
	// The name of the database imported from.
	Database pulumi.StringInput `pulumi:"database"`
	// The hostname where the database lives.
	Hostname pulumi.StringInput `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port pulumi.StringInput `pulumi:"port"`
}

func (GetDatabaseDataImportDataSourceArgs) ElementType 

func (GetDatabaseDataImportDataSourceArgs) ElementType() reflect.Type

func (GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourceOutput 

func (i GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourceOutput() GetDatabaseDataImportDataSourceOutput

func (GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourceOutputWithContext 

func (i GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) GetDatabaseDataImportDataSourceOutput

func (GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourcePtrOutput 

func (i GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourcePtrOutput() GetDatabaseDataImportDataSourcePtrOutput

func (GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourcePtrOutputWithContext 

func (i GetDatabaseDataImportDataSourceArgs) ToGetDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabaseDataImportDataSourcePtrOutput

type GetDatabaseDataImportDataSourceInput 

type GetDatabaseDataImportDataSourceInput interface {
	pulumi.Input

	ToGetDatabaseDataImportDataSourceOutput() GetDatabaseDataImportDataSourceOutput
	ToGetDatabaseDataImportDataSourceOutputWithContext(context.Context) GetDatabaseDataImportDataSourceOutput
}

GetDatabaseDataImportDataSourceInput is an input type that accepts GetDatabaseDataImportDataSourceArgs and GetDatabaseDataImportDataSourceOutput values. You can construct a concrete instance of `GetDatabaseDataImportDataSourceInput` via: 

GetDatabaseDataImportDataSourceArgs{...}

type GetDatabaseDataImportDataSourceOutput 

type GetDatabaseDataImportDataSourceOutput struct{ *pulumi.OutputState }

func (GetDatabaseDataImportDataSourceOutput) Database 

func (o GetDatabaseDataImportDataSourceOutput) Database() pulumi.StringOutput

The name of the database imported from.

func (GetDatabaseDataImportDataSourceOutput) ElementType 

func (GetDatabaseDataImportDataSourceOutput) ElementType() reflect.Type

func (GetDatabaseDataImportDataSourceOutput) Hostname 

func (o GetDatabaseDataImportDataSourceOutput) Hostname() pulumi.StringOutput

The hostname where the database lives.

func (GetDatabaseDataImportDataSourceOutput) Port 

func (o GetDatabaseDataImportDataSourceOutput) Port() pulumi.StringOutput

The port on which the database listens on the host.

func (GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourceOutput 

func (o GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourceOutput() GetDatabaseDataImportDataSourceOutput

func (GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourceOutputWithContext 

func (o GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) GetDatabaseDataImportDataSourceOutput

func (GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourcePtrOutput 

func (o GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourcePtrOutput() GetDatabaseDataImportDataSourcePtrOutput

func (GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourcePtrOutputWithContext 

func (o GetDatabaseDataImportDataSourceOutput) ToGetDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabaseDataImportDataSourcePtrOutput

type GetDatabaseDataImportDataSourcePtrInput 

type GetDatabaseDataImportDataSourcePtrInput interface {
	pulumi.Input

	ToGetDatabaseDataImportDataSourcePtrOutput() GetDatabaseDataImportDataSourcePtrOutput
	ToGetDatabaseDataImportDataSourcePtrOutputWithContext(context.Context) GetDatabaseDataImportDataSourcePtrOutput
}

GetDatabaseDataImportDataSourcePtrInput is an input type that accepts GetDatabaseDataImportDataSourceArgs, GetDatabaseDataImportDataSourcePtr and GetDatabaseDataImportDataSourcePtrOutput values. You can construct a concrete instance of `GetDatabaseDataImportDataSourcePtrInput` via: 

        GetDatabaseDataImportDataSourceArgs{...}

or:

        nil

func GetDatabaseDataImportDataSourcePtr 

func GetDatabaseDataImportDataSourcePtr(v *GetDatabaseDataImportDataSourceArgs) GetDatabaseDataImportDataSourcePtrInput

type GetDatabaseDataImportDataSourcePtrOutput 

type GetDatabaseDataImportDataSourcePtrOutput struct{ *pulumi.OutputState }

func (GetDatabaseDataImportDataSourcePtrOutput) Database 

func (o GetDatabaseDataImportDataSourcePtrOutput) Database() pulumi.StringPtrOutput

The name of the database imported from.

func (GetDatabaseDataImportDataSourcePtrOutput) Elem 

func (o GetDatabaseDataImportDataSourcePtrOutput) Elem() GetDatabaseDataImportDataSourceOutput

func (GetDatabaseDataImportDataSourcePtrOutput) ElementType 

func (GetDatabaseDataImportDataSourcePtrOutput) ElementType() reflect.Type

func (GetDatabaseDataImportDataSourcePtrOutput) Hostname 

func (o GetDatabaseDataImportDataSourcePtrOutput) Hostname() pulumi.StringPtrOutput

The hostname where the database lives.

func (GetDatabaseDataImportDataSourcePtrOutput) Port 

func (o GetDatabaseDataImportDataSourcePtrOutput) Port() pulumi.StringPtrOutput

The port on which the database listens on the host.

func (GetDatabaseDataImportDataSourcePtrOutput) ToGetDatabaseDataImportDataSourcePtrOutput 

func (o GetDatabaseDataImportDataSourcePtrOutput) ToGetDatabaseDataImportDataSourcePtrOutput() GetDatabaseDataImportDataSourcePtrOutput

func (GetDatabaseDataImportDataSourcePtrOutput) ToGetDatabaseDataImportDataSourcePtrOutputWithContext 

func (o GetDatabaseDataImportDataSourcePtrOutput) ToGetDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabaseDataImportDataSourcePtrOutput

type GetDatabaseDataImportInput 

type GetDatabaseDataImportInput interface {
	pulumi.Input

	ToGetDatabaseDataImportOutput() GetDatabaseDataImportOutput
	ToGetDatabaseDataImportOutputWithContext(context.Context) GetDatabaseDataImportOutput
}

GetDatabaseDataImportInput is an input type that accepts GetDatabaseDataImportArgs and GetDatabaseDataImportOutput values. You can construct a concrete instance of `GetDatabaseDataImportInput` via: 

GetDatabaseDataImportArgs{...}

type GetDatabaseDataImportOutput 

type GetDatabaseDataImportOutput struct{ *pulumi.OutputState }

func (GetDatabaseDataImportOutput) DataSource 

func (o GetDatabaseDataImportOutput) DataSource() GetDatabaseDataImportDataSourceOutput

Connection information for the source of the data for the import.

func (GetDatabaseDataImportOutput) ElementType 

func (GetDatabaseDataImportOutput) ElementType() reflect.Type

func (GetDatabaseDataImportOutput) FinishedAt 

func (o GetDatabaseDataImportOutput) FinishedAt() pulumi.StringOutput

When the import finished.

func (GetDatabaseDataImportOutput) ImportCheckErrors 

func (o GetDatabaseDataImportOutput) ImportCheckErrors() pulumi.StringOutput

Errors encountered while preparing the import.

func (GetDatabaseDataImportOutput) StartedAt 

func (o GetDatabaseDataImportOutput) StartedAt() pulumi.StringOutput

When the import started.

func (GetDatabaseDataImportOutput) State 

func (o GetDatabaseDataImportOutput) State() pulumi.StringOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (GetDatabaseDataImportOutput) ToGetDatabaseDataImportOutput 

func (o GetDatabaseDataImportOutput) ToGetDatabaseDataImportOutput() GetDatabaseDataImportOutput

func (GetDatabaseDataImportOutput) ToGetDatabaseDataImportOutputWithContext 

func (o GetDatabaseDataImportOutput) ToGetDatabaseDataImportOutputWithContext(ctx context.Context) GetDatabaseDataImportOutput

func (GetDatabaseDataImportOutput) ToGetDatabaseDataImportPtrOutput 

func (o GetDatabaseDataImportOutput) ToGetDatabaseDataImportPtrOutput() GetDatabaseDataImportPtrOutput

func (GetDatabaseDataImportOutput) ToGetDatabaseDataImportPtrOutputWithContext 

func (o GetDatabaseDataImportOutput) ToGetDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabaseDataImportPtrOutput

type GetDatabaseDataImportPtrInput 

type GetDatabaseDataImportPtrInput interface {
	pulumi.Input

	ToGetDatabaseDataImportPtrOutput() GetDatabaseDataImportPtrOutput
	ToGetDatabaseDataImportPtrOutputWithContext(context.Context) GetDatabaseDataImportPtrOutput
}

GetDatabaseDataImportPtrInput is an input type that accepts GetDatabaseDataImportArgs, GetDatabaseDataImportPtr and GetDatabaseDataImportPtrOutput values. You can construct a concrete instance of `GetDatabaseDataImportPtrInput` via: 

        GetDatabaseDataImportArgs{...}

or:

        nil

func GetDatabaseDataImportPtr 

func GetDatabaseDataImportPtr(v *GetDatabaseDataImportArgs) GetDatabaseDataImportPtrInput

type GetDatabaseDataImportPtrOutput 

type GetDatabaseDataImportPtrOutput struct{ *pulumi.OutputState }

func (GetDatabaseDataImportPtrOutput) DataSource 

func (o GetDatabaseDataImportPtrOutput) DataSource() GetDatabaseDataImportDataSourcePtrOutput

Connection information for the source of the data for the import.

func (GetDatabaseDataImportPtrOutput) Elem 

func (o GetDatabaseDataImportPtrOutput) Elem() GetDatabaseDataImportOutput

func (GetDatabaseDataImportPtrOutput) ElementType 

func (GetDatabaseDataImportPtrOutput) ElementType() reflect.Type

func (GetDatabaseDataImportPtrOutput) FinishedAt 

func (o GetDatabaseDataImportPtrOutput) FinishedAt() pulumi.StringPtrOutput

When the import finished.

func (GetDatabaseDataImportPtrOutput) ImportCheckErrors 

func (o GetDatabaseDataImportPtrOutput) ImportCheckErrors() pulumi.StringPtrOutput

Errors encountered while preparing the import.

func (GetDatabaseDataImportPtrOutput) StartedAt 

func (o GetDatabaseDataImportPtrOutput) StartedAt() pulumi.StringPtrOutput

When the import started.

func (GetDatabaseDataImportPtrOutput) State 

func (o GetDatabaseDataImportPtrOutput) State() pulumi.StringPtrOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (GetDatabaseDataImportPtrOutput) ToGetDatabaseDataImportPtrOutput 

func (o GetDatabaseDataImportPtrOutput) ToGetDatabaseDataImportPtrOutput() GetDatabaseDataImportPtrOutput

func (GetDatabaseDataImportPtrOutput) ToGetDatabaseDataImportPtrOutputWithContext 

func (o GetDatabaseDataImportPtrOutput) ToGetDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabaseDataImportPtrOutput

type GetDatabaseReadOnlyRegionsArgs 

type GetDatabaseReadOnlyRegionsArgs struct {
	// The name of the database for which the read-only regions are available.
	Name string `pulumi:"name"`
	// The organization for which the read-only regions are available.
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getDatabaseReadOnlyRegions.

type GetDatabaseReadOnlyRegionsOutputArgs 

type GetDatabaseReadOnlyRegionsOutputArgs struct {
	// The name of the database for which the read-only regions are available.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization for which the read-only regions are available.
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getDatabaseReadOnlyRegions.

func (GetDatabaseReadOnlyRegionsOutputArgs) ElementType 

func (GetDatabaseReadOnlyRegionsOutputArgs) ElementType() reflect.Type

type GetDatabaseReadOnlyRegionsRegion 

type GetDatabaseReadOnlyRegionsRegion struct {
	// The actor that created the read-only region.
	Actor GetDatabaseReadOnlyRegionsRegionActor `pulumi:"actor"`
	// When the read-only region was created.
	CreatedAt string `pulumi:"createdAt"`
	// The name of the read-only region.
	DisplayName string `pulumi:"displayName"`
	// The ID of the read-only region.
	Id string `pulumi:"id"`
	// Whether or not the read-only region is ready to serve queries.
	Ready bool `pulumi:"ready"`
	// When the read-only region was ready to serve queries.
	ReadyAt string `pulumi:"readyAt"`
	// The details of the read-only region.
	Region GetDatabaseReadOnlyRegionsRegionRegion `pulumi:"region"`
	// When the read-only region was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetDatabaseReadOnlyRegionsRegionActor 

type GetDatabaseReadOnlyRegionsRegionActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetDatabaseReadOnlyRegionsRegionActorArgs 

type GetDatabaseReadOnlyRegionsRegionActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetDatabaseReadOnlyRegionsRegionActorArgs) ElementType 

func (GetDatabaseReadOnlyRegionsRegionActorArgs) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionActorArgs) ToGetDatabaseReadOnlyRegionsRegionActorOutput 

func (i GetDatabaseReadOnlyRegionsRegionActorArgs) ToGetDatabaseReadOnlyRegionsRegionActorOutput() GetDatabaseReadOnlyRegionsRegionActorOutput

func (GetDatabaseReadOnlyRegionsRegionActorArgs) ToGetDatabaseReadOnlyRegionsRegionActorOutputWithContext 

func (i GetDatabaseReadOnlyRegionsRegionActorArgs) ToGetDatabaseReadOnlyRegionsRegionActorOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionActorOutput

type GetDatabaseReadOnlyRegionsRegionActorInput 

type GetDatabaseReadOnlyRegionsRegionActorInput interface {
	pulumi.Input

	ToGetDatabaseReadOnlyRegionsRegionActorOutput() GetDatabaseReadOnlyRegionsRegionActorOutput
	ToGetDatabaseReadOnlyRegionsRegionActorOutputWithContext(context.Context) GetDatabaseReadOnlyRegionsRegionActorOutput
}

GetDatabaseReadOnlyRegionsRegionActorInput is an input type that accepts GetDatabaseReadOnlyRegionsRegionActorArgs and GetDatabaseReadOnlyRegionsRegionActorOutput values. You can construct a concrete instance of `GetDatabaseReadOnlyRegionsRegionActorInput` via: 

GetDatabaseReadOnlyRegionsRegionActorArgs{...}

type GetDatabaseReadOnlyRegionsRegionActorOutput 

type GetDatabaseReadOnlyRegionsRegionActorOutput struct{ *pulumi.OutputState }

func (GetDatabaseReadOnlyRegionsRegionActorOutput) AvatarUrl 

func (o GetDatabaseReadOnlyRegionsRegionActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetDatabaseReadOnlyRegionsRegionActorOutput) DisplayName 

func (o GetDatabaseReadOnlyRegionsRegionActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetDatabaseReadOnlyRegionsRegionActorOutput) ElementType 

func (GetDatabaseReadOnlyRegionsRegionActorOutput) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionActorOutput) Id 

func (o GetDatabaseReadOnlyRegionsRegionActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetDatabaseReadOnlyRegionsRegionActorOutput) ToGetDatabaseReadOnlyRegionsRegionActorOutput 

func (o GetDatabaseReadOnlyRegionsRegionActorOutput) ToGetDatabaseReadOnlyRegionsRegionActorOutput() GetDatabaseReadOnlyRegionsRegionActorOutput

func (GetDatabaseReadOnlyRegionsRegionActorOutput) ToGetDatabaseReadOnlyRegionsRegionActorOutputWithContext 

func (o GetDatabaseReadOnlyRegionsRegionActorOutput) ToGetDatabaseReadOnlyRegionsRegionActorOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionActorOutput

type GetDatabaseReadOnlyRegionsRegionArgs 

type GetDatabaseReadOnlyRegionsRegionArgs struct {
	// The actor that created the read-only region.
	Actor GetDatabaseReadOnlyRegionsRegionActorInput `pulumi:"actor"`
	// When the read-only region was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The name of the read-only region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the read-only region.
	Id pulumi.StringInput `pulumi:"id"`
	// Whether or not the read-only region is ready to serve queries.
	Ready pulumi.BoolInput `pulumi:"ready"`
	// When the read-only region was ready to serve queries.
	ReadyAt pulumi.StringInput `pulumi:"readyAt"`
	// The details of the read-only region.
	Region GetDatabaseReadOnlyRegionsRegionRegionInput `pulumi:"region"`
	// When the read-only region was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetDatabaseReadOnlyRegionsRegionArgs) ElementType 

func (GetDatabaseReadOnlyRegionsRegionArgs) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionArgs) ToGetDatabaseReadOnlyRegionsRegionOutput 

func (i GetDatabaseReadOnlyRegionsRegionArgs) ToGetDatabaseReadOnlyRegionsRegionOutput() GetDatabaseReadOnlyRegionsRegionOutput

func (GetDatabaseReadOnlyRegionsRegionArgs) ToGetDatabaseReadOnlyRegionsRegionOutputWithContext 

func (i GetDatabaseReadOnlyRegionsRegionArgs) ToGetDatabaseReadOnlyRegionsRegionOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionOutput

type GetDatabaseReadOnlyRegionsRegionArray 

type GetDatabaseReadOnlyRegionsRegionArray []GetDatabaseReadOnlyRegionsRegionInput

func (GetDatabaseReadOnlyRegionsRegionArray) ElementType 

func (GetDatabaseReadOnlyRegionsRegionArray) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionArray) ToGetDatabaseReadOnlyRegionsRegionArrayOutput 

func (i GetDatabaseReadOnlyRegionsRegionArray) ToGetDatabaseReadOnlyRegionsRegionArrayOutput() GetDatabaseReadOnlyRegionsRegionArrayOutput

func (GetDatabaseReadOnlyRegionsRegionArray) ToGetDatabaseReadOnlyRegionsRegionArrayOutputWithContext 

func (i GetDatabaseReadOnlyRegionsRegionArray) ToGetDatabaseReadOnlyRegionsRegionArrayOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionArrayOutput

type GetDatabaseReadOnlyRegionsRegionArrayInput 

type GetDatabaseReadOnlyRegionsRegionArrayInput interface {
	pulumi.Input

	ToGetDatabaseReadOnlyRegionsRegionArrayOutput() GetDatabaseReadOnlyRegionsRegionArrayOutput
	ToGetDatabaseReadOnlyRegionsRegionArrayOutputWithContext(context.Context) GetDatabaseReadOnlyRegionsRegionArrayOutput
}

GetDatabaseReadOnlyRegionsRegionArrayInput is an input type that accepts GetDatabaseReadOnlyRegionsRegionArray and GetDatabaseReadOnlyRegionsRegionArrayOutput values. You can construct a concrete instance of `GetDatabaseReadOnlyRegionsRegionArrayInput` via: 

GetDatabaseReadOnlyRegionsRegionArray{ GetDatabaseReadOnlyRegionsRegionArgs{...} }

type GetDatabaseReadOnlyRegionsRegionArrayOutput 

type GetDatabaseReadOnlyRegionsRegionArrayOutput struct{ *pulumi.OutputState }

func (GetDatabaseReadOnlyRegionsRegionArrayOutput) ElementType 

func (GetDatabaseReadOnlyRegionsRegionArrayOutput) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionArrayOutput) Index 

func (o GetDatabaseReadOnlyRegionsRegionArrayOutput) Index(i pulumi.IntInput) GetDatabaseReadOnlyRegionsRegionOutput

func (GetDatabaseReadOnlyRegionsRegionArrayOutput) ToGetDatabaseReadOnlyRegionsRegionArrayOutput 

func (o GetDatabaseReadOnlyRegionsRegionArrayOutput) ToGetDatabaseReadOnlyRegionsRegionArrayOutput() GetDatabaseReadOnlyRegionsRegionArrayOutput

func (GetDatabaseReadOnlyRegionsRegionArrayOutput) ToGetDatabaseReadOnlyRegionsRegionArrayOutputWithContext 

func (o GetDatabaseReadOnlyRegionsRegionArrayOutput) ToGetDatabaseReadOnlyRegionsRegionArrayOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionArrayOutput

type GetDatabaseReadOnlyRegionsRegionInput 

type GetDatabaseReadOnlyRegionsRegionInput interface {
	pulumi.Input

	ToGetDatabaseReadOnlyRegionsRegionOutput() GetDatabaseReadOnlyRegionsRegionOutput
	ToGetDatabaseReadOnlyRegionsRegionOutputWithContext(context.Context) GetDatabaseReadOnlyRegionsRegionOutput
}

GetDatabaseReadOnlyRegionsRegionInput is an input type that accepts GetDatabaseReadOnlyRegionsRegionArgs and GetDatabaseReadOnlyRegionsRegionOutput values. You can construct a concrete instance of `GetDatabaseReadOnlyRegionsRegionInput` via: 

GetDatabaseReadOnlyRegionsRegionArgs{...}

type GetDatabaseReadOnlyRegionsRegionOutput 

type GetDatabaseReadOnlyRegionsRegionOutput struct{ *pulumi.OutputState }

func (GetDatabaseReadOnlyRegionsRegionOutput) Actor 

func (o GetDatabaseReadOnlyRegionsRegionOutput) Actor() GetDatabaseReadOnlyRegionsRegionActorOutput

The actor that created the read-only region.

func (GetDatabaseReadOnlyRegionsRegionOutput) CreatedAt 

func (o GetDatabaseReadOnlyRegionsRegionOutput) CreatedAt() pulumi.StringOutput

When the read-only region was created.

func (GetDatabaseReadOnlyRegionsRegionOutput) DisplayName 

func (o GetDatabaseReadOnlyRegionsRegionOutput) DisplayName() pulumi.StringOutput

The name of the read-only region.

func (GetDatabaseReadOnlyRegionsRegionOutput) ElementType 

func (GetDatabaseReadOnlyRegionsRegionOutput) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionOutput) Id 

func (o GetDatabaseReadOnlyRegionsRegionOutput) Id() pulumi.StringOutput

The ID of the read-only region.

func (GetDatabaseReadOnlyRegionsRegionOutput) Ready 

func (o GetDatabaseReadOnlyRegionsRegionOutput) Ready() pulumi.BoolOutput

Whether or not the read-only region is ready to serve queries.

func (GetDatabaseReadOnlyRegionsRegionOutput) ReadyAt 

func (o GetDatabaseReadOnlyRegionsRegionOutput) ReadyAt() pulumi.StringOutput

When the read-only region was ready to serve queries.

func (GetDatabaseReadOnlyRegionsRegionOutput) Region 

func (o GetDatabaseReadOnlyRegionsRegionOutput) Region() GetDatabaseReadOnlyRegionsRegionRegionOutput

The details of the read-only region.

func (GetDatabaseReadOnlyRegionsRegionOutput) ToGetDatabaseReadOnlyRegionsRegionOutput 

func (o GetDatabaseReadOnlyRegionsRegionOutput) ToGetDatabaseReadOnlyRegionsRegionOutput() GetDatabaseReadOnlyRegionsRegionOutput

func (GetDatabaseReadOnlyRegionsRegionOutput) ToGetDatabaseReadOnlyRegionsRegionOutputWithContext 

func (o GetDatabaseReadOnlyRegionsRegionOutput) ToGetDatabaseReadOnlyRegionsRegionOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionOutput

func (GetDatabaseReadOnlyRegionsRegionOutput) UpdatedAt 

func (o GetDatabaseReadOnlyRegionsRegionOutput) UpdatedAt() pulumi.StringOutput

When the read-only region was last updated.

type GetDatabaseReadOnlyRegionsRegionRegion 

type GetDatabaseReadOnlyRegionsRegionRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetDatabaseReadOnlyRegionsRegionRegionArgs 

type GetDatabaseReadOnlyRegionsRegionRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetDatabaseReadOnlyRegionsRegionRegionArgs) ElementType 

func (GetDatabaseReadOnlyRegionsRegionRegionArgs) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionRegionArgs) ToGetDatabaseReadOnlyRegionsRegionRegionOutput 

func (i GetDatabaseReadOnlyRegionsRegionRegionArgs) ToGetDatabaseReadOnlyRegionsRegionRegionOutput() GetDatabaseReadOnlyRegionsRegionRegionOutput

func (GetDatabaseReadOnlyRegionsRegionRegionArgs) ToGetDatabaseReadOnlyRegionsRegionRegionOutputWithContext 

func (i GetDatabaseReadOnlyRegionsRegionRegionArgs) ToGetDatabaseReadOnlyRegionsRegionRegionOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionRegionOutput

type GetDatabaseReadOnlyRegionsRegionRegionInput 

type GetDatabaseReadOnlyRegionsRegionRegionInput interface {
	pulumi.Input

	ToGetDatabaseReadOnlyRegionsRegionRegionOutput() GetDatabaseReadOnlyRegionsRegionRegionOutput
	ToGetDatabaseReadOnlyRegionsRegionRegionOutputWithContext(context.Context) GetDatabaseReadOnlyRegionsRegionRegionOutput
}

GetDatabaseReadOnlyRegionsRegionRegionInput is an input type that accepts GetDatabaseReadOnlyRegionsRegionRegionArgs and GetDatabaseReadOnlyRegionsRegionRegionOutput values. You can construct a concrete instance of `GetDatabaseReadOnlyRegionsRegionRegionInput` via: 

GetDatabaseReadOnlyRegionsRegionRegionArgs{...}

type GetDatabaseReadOnlyRegionsRegionRegionOutput 

type GetDatabaseReadOnlyRegionsRegionRegionOutput struct{ *pulumi.OutputState }

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) DisplayName 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) ElementType 

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) Enabled 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) Id 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) Location 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) Provider 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) PublicIpAddresses 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) Slug 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) ToGetDatabaseReadOnlyRegionsRegionRegionOutput 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) ToGetDatabaseReadOnlyRegionsRegionRegionOutput() GetDatabaseReadOnlyRegionsRegionRegionOutput

func (GetDatabaseReadOnlyRegionsRegionRegionOutput) ToGetDatabaseReadOnlyRegionsRegionRegionOutputWithContext 

func (o GetDatabaseReadOnlyRegionsRegionRegionOutput) ToGetDatabaseReadOnlyRegionsRegionRegionOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsRegionRegionOutput

type GetDatabaseReadOnlyRegionsResult 

type GetDatabaseReadOnlyRegionsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The name of the database for which the read-only regions are available.
	Name string `pulumi:"name"`
	// The organization for which the read-only regions are available.
	Organization string `pulumi:"organization"`
	// The list of read-only regions available for the database.
	Regions []GetDatabaseReadOnlyRegionsRegion `pulumi:"regions"`
}

A collection of values returned by getDatabaseReadOnlyRegions.

func GetDatabaseReadOnlyRegions 

func GetDatabaseReadOnlyRegions(ctx *pulumi.Context, args *GetDatabaseReadOnlyRegionsArgs, opts ...pulumi.InvokeOption) (*GetDatabaseReadOnlyRegionsResult, error)

A list of PlanetScale read-only regions.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.GetDatabaseReadOnlyRegions(ctx, &planetscale.GetDatabaseReadOnlyRegionsArgs{
			Organization: "example.com",
			Name:         "example_db",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("databaseRoRegions", data.Planetscale_database_regions.Example)
		return nil
	})
}

```

type GetDatabaseReadOnlyRegionsResultOutput 

type GetDatabaseReadOnlyRegionsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabaseReadOnlyRegions.

func GetDatabaseReadOnlyRegionsOutput 

func GetDatabaseReadOnlyRegionsOutput(ctx *pulumi.Context, args GetDatabaseReadOnlyRegionsOutputArgs, opts ...pulumi.InvokeOption) GetDatabaseReadOnlyRegionsResultOutput

func (GetDatabaseReadOnlyRegionsResultOutput) ElementType 

func (GetDatabaseReadOnlyRegionsResultOutput) ElementType() reflect.Type

func (GetDatabaseReadOnlyRegionsResultOutput) Id 

func (o GetDatabaseReadOnlyRegionsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetDatabaseReadOnlyRegionsResultOutput) Name 

func (o GetDatabaseReadOnlyRegionsResultOutput) Name() pulumi.StringOutput

The name of the database for which the read-only regions are available.

func (GetDatabaseReadOnlyRegionsResultOutput) Organization 

func (o GetDatabaseReadOnlyRegionsResultOutput) Organization() pulumi.StringOutput

The organization for which the read-only regions are available.

func (GetDatabaseReadOnlyRegionsResultOutput) Regions 

func (o GetDatabaseReadOnlyRegionsResultOutput) Regions() GetDatabaseReadOnlyRegionsRegionArrayOutput

The list of read-only regions available for the database.

func (GetDatabaseReadOnlyRegionsResultOutput) ToGetDatabaseReadOnlyRegionsResultOutput 

func (o GetDatabaseReadOnlyRegionsResultOutput) ToGetDatabaseReadOnlyRegionsResultOutput() GetDatabaseReadOnlyRegionsResultOutput

func (GetDatabaseReadOnlyRegionsResultOutput) ToGetDatabaseReadOnlyRegionsResultOutputWithContext 

func (o GetDatabaseReadOnlyRegionsResultOutput) ToGetDatabaseReadOnlyRegionsResultOutputWithContext(ctx context.Context) GetDatabaseReadOnlyRegionsResultOutput

type GetDatabaseRegion 

type GetDatabaseRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetDatabaseRegionArgs 

type GetDatabaseRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetDatabaseRegionArgs) ElementType 

func (GetDatabaseRegionArgs) ElementType() reflect.Type

func (GetDatabaseRegionArgs) ToGetDatabaseRegionOutput 

func (i GetDatabaseRegionArgs) ToGetDatabaseRegionOutput() GetDatabaseRegionOutput

func (GetDatabaseRegionArgs) ToGetDatabaseRegionOutputWithContext 

func (i GetDatabaseRegionArgs) ToGetDatabaseRegionOutputWithContext(ctx context.Context) GetDatabaseRegionOutput

func (GetDatabaseRegionArgs) ToGetDatabaseRegionPtrOutput 

func (i GetDatabaseRegionArgs) ToGetDatabaseRegionPtrOutput() GetDatabaseRegionPtrOutput

func (GetDatabaseRegionArgs) ToGetDatabaseRegionPtrOutputWithContext 

func (i GetDatabaseRegionArgs) ToGetDatabaseRegionPtrOutputWithContext(ctx context.Context) GetDatabaseRegionPtrOutput

type GetDatabaseRegionInput 

type GetDatabaseRegionInput interface {
	pulumi.Input

	ToGetDatabaseRegionOutput() GetDatabaseRegionOutput
	ToGetDatabaseRegionOutputWithContext(context.Context) GetDatabaseRegionOutput
}

GetDatabaseRegionInput is an input type that accepts GetDatabaseRegionArgs and GetDatabaseRegionOutput values. You can construct a concrete instance of `GetDatabaseRegionInput` via: 

GetDatabaseRegionArgs{...}

type GetDatabaseRegionOutput 

type GetDatabaseRegionOutput struct{ *pulumi.OutputState }

func (GetDatabaseRegionOutput) DisplayName 

func (o GetDatabaseRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetDatabaseRegionOutput) ElementType 

func (GetDatabaseRegionOutput) ElementType() reflect.Type

func (GetDatabaseRegionOutput) Enabled 

func (o GetDatabaseRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetDatabaseRegionOutput) Id 

func (o GetDatabaseRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetDatabaseRegionOutput) Location 

func (o GetDatabaseRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetDatabaseRegionOutput) Provider 

func (o GetDatabaseRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetDatabaseRegionOutput) PublicIpAddresses 

func (o GetDatabaseRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetDatabaseRegionOutput) Slug 

func (o GetDatabaseRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetDatabaseRegionOutput) ToGetDatabaseRegionOutput 

func (o GetDatabaseRegionOutput) ToGetDatabaseRegionOutput() GetDatabaseRegionOutput

func (GetDatabaseRegionOutput) ToGetDatabaseRegionOutputWithContext 

func (o GetDatabaseRegionOutput) ToGetDatabaseRegionOutputWithContext(ctx context.Context) GetDatabaseRegionOutput

func (GetDatabaseRegionOutput) ToGetDatabaseRegionPtrOutput 

func (o GetDatabaseRegionOutput) ToGetDatabaseRegionPtrOutput() GetDatabaseRegionPtrOutput

func (GetDatabaseRegionOutput) ToGetDatabaseRegionPtrOutputWithContext 

func (o GetDatabaseRegionOutput) ToGetDatabaseRegionPtrOutputWithContext(ctx context.Context) GetDatabaseRegionPtrOutput

type GetDatabaseRegionPtrInput 

type GetDatabaseRegionPtrInput interface {
	pulumi.Input

	ToGetDatabaseRegionPtrOutput() GetDatabaseRegionPtrOutput
	ToGetDatabaseRegionPtrOutputWithContext(context.Context) GetDatabaseRegionPtrOutput
}

GetDatabaseRegionPtrInput is an input type that accepts GetDatabaseRegionArgs, GetDatabaseRegionPtr and GetDatabaseRegionPtrOutput values. You can construct a concrete instance of `GetDatabaseRegionPtrInput` via: 

        GetDatabaseRegionArgs{...}

or:

        nil

func GetDatabaseRegionPtr 

func GetDatabaseRegionPtr(v *GetDatabaseRegionArgs) GetDatabaseRegionPtrInput

type GetDatabaseRegionPtrOutput 

type GetDatabaseRegionPtrOutput struct{ *pulumi.OutputState }

func (GetDatabaseRegionPtrOutput) DisplayName 

func (o GetDatabaseRegionPtrOutput) DisplayName() pulumi.StringPtrOutput

Name of the region.

func (GetDatabaseRegionPtrOutput) Elem 

func (o GetDatabaseRegionPtrOutput) Elem() GetDatabaseRegionOutput

func (GetDatabaseRegionPtrOutput) ElementType 

func (GetDatabaseRegionPtrOutput) ElementType() reflect.Type

func (GetDatabaseRegionPtrOutput) Enabled 

func (o GetDatabaseRegionPtrOutput) Enabled() pulumi.BoolPtrOutput

Whether or not the region is currently active.

func (GetDatabaseRegionPtrOutput) Id 

func (o GetDatabaseRegionPtrOutput) Id() pulumi.StringPtrOutput

The ID of the region.

func (GetDatabaseRegionPtrOutput) Location 

func (o GetDatabaseRegionPtrOutput) Location() pulumi.StringPtrOutput

Location of the region.

func (GetDatabaseRegionPtrOutput) Provider 

func (o GetDatabaseRegionPtrOutput) Provider() pulumi.StringPtrOutput

Provider for the region (ex. AWS).

func (GetDatabaseRegionPtrOutput) PublicIpAddresses 

func (o GetDatabaseRegionPtrOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetDatabaseRegionPtrOutput) Slug 

func (o GetDatabaseRegionPtrOutput) Slug() pulumi.StringPtrOutput

The slug of the region.

func (GetDatabaseRegionPtrOutput) ToGetDatabaseRegionPtrOutput 

func (o GetDatabaseRegionPtrOutput) ToGetDatabaseRegionPtrOutput() GetDatabaseRegionPtrOutput

func (GetDatabaseRegionPtrOutput) ToGetDatabaseRegionPtrOutputWithContext 

func (o GetDatabaseRegionPtrOutput) ToGetDatabaseRegionPtrOutputWithContext(ctx context.Context) GetDatabaseRegionPtrOutput

type GetDatabaseRegionsArgs 

type GetDatabaseRegionsArgs struct {
	// The database for which the regions are available.
	Name string `pulumi:"name"`
	// The organization for which the regions are available.
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getDatabaseRegions.

type GetDatabaseRegionsOutputArgs 

type GetDatabaseRegionsOutputArgs struct {
	// The database for which the regions are available.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization for which the regions are available.
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getDatabaseRegions.

func (GetDatabaseRegionsOutputArgs) ElementType 

func (GetDatabaseRegionsOutputArgs) ElementType() reflect.Type

type GetDatabaseRegionsRegion 

type GetDatabaseRegionsRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetDatabaseRegionsRegionArgs 

type GetDatabaseRegionsRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetDatabaseRegionsRegionArgs) ElementType 

func (GetDatabaseRegionsRegionArgs) ElementType() reflect.Type

func (GetDatabaseRegionsRegionArgs) ToGetDatabaseRegionsRegionOutput 

func (i GetDatabaseRegionsRegionArgs) ToGetDatabaseRegionsRegionOutput() GetDatabaseRegionsRegionOutput

func (GetDatabaseRegionsRegionArgs) ToGetDatabaseRegionsRegionOutputWithContext 

func (i GetDatabaseRegionsRegionArgs) ToGetDatabaseRegionsRegionOutputWithContext(ctx context.Context) GetDatabaseRegionsRegionOutput

type GetDatabaseRegionsRegionArray 

type GetDatabaseRegionsRegionArray []GetDatabaseRegionsRegionInput

func (GetDatabaseRegionsRegionArray) ElementType 

func (GetDatabaseRegionsRegionArray) ElementType() reflect.Type

func (GetDatabaseRegionsRegionArray) ToGetDatabaseRegionsRegionArrayOutput 

func (i GetDatabaseRegionsRegionArray) ToGetDatabaseRegionsRegionArrayOutput() GetDatabaseRegionsRegionArrayOutput

func (GetDatabaseRegionsRegionArray) ToGetDatabaseRegionsRegionArrayOutputWithContext 

func (i GetDatabaseRegionsRegionArray) ToGetDatabaseRegionsRegionArrayOutputWithContext(ctx context.Context) GetDatabaseRegionsRegionArrayOutput

type GetDatabaseRegionsRegionArrayInput 

type GetDatabaseRegionsRegionArrayInput interface {
	pulumi.Input

	ToGetDatabaseRegionsRegionArrayOutput() GetDatabaseRegionsRegionArrayOutput
	ToGetDatabaseRegionsRegionArrayOutputWithContext(context.Context) GetDatabaseRegionsRegionArrayOutput
}

GetDatabaseRegionsRegionArrayInput is an input type that accepts GetDatabaseRegionsRegionArray and GetDatabaseRegionsRegionArrayOutput values. You can construct a concrete instance of `GetDatabaseRegionsRegionArrayInput` via: 

GetDatabaseRegionsRegionArray{ GetDatabaseRegionsRegionArgs{...} }

type GetDatabaseRegionsRegionArrayOutput 

type GetDatabaseRegionsRegionArrayOutput struct{ *pulumi.OutputState }

func (GetDatabaseRegionsRegionArrayOutput) ElementType 

func (GetDatabaseRegionsRegionArrayOutput) ElementType() reflect.Type

func (GetDatabaseRegionsRegionArrayOutput) Index 

func (o GetDatabaseRegionsRegionArrayOutput) Index(i pulumi.IntInput) GetDatabaseRegionsRegionOutput

func (GetDatabaseRegionsRegionArrayOutput) ToGetDatabaseRegionsRegionArrayOutput 

func (o GetDatabaseRegionsRegionArrayOutput) ToGetDatabaseRegionsRegionArrayOutput() GetDatabaseRegionsRegionArrayOutput

func (GetDatabaseRegionsRegionArrayOutput) ToGetDatabaseRegionsRegionArrayOutputWithContext 

func (o GetDatabaseRegionsRegionArrayOutput) ToGetDatabaseRegionsRegionArrayOutputWithContext(ctx context.Context) GetDatabaseRegionsRegionArrayOutput

type GetDatabaseRegionsRegionInput 

type GetDatabaseRegionsRegionInput interface {
	pulumi.Input

	ToGetDatabaseRegionsRegionOutput() GetDatabaseRegionsRegionOutput
	ToGetDatabaseRegionsRegionOutputWithContext(context.Context) GetDatabaseRegionsRegionOutput
}

GetDatabaseRegionsRegionInput is an input type that accepts GetDatabaseRegionsRegionArgs and GetDatabaseRegionsRegionOutput values. You can construct a concrete instance of `GetDatabaseRegionsRegionInput` via: 

GetDatabaseRegionsRegionArgs{...}

type GetDatabaseRegionsRegionOutput 

type GetDatabaseRegionsRegionOutput struct{ *pulumi.OutputState }

func (GetDatabaseRegionsRegionOutput) DisplayName 

func (o GetDatabaseRegionsRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetDatabaseRegionsRegionOutput) ElementType 

func (GetDatabaseRegionsRegionOutput) ElementType() reflect.Type

func (GetDatabaseRegionsRegionOutput) Enabled 

func (o GetDatabaseRegionsRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetDatabaseRegionsRegionOutput) Id 

func (o GetDatabaseRegionsRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetDatabaseRegionsRegionOutput) Location 

func (o GetDatabaseRegionsRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetDatabaseRegionsRegionOutput) Provider 

func (o GetDatabaseRegionsRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetDatabaseRegionsRegionOutput) PublicIpAddresses 

func (o GetDatabaseRegionsRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetDatabaseRegionsRegionOutput) Slug 

func (o GetDatabaseRegionsRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetDatabaseRegionsRegionOutput) ToGetDatabaseRegionsRegionOutput 

func (o GetDatabaseRegionsRegionOutput) ToGetDatabaseRegionsRegionOutput() GetDatabaseRegionsRegionOutput

func (GetDatabaseRegionsRegionOutput) ToGetDatabaseRegionsRegionOutputWithContext 

func (o GetDatabaseRegionsRegionOutput) ToGetDatabaseRegionsRegionOutputWithContext(ctx context.Context) GetDatabaseRegionsRegionOutput

type GetDatabaseRegionsResult 

type GetDatabaseRegionsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The database for which the regions are available.
	Name string `pulumi:"name"`
	// The organization for which the regions are available.
	Organization string `pulumi:"organization"`
	// The list of regions available for the database.
	Regions []GetDatabaseRegionsRegion `pulumi:"regions"`
}

A collection of values returned by getDatabaseRegions.

func GetDatabaseRegions 

func GetDatabaseRegions(ctx *pulumi.Context, args *GetDatabaseRegionsArgs, opts ...pulumi.InvokeOption) (*GetDatabaseRegionsResult, error)

A list of PlanetScale regions.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetDatabaseRegions(ctx, &planetscale.GetDatabaseRegionsArgs{
			Organization: "example.com",
			Name:         "example_db",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("databaseRegions", example)
		return nil
	})
}

```

type GetDatabaseRegionsResultOutput 

type GetDatabaseRegionsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabaseRegions.

func GetDatabaseRegionsOutput 

func GetDatabaseRegionsOutput(ctx *pulumi.Context, args GetDatabaseRegionsOutputArgs, opts ...pulumi.InvokeOption) GetDatabaseRegionsResultOutput

func (GetDatabaseRegionsResultOutput) ElementType 

func (GetDatabaseRegionsResultOutput) ElementType() reflect.Type

func (GetDatabaseRegionsResultOutput) Id 

func (o GetDatabaseRegionsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetDatabaseRegionsResultOutput) Name 

func (o GetDatabaseRegionsResultOutput) Name() pulumi.StringOutput

The database for which the regions are available.

func (GetDatabaseRegionsResultOutput) Organization 

func (o GetDatabaseRegionsResultOutput) Organization() pulumi.StringOutput

The organization for which the regions are available.

func (GetDatabaseRegionsResultOutput) Regions 

func (o GetDatabaseRegionsResultOutput) Regions() GetDatabaseRegionsRegionArrayOutput

The list of regions available for the database.

func (GetDatabaseRegionsResultOutput) ToGetDatabaseRegionsResultOutput 

func (o GetDatabaseRegionsResultOutput) ToGetDatabaseRegionsResultOutput() GetDatabaseRegionsResultOutput

func (GetDatabaseRegionsResultOutput) ToGetDatabaseRegionsResultOutputWithContext 

func (o GetDatabaseRegionsResultOutput) ToGetDatabaseRegionsResultOutputWithContext(ctx context.Context) GetDatabaseRegionsResultOutput

type GetDatabasesArgs 

type GetDatabasesArgs struct {
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getDatabases.

type GetDatabasesDatabase 

type GetDatabasesDatabase struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching bool `pulumi:"allowDataBranching"`
	// If the database has reached its backup restored branch limit.
	AtBackupRestoreBranchesLimit bool `pulumi:"atBackupRestoreBranchesLimit"`
	// If the database has reached its development branch limit.
	AtDevelopmentBranchLimit bool `pulumi:"atDevelopmentBranchLimit"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations bool `pulumi:"automaticMigrations"`
	// The total number of database branches.
	BranchesCount float64 `pulumi:"branchesCount"`
	// The URL to retrieve this database's branches via the API.
	BranchesUrl string `pulumi:"branchesUrl"`
	// When the database was created.
	CreatedAt string `pulumi:"createdAt"`
	// If the database was created from an import, describes the import process.
	DataImport *GetDatabasesDatabaseDataImport `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch string `pulumi:"defaultBranch"`
	// Number of read only regions in the default branch.
	DefaultBranchReadOnlyRegionsCount float64 `pulumi:"defaultBranchReadOnlyRegionsCount"`
	// Number of shards in the default branch.
	DefaultBranchShardCount float64 `pulumi:"defaultBranchShardCount"`
	// Number of tables in the default branch schema.
	DefaultBranchTableCount float64 `pulumi:"defaultBranchTableCount"`
	// The total number of database development branches.
	DevelopmentBranchesCount float64 `pulumi:"developmentBranchesCount"`
	// The total number of database development branches.
	HtmlUrl string `pulumi:"htmlUrl"`
	// The ID of the database.
	Id string `pulumi:"id"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries bool `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount float64 `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework string `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName string `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion bool `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name string `pulumi:"name"`
	// The organization this database belongs to.
	Organization string `pulumi:"organization"`
	// The database plan.
	Plan string `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole bool `pulumi:"productionBranchWebConsole"`
	// The total number of database production branches.
	ProductionBranchesCount float64 `pulumi:"productionBranchesCount"`
	// If the database is ready to be used.
	Ready bool `pulumi:"ready"`
	// The region the database lives in.
	Region GetDatabasesDatabaseRegion `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy bool `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion bool `pulumi:"restrictBranchRegion"`
	// When the default branch schema was last changed.
	SchemaLastUpdatedAt string `pulumi:"schemaLastUpdatedAt"`
	// If the database is sharded.
	Sharded bool `pulumi:"sharded"`
	// State of the database.
	State string `pulumi:"state"`
	// When the database was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
	// The URL to the database API endpoint.
	Url string `pulumi:"url"`
}

type GetDatabasesDatabaseArgs 

type GetDatabasesDatabaseArgs struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching pulumi.BoolInput `pulumi:"allowDataBranching"`
	// If the database has reached its backup restored branch limit.
	AtBackupRestoreBranchesLimit pulumi.BoolInput `pulumi:"atBackupRestoreBranchesLimit"`
	// If the database has reached its development branch limit.
	AtDevelopmentBranchLimit pulumi.BoolInput `pulumi:"atDevelopmentBranchLimit"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations pulumi.BoolInput `pulumi:"automaticMigrations"`
	// The total number of database branches.
	BranchesCount pulumi.Float64Input `pulumi:"branchesCount"`
	// The URL to retrieve this database's branches via the API.
	BranchesUrl pulumi.StringInput `pulumi:"branchesUrl"`
	// When the database was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// If the database was created from an import, describes the import process.
	DataImport GetDatabasesDatabaseDataImportPtrInput `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch pulumi.StringInput `pulumi:"defaultBranch"`
	// Number of read only regions in the default branch.
	DefaultBranchReadOnlyRegionsCount pulumi.Float64Input `pulumi:"defaultBranchReadOnlyRegionsCount"`
	// Number of shards in the default branch.
	DefaultBranchShardCount pulumi.Float64Input `pulumi:"defaultBranchShardCount"`
	// Number of tables in the default branch schema.
	DefaultBranchTableCount pulumi.Float64Input `pulumi:"defaultBranchTableCount"`
	// The total number of database development branches.
	DevelopmentBranchesCount pulumi.Float64Input `pulumi:"developmentBranchesCount"`
	// The total number of database development branches.
	HtmlUrl pulumi.StringInput `pulumi:"htmlUrl"`
	// The ID of the database.
	Id pulumi.StringInput `pulumi:"id"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries pulumi.BoolInput `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount pulumi.Float64Input `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework pulumi.StringInput `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName pulumi.StringInput `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion pulumi.BoolInput `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this database belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// The database plan.
	Plan pulumi.StringInput `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole pulumi.BoolInput `pulumi:"productionBranchWebConsole"`
	// The total number of database production branches.
	ProductionBranchesCount pulumi.Float64Input `pulumi:"productionBranchesCount"`
	// If the database is ready to be used.
	Ready pulumi.BoolInput `pulumi:"ready"`
	// The region the database lives in.
	Region GetDatabasesDatabaseRegionInput `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy pulumi.BoolInput `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion pulumi.BoolInput `pulumi:"restrictBranchRegion"`
	// When the default branch schema was last changed.
	SchemaLastUpdatedAt pulumi.StringInput `pulumi:"schemaLastUpdatedAt"`
	// If the database is sharded.
	Sharded pulumi.BoolInput `pulumi:"sharded"`
	// State of the database.
	State pulumi.StringInput `pulumi:"state"`
	// When the database was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
	// The URL to the database API endpoint.
	Url pulumi.StringInput `pulumi:"url"`
}

func (GetDatabasesDatabaseArgs) ElementType 

func (GetDatabasesDatabaseArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutput 

func (i GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutputWithContext 

func (i GetDatabasesDatabaseArgs) ToGetDatabasesDatabaseOutputWithContext(ctx context.Context) GetDatabasesDatabaseOutput

type GetDatabasesDatabaseArray 

type GetDatabasesDatabaseArray []GetDatabasesDatabaseInput

func (GetDatabasesDatabaseArray) ElementType 

func (GetDatabasesDatabaseArray) ElementType() reflect.Type

func (GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutput 

func (i GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput

func (GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutputWithContext 

func (i GetDatabasesDatabaseArray) ToGetDatabasesDatabaseArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseArrayOutput

type GetDatabasesDatabaseArrayInput 

type GetDatabasesDatabaseArrayInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput
	ToGetDatabasesDatabaseArrayOutputWithContext(context.Context) GetDatabasesDatabaseArrayOutput
}

GetDatabasesDatabaseArrayInput is an input type that accepts GetDatabasesDatabaseArray and GetDatabasesDatabaseArrayOutput values. You can construct a concrete instance of `GetDatabasesDatabaseArrayInput` via: 

GetDatabasesDatabaseArray{ GetDatabasesDatabaseArgs{...} }

type GetDatabasesDatabaseArrayOutput 

type GetDatabasesDatabaseArrayOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseArrayOutput) ElementType 

func (GetDatabasesDatabaseArrayOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseArrayOutput) Index 

func (o GetDatabasesDatabaseArrayOutput) Index(i pulumi.IntInput) GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutput 

func (o GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutput() GetDatabasesDatabaseArrayOutput

func (GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutputWithContext 

func (o GetDatabasesDatabaseArrayOutput) ToGetDatabasesDatabaseArrayOutputWithContext(ctx context.Context) GetDatabasesDatabaseArrayOutput

type GetDatabasesDatabaseDataImport 

type GetDatabasesDatabaseDataImport struct {
	// Connection information for the source of the data for the import.
	DataSource GetDatabasesDatabaseDataImportDataSource `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt string `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors string `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt string `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State string `pulumi:"state"`
}

type GetDatabasesDatabaseDataImportArgs 

type GetDatabasesDatabaseDataImportArgs struct {
	// Connection information for the source of the data for the import.
	DataSource GetDatabasesDatabaseDataImportDataSourceInput `pulumi:"dataSource"`
	// When the import finished.
	FinishedAt pulumi.StringInput `pulumi:"finishedAt"`
	// Errors encountered while preparing the import.
	ImportCheckErrors pulumi.StringInput `pulumi:"importCheckErrors"`
	// When the import started.
	StartedAt pulumi.StringInput `pulumi:"startedAt"`
	// The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.
	State pulumi.StringInput `pulumi:"state"`
}

func (GetDatabasesDatabaseDataImportArgs) ElementType 

func (GetDatabasesDatabaseDataImportArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportOutput 

func (i GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportOutput() GetDatabasesDatabaseDataImportOutput

func (GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportOutputWithContext 

func (i GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportOutput

func (GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportPtrOutput 

func (i GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportPtrOutput() GetDatabasesDatabaseDataImportPtrOutput

func (GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportPtrOutputWithContext 

func (i GetDatabasesDatabaseDataImportArgs) ToGetDatabasesDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportPtrOutput

type GetDatabasesDatabaseDataImportDataSource 

type GetDatabasesDatabaseDataImportDataSource struct {
	// The name of the database imported from.
	Database string `pulumi:"database"`
	// The hostname where the database lives.
	Hostname string `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port string `pulumi:"port"`
}

type GetDatabasesDatabaseDataImportDataSourceArgs 

type GetDatabasesDatabaseDataImportDataSourceArgs struct {
	// The name of the database imported from.
	Database pulumi.StringInput `pulumi:"database"`
	// The hostname where the database lives.
	Hostname pulumi.StringInput `pulumi:"hostname"`
	// The port on which the database listens on the host.
	Port pulumi.StringInput `pulumi:"port"`
}

func (GetDatabasesDatabaseDataImportDataSourceArgs) ElementType 

func (GetDatabasesDatabaseDataImportDataSourceArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourceOutput 

func (i GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourceOutput() GetDatabasesDatabaseDataImportDataSourceOutput

func (GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourceOutputWithContext 

func (i GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportDataSourceOutput

func (GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput 

func (i GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput() GetDatabasesDatabaseDataImportDataSourcePtrOutput

func (GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext 

func (i GetDatabasesDatabaseDataImportDataSourceArgs) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportDataSourcePtrOutput

type GetDatabasesDatabaseDataImportDataSourceInput 

type GetDatabasesDatabaseDataImportDataSourceInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseDataImportDataSourceOutput() GetDatabasesDatabaseDataImportDataSourceOutput
	ToGetDatabasesDatabaseDataImportDataSourceOutputWithContext(context.Context) GetDatabasesDatabaseDataImportDataSourceOutput
}

GetDatabasesDatabaseDataImportDataSourceInput is an input type that accepts GetDatabasesDatabaseDataImportDataSourceArgs and GetDatabasesDatabaseDataImportDataSourceOutput values. You can construct a concrete instance of `GetDatabasesDatabaseDataImportDataSourceInput` via: 

GetDatabasesDatabaseDataImportDataSourceArgs{...}

type GetDatabasesDatabaseDataImportDataSourceOutput 

type GetDatabasesDatabaseDataImportDataSourceOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseDataImportDataSourceOutput) Database 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) Database() pulumi.StringOutput

The name of the database imported from.

func (GetDatabasesDatabaseDataImportDataSourceOutput) ElementType 

func (GetDatabasesDatabaseDataImportDataSourceOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportDataSourceOutput) Hostname 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) Hostname() pulumi.StringOutput

The hostname where the database lives.

func (GetDatabasesDatabaseDataImportDataSourceOutput) Port 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) Port() pulumi.StringOutput

The port on which the database listens on the host.

func (GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourceOutput 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourceOutput() GetDatabasesDatabaseDataImportDataSourceOutput

func (GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourceOutputWithContext 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourceOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportDataSourceOutput

func (GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput() GetDatabasesDatabaseDataImportDataSourcePtrOutput

func (GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext 

func (o GetDatabasesDatabaseDataImportDataSourceOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportDataSourcePtrOutput

type GetDatabasesDatabaseDataImportDataSourcePtrInput 

type GetDatabasesDatabaseDataImportDataSourcePtrInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseDataImportDataSourcePtrOutput() GetDatabasesDatabaseDataImportDataSourcePtrOutput
	ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext(context.Context) GetDatabasesDatabaseDataImportDataSourcePtrOutput
}

GetDatabasesDatabaseDataImportDataSourcePtrInput is an input type that accepts GetDatabasesDatabaseDataImportDataSourceArgs, GetDatabasesDatabaseDataImportDataSourcePtr and GetDatabasesDatabaseDataImportDataSourcePtrOutput values. You can construct a concrete instance of `GetDatabasesDatabaseDataImportDataSourcePtrInput` via: 

        GetDatabasesDatabaseDataImportDataSourceArgs{...}

or:

        nil

func GetDatabasesDatabaseDataImportDataSourcePtr 

func GetDatabasesDatabaseDataImportDataSourcePtr(v *GetDatabasesDatabaseDataImportDataSourceArgs) GetDatabasesDatabaseDataImportDataSourcePtrInput

type GetDatabasesDatabaseDataImportDataSourcePtrOutput 

type GetDatabasesDatabaseDataImportDataSourcePtrOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) Database 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) Database() pulumi.StringPtrOutput

The name of the database imported from.

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) Elem 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) Elem() GetDatabasesDatabaseDataImportDataSourceOutput

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) ElementType 

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) Hostname 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) Hostname() pulumi.StringPtrOutput

The hostname where the database lives.

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) Port 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) Port() pulumi.StringPtrOutput

The port on which the database listens on the host.

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutput() GetDatabasesDatabaseDataImportDataSourcePtrOutput

func (GetDatabasesDatabaseDataImportDataSourcePtrOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext 

func (o GetDatabasesDatabaseDataImportDataSourcePtrOutput) ToGetDatabasesDatabaseDataImportDataSourcePtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportDataSourcePtrOutput

type GetDatabasesDatabaseDataImportInput 

type GetDatabasesDatabaseDataImportInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseDataImportOutput() GetDatabasesDatabaseDataImportOutput
	ToGetDatabasesDatabaseDataImportOutputWithContext(context.Context) GetDatabasesDatabaseDataImportOutput
}

GetDatabasesDatabaseDataImportInput is an input type that accepts GetDatabasesDatabaseDataImportArgs and GetDatabasesDatabaseDataImportOutput values. You can construct a concrete instance of `GetDatabasesDatabaseDataImportInput` via: 

GetDatabasesDatabaseDataImportArgs{...}

type GetDatabasesDatabaseDataImportOutput 

type GetDatabasesDatabaseDataImportOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseDataImportOutput) DataSource 

func (o GetDatabasesDatabaseDataImportOutput) DataSource() GetDatabasesDatabaseDataImportDataSourceOutput

Connection information for the source of the data for the import.

func (GetDatabasesDatabaseDataImportOutput) ElementType 

func (GetDatabasesDatabaseDataImportOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportOutput) FinishedAt 

func (o GetDatabasesDatabaseDataImportOutput) FinishedAt() pulumi.StringOutput

When the import finished.

func (GetDatabasesDatabaseDataImportOutput) ImportCheckErrors 

func (o GetDatabasesDatabaseDataImportOutput) ImportCheckErrors() pulumi.StringOutput

Errors encountered while preparing the import.

func (GetDatabasesDatabaseDataImportOutput) StartedAt 

func (o GetDatabasesDatabaseDataImportOutput) StartedAt() pulumi.StringOutput

When the import started.

func (GetDatabasesDatabaseDataImportOutput) State 

func (o GetDatabasesDatabaseDataImportOutput) State() pulumi.StringOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportOutput 

func (o GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportOutput() GetDatabasesDatabaseDataImportOutput

func (GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportOutputWithContext 

func (o GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportOutput

func (GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportPtrOutput 

func (o GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportPtrOutput() GetDatabasesDatabaseDataImportPtrOutput

func (GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportPtrOutputWithContext 

func (o GetDatabasesDatabaseDataImportOutput) ToGetDatabasesDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportPtrOutput

type GetDatabasesDatabaseDataImportPtrInput 

type GetDatabasesDatabaseDataImportPtrInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseDataImportPtrOutput() GetDatabasesDatabaseDataImportPtrOutput
	ToGetDatabasesDatabaseDataImportPtrOutputWithContext(context.Context) GetDatabasesDatabaseDataImportPtrOutput
}

GetDatabasesDatabaseDataImportPtrInput is an input type that accepts GetDatabasesDatabaseDataImportArgs, GetDatabasesDatabaseDataImportPtr and GetDatabasesDatabaseDataImportPtrOutput values. You can construct a concrete instance of `GetDatabasesDatabaseDataImportPtrInput` via: 

        GetDatabasesDatabaseDataImportArgs{...}

or:

        nil

func GetDatabasesDatabaseDataImportPtr 

func GetDatabasesDatabaseDataImportPtr(v *GetDatabasesDatabaseDataImportArgs) GetDatabasesDatabaseDataImportPtrInput

type GetDatabasesDatabaseDataImportPtrOutput 

type GetDatabasesDatabaseDataImportPtrOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseDataImportPtrOutput) DataSource 

func (o GetDatabasesDatabaseDataImportPtrOutput) DataSource() GetDatabasesDatabaseDataImportDataSourcePtrOutput

Connection information for the source of the data for the import.

func (GetDatabasesDatabaseDataImportPtrOutput) Elem 

func (o GetDatabasesDatabaseDataImportPtrOutput) Elem() GetDatabasesDatabaseDataImportOutput

func (GetDatabasesDatabaseDataImportPtrOutput) ElementType 

func (GetDatabasesDatabaseDataImportPtrOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseDataImportPtrOutput) FinishedAt 

func (o GetDatabasesDatabaseDataImportPtrOutput) FinishedAt() pulumi.StringPtrOutput

When the import finished.

func (GetDatabasesDatabaseDataImportPtrOutput) ImportCheckErrors 

func (o GetDatabasesDatabaseDataImportPtrOutput) ImportCheckErrors() pulumi.StringPtrOutput

Errors encountered while preparing the import.

func (GetDatabasesDatabaseDataImportPtrOutput) StartedAt 

func (o GetDatabasesDatabaseDataImportPtrOutput) StartedAt() pulumi.StringPtrOutput

When the import started.

func (GetDatabasesDatabaseDataImportPtrOutput) State 

func (o GetDatabasesDatabaseDataImportPtrOutput) State() pulumi.StringPtrOutput

The state of the import, one of: pending, queued, in_progress, complete, cancelled, error.

func (GetDatabasesDatabaseDataImportPtrOutput) ToGetDatabasesDatabaseDataImportPtrOutput 

func (o GetDatabasesDatabaseDataImportPtrOutput) ToGetDatabasesDatabaseDataImportPtrOutput() GetDatabasesDatabaseDataImportPtrOutput

func (GetDatabasesDatabaseDataImportPtrOutput) ToGetDatabasesDatabaseDataImportPtrOutputWithContext 

func (o GetDatabasesDatabaseDataImportPtrOutput) ToGetDatabasesDatabaseDataImportPtrOutputWithContext(ctx context.Context) GetDatabasesDatabaseDataImportPtrOutput

type GetDatabasesDatabaseInput 

type GetDatabasesDatabaseInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput
	ToGetDatabasesDatabaseOutputWithContext(context.Context) GetDatabasesDatabaseOutput
}

GetDatabasesDatabaseInput is an input type that accepts GetDatabasesDatabaseArgs and GetDatabasesDatabaseOutput values. You can construct a concrete instance of `GetDatabasesDatabaseInput` via: 

GetDatabasesDatabaseArgs{...}

type GetDatabasesDatabaseOutput 

type GetDatabasesDatabaseOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseOutput) AllowDataBranching 

func (o GetDatabasesDatabaseOutput) AllowDataBranching() pulumi.BoolOutput

Whether seeding branches with data is enabled for all branches.

func (GetDatabasesDatabaseOutput) AtBackupRestoreBranchesLimit 

func (o GetDatabasesDatabaseOutput) AtBackupRestoreBranchesLimit() pulumi.BoolOutput

If the database has reached its backup restored branch limit.

func (GetDatabasesDatabaseOutput) AtDevelopmentBranchLimit 

func (o GetDatabasesDatabaseOutput) AtDevelopmentBranchLimit() pulumi.BoolOutput

If the database has reached its development branch limit.

func (GetDatabasesDatabaseOutput) AutomaticMigrations 

func (o GetDatabasesDatabaseOutput) AutomaticMigrations() pulumi.BoolOutput

Whether to automatically manage Rails migrations during deploy requests.

func (GetDatabasesDatabaseOutput) BranchesCount 

func (o GetDatabasesDatabaseOutput) BranchesCount() pulumi.Float64Output

The total number of database branches.

func (GetDatabasesDatabaseOutput) BranchesUrl 

func (o GetDatabasesDatabaseOutput) BranchesUrl() pulumi.StringOutput

The URL to retrieve this database's branches via the API.

func (GetDatabasesDatabaseOutput) CreatedAt 

func (o GetDatabasesDatabaseOutput) CreatedAt() pulumi.StringOutput

When the database was created.

func (GetDatabasesDatabaseOutput) DataImport 

func (o GetDatabasesDatabaseOutput) DataImport() GetDatabasesDatabaseDataImportPtrOutput

If the database was created from an import, describes the import process.

func (GetDatabasesDatabaseOutput) DefaultBranch 

func (o GetDatabasesDatabaseOutput) DefaultBranch() pulumi.StringOutput

The default branch for the database.

func (GetDatabasesDatabaseOutput) DefaultBranchReadOnlyRegionsCount 

func (o GetDatabasesDatabaseOutput) DefaultBranchReadOnlyRegionsCount() pulumi.Float64Output

Number of read only regions in the default branch.

func (GetDatabasesDatabaseOutput) DefaultBranchShardCount 

func (o GetDatabasesDatabaseOutput) DefaultBranchShardCount() pulumi.Float64Output

Number of shards in the default branch.

func (GetDatabasesDatabaseOutput) DefaultBranchTableCount 

func (o GetDatabasesDatabaseOutput) DefaultBranchTableCount() pulumi.Float64Output

Number of tables in the default branch schema.

func (GetDatabasesDatabaseOutput) DevelopmentBranchesCount 

func (o GetDatabasesDatabaseOutput) DevelopmentBranchesCount() pulumi.Float64Output

The total number of database development branches.

func (GetDatabasesDatabaseOutput) ElementType 

func (GetDatabasesDatabaseOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseOutput) HtmlUrl 

func (o GetDatabasesDatabaseOutput) HtmlUrl() pulumi.StringOutput

The total number of database development branches.

func (GetDatabasesDatabaseOutput) Id 

func (o GetDatabasesDatabaseOutput) Id() pulumi.StringOutput

The ID of the database.

func (GetDatabasesDatabaseOutput) InsightsRawQueries 

func (o GetDatabasesDatabaseOutput) InsightsRawQueries() pulumi.BoolOutput

The URL to see this database's branches in the web UI.

func (GetDatabasesDatabaseOutput) IssuesCount 

func (o GetDatabasesDatabaseOutput) IssuesCount() pulumi.Float64Output

The total number of ongoing issues within a database.

func (GetDatabasesDatabaseOutput) MigrationFramework 

func (o GetDatabasesDatabaseOutput) MigrationFramework() pulumi.StringOutput

Framework used for applying migrations.

func (GetDatabasesDatabaseOutput) MigrationTableName 

func (o GetDatabasesDatabaseOutput) MigrationTableName() pulumi.StringOutput

Table name to use for copying schema migration data.

func (GetDatabasesDatabaseOutput) MultipleAdminsRequiredForDeletion 

func (o GetDatabasesDatabaseOutput) MultipleAdminsRequiredForDeletion() pulumi.BoolOutput

If the database requires multiple admins for deletion.

func (GetDatabasesDatabaseOutput) Name 

func (o GetDatabasesDatabaseOutput) Name() pulumi.StringOutput

The name of this database.

func (GetDatabasesDatabaseOutput) Organization 

func (o GetDatabasesDatabaseOutput) Organization() pulumi.StringOutput

The organization this database belongs to.

func (GetDatabasesDatabaseOutput) Plan 

func (o GetDatabasesDatabaseOutput) Plan() pulumi.StringOutput

The database plan.

func (GetDatabasesDatabaseOutput) ProductionBranchWebConsole 

func (o GetDatabasesDatabaseOutput) ProductionBranchWebConsole() pulumi.BoolOutput

Whether web console is enabled for production branches.

func (GetDatabasesDatabaseOutput) ProductionBranchesCount 

func (o GetDatabasesDatabaseOutput) ProductionBranchesCount() pulumi.Float64Output

The total number of database production branches.

func (GetDatabasesDatabaseOutput) Ready 

func (o GetDatabasesDatabaseOutput) Ready() pulumi.BoolOutput

If the database is ready to be used.

func (GetDatabasesDatabaseOutput) Region 

func (o GetDatabasesDatabaseOutput) Region() GetDatabasesDatabaseRegionOutput

The region the database lives in.

func (GetDatabasesDatabaseOutput) RequireApprovalForDeploy 

func (o GetDatabasesDatabaseOutput) RequireApprovalForDeploy() pulumi.BoolOutput

Whether an approval is required to deploy schema changes to this database.

func (GetDatabasesDatabaseOutput) RestrictBranchRegion 

func (o GetDatabasesDatabaseOutput) RestrictBranchRegion() pulumi.BoolOutput

Whether to restrict branch creation to one region.

func (GetDatabasesDatabaseOutput) SchemaLastUpdatedAt 

func (o GetDatabasesDatabaseOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the default branch schema was last changed.

func (GetDatabasesDatabaseOutput) Sharded 

func (o GetDatabasesDatabaseOutput) Sharded() pulumi.BoolOutput

If the database is sharded.

func (GetDatabasesDatabaseOutput) State 

func (o GetDatabasesDatabaseOutput) State() pulumi.StringOutput

State of the database.

func (GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutput 

func (o GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutput() GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutputWithContext 

func (o GetDatabasesDatabaseOutput) ToGetDatabasesDatabaseOutputWithContext(ctx context.Context) GetDatabasesDatabaseOutput

func (GetDatabasesDatabaseOutput) UpdatedAt 

func (o GetDatabasesDatabaseOutput) UpdatedAt() pulumi.StringOutput

When the database was last updated.

func (GetDatabasesDatabaseOutput) Url 

func (o GetDatabasesDatabaseOutput) Url() pulumi.StringOutput

The URL to the database API endpoint.

type GetDatabasesDatabaseRegion 

type GetDatabasesDatabaseRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetDatabasesDatabaseRegionArgs 

type GetDatabasesDatabaseRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetDatabasesDatabaseRegionArgs) ElementType 

func (GetDatabasesDatabaseRegionArgs) ElementType() reflect.Type

func (GetDatabasesDatabaseRegionArgs) ToGetDatabasesDatabaseRegionOutput 

func (i GetDatabasesDatabaseRegionArgs) ToGetDatabasesDatabaseRegionOutput() GetDatabasesDatabaseRegionOutput

func (GetDatabasesDatabaseRegionArgs) ToGetDatabasesDatabaseRegionOutputWithContext 

func (i GetDatabasesDatabaseRegionArgs) ToGetDatabasesDatabaseRegionOutputWithContext(ctx context.Context) GetDatabasesDatabaseRegionOutput

type GetDatabasesDatabaseRegionInput 

type GetDatabasesDatabaseRegionInput interface {
	pulumi.Input

	ToGetDatabasesDatabaseRegionOutput() GetDatabasesDatabaseRegionOutput
	ToGetDatabasesDatabaseRegionOutputWithContext(context.Context) GetDatabasesDatabaseRegionOutput
}

GetDatabasesDatabaseRegionInput is an input type that accepts GetDatabasesDatabaseRegionArgs and GetDatabasesDatabaseRegionOutput values. You can construct a concrete instance of `GetDatabasesDatabaseRegionInput` via: 

GetDatabasesDatabaseRegionArgs{...}

type GetDatabasesDatabaseRegionOutput 

type GetDatabasesDatabaseRegionOutput struct{ *pulumi.OutputState }

func (GetDatabasesDatabaseRegionOutput) DisplayName 

func (o GetDatabasesDatabaseRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetDatabasesDatabaseRegionOutput) ElementType 

func (GetDatabasesDatabaseRegionOutput) ElementType() reflect.Type

func (GetDatabasesDatabaseRegionOutput) Enabled 

func (o GetDatabasesDatabaseRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetDatabasesDatabaseRegionOutput) Id 

func (o GetDatabasesDatabaseRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetDatabasesDatabaseRegionOutput) Location 

func (o GetDatabasesDatabaseRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetDatabasesDatabaseRegionOutput) Provider 

func (o GetDatabasesDatabaseRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetDatabasesDatabaseRegionOutput) PublicIpAddresses 

func (o GetDatabasesDatabaseRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetDatabasesDatabaseRegionOutput) Slug 

func (o GetDatabasesDatabaseRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetDatabasesDatabaseRegionOutput) ToGetDatabasesDatabaseRegionOutput 

func (o GetDatabasesDatabaseRegionOutput) ToGetDatabasesDatabaseRegionOutput() GetDatabasesDatabaseRegionOutput

func (GetDatabasesDatabaseRegionOutput) ToGetDatabasesDatabaseRegionOutputWithContext 

func (o GetDatabasesDatabaseRegionOutput) ToGetDatabasesDatabaseRegionOutputWithContext(ctx context.Context) GetDatabasesDatabaseRegionOutput

type GetDatabasesOutputArgs 

type GetDatabasesOutputArgs struct {
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getDatabases.

func (GetDatabasesOutputArgs) ElementType 

func (GetDatabasesOutputArgs) ElementType() reflect.Type

type GetDatabasesResult 

type GetDatabasesResult struct {
	Databases []GetDatabasesDatabase `pulumi:"databases"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	Organization string `pulumi:"organization"`
}

A collection of values returned by getDatabases.

func GetDatabases 

func GetDatabases(ctx *pulumi.Context, args *GetDatabasesArgs, opts ...pulumi.InvokeOption) (*GetDatabasesResult, error)

A list of PlanetScale databases.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetDatabases(ctx, &planetscale.GetDatabasesArgs{
			Organization: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("dbs", example)
		return nil
	})
}

```

type GetDatabasesResultOutput 

type GetDatabasesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabases.

func GetDatabasesOutput 

func GetDatabasesOutput(ctx *pulumi.Context, args GetDatabasesOutputArgs, opts ...pulumi.InvokeOption) GetDatabasesResultOutput

func (GetDatabasesResultOutput) Databases 

func (o GetDatabasesResultOutput) Databases() GetDatabasesDatabaseArrayOutput

func (GetDatabasesResultOutput) ElementType 

func (GetDatabasesResultOutput) ElementType() reflect.Type

func (GetDatabasesResultOutput) Id 

func (o GetDatabasesResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetDatabasesResultOutput) Organization 

func (o GetDatabasesResultOutput) Organization() pulumi.StringOutput

func (GetDatabasesResultOutput) ToGetDatabasesResultOutput 

func (o GetDatabasesResultOutput) ToGetDatabasesResultOutput() GetDatabasesResultOutput

func (GetDatabasesResultOutput) ToGetDatabasesResultOutputWithContext 

func (o GetDatabasesResultOutput) ToGetDatabasesResultOutputWithContext(ctx context.Context) GetDatabasesResultOutput

type GetOauthApplicationsApplication 

type GetOauthApplicationsApplication struct {
	// The image source for the OAuth application's avatar.
	Avatar string `pulumi:"avatar"`
	// The OAuth application's unique client id.
	ClientId string `pulumi:"clientId"`
	// When the OAuth application was created.
	CreatedAt string `pulumi:"createdAt"`
	// The domain of the OAuth application. Used for verification of a valid redirect uri.
	Domain string `pulumi:"domain"`
	// The ID of the OAuth application.
	Id string `pulumi:"id"`
	// The name of the OAuth application.
	Name string `pulumi:"name"`
	// The redirect URI of the OAuth application.
	RedirectUri string `pulumi:"redirectUri"`
	// The scopes that the OAuth application requires on a user's accout.
	Scopes []string `pulumi:"scopes"`
	// The number of tokens issued by the OAuth application.
	Tokens float64 `pulumi:"tokens"`
	// When the OAuth application was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

type GetOauthApplicationsApplicationArgs 

type GetOauthApplicationsApplicationArgs struct {
	// The image source for the OAuth application's avatar.
	Avatar pulumi.StringInput `pulumi:"avatar"`
	// The OAuth application's unique client id.
	ClientId pulumi.StringInput `pulumi:"clientId"`
	// When the OAuth application was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The domain of the OAuth application. Used for verification of a valid redirect uri.
	Domain pulumi.StringInput `pulumi:"domain"`
	// The ID of the OAuth application.
	Id pulumi.StringInput `pulumi:"id"`
	// The name of the OAuth application.
	Name pulumi.StringInput `pulumi:"name"`
	// The redirect URI of the OAuth application.
	RedirectUri pulumi.StringInput `pulumi:"redirectUri"`
	// The scopes that the OAuth application requires on a user's accout.
	Scopes pulumi.StringArrayInput `pulumi:"scopes"`
	// The number of tokens issued by the OAuth application.
	Tokens pulumi.Float64Input `pulumi:"tokens"`
	// When the OAuth application was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
}

func (GetOauthApplicationsApplicationArgs) ElementType 

func (GetOauthApplicationsApplicationArgs) ElementType() reflect.Type

func (GetOauthApplicationsApplicationArgs) ToGetOauthApplicationsApplicationOutput 

func (i GetOauthApplicationsApplicationArgs) ToGetOauthApplicationsApplicationOutput() GetOauthApplicationsApplicationOutput

func (GetOauthApplicationsApplicationArgs) ToGetOauthApplicationsApplicationOutputWithContext 

func (i GetOauthApplicationsApplicationArgs) ToGetOauthApplicationsApplicationOutputWithContext(ctx context.Context) GetOauthApplicationsApplicationOutput

type GetOauthApplicationsApplicationArray 

type GetOauthApplicationsApplicationArray []GetOauthApplicationsApplicationInput

func (GetOauthApplicationsApplicationArray) ElementType 

func (GetOauthApplicationsApplicationArray) ElementType() reflect.Type

func (GetOauthApplicationsApplicationArray) ToGetOauthApplicationsApplicationArrayOutput 

func (i GetOauthApplicationsApplicationArray) ToGetOauthApplicationsApplicationArrayOutput() GetOauthApplicationsApplicationArrayOutput

func (GetOauthApplicationsApplicationArray) ToGetOauthApplicationsApplicationArrayOutputWithContext 

func (i GetOauthApplicationsApplicationArray) ToGetOauthApplicationsApplicationArrayOutputWithContext(ctx context.Context) GetOauthApplicationsApplicationArrayOutput

type GetOauthApplicationsApplicationArrayInput 

type GetOauthApplicationsApplicationArrayInput interface {
	pulumi.Input

	ToGetOauthApplicationsApplicationArrayOutput() GetOauthApplicationsApplicationArrayOutput
	ToGetOauthApplicationsApplicationArrayOutputWithContext(context.Context) GetOauthApplicationsApplicationArrayOutput
}

GetOauthApplicationsApplicationArrayInput is an input type that accepts GetOauthApplicationsApplicationArray and GetOauthApplicationsApplicationArrayOutput values. You can construct a concrete instance of `GetOauthApplicationsApplicationArrayInput` via: 

GetOauthApplicationsApplicationArray{ GetOauthApplicationsApplicationArgs{...} }

type GetOauthApplicationsApplicationArrayOutput 

type GetOauthApplicationsApplicationArrayOutput struct{ *pulumi.OutputState }

func (GetOauthApplicationsApplicationArrayOutput) ElementType 

func (GetOauthApplicationsApplicationArrayOutput) ElementType() reflect.Type

func (GetOauthApplicationsApplicationArrayOutput) Index 

func (o GetOauthApplicationsApplicationArrayOutput) Index(i pulumi.IntInput) GetOauthApplicationsApplicationOutput

func (GetOauthApplicationsApplicationArrayOutput) ToGetOauthApplicationsApplicationArrayOutput 

func (o GetOauthApplicationsApplicationArrayOutput) ToGetOauthApplicationsApplicationArrayOutput() GetOauthApplicationsApplicationArrayOutput

func (GetOauthApplicationsApplicationArrayOutput) ToGetOauthApplicationsApplicationArrayOutputWithContext 

func (o GetOauthApplicationsApplicationArrayOutput) ToGetOauthApplicationsApplicationArrayOutputWithContext(ctx context.Context) GetOauthApplicationsApplicationArrayOutput

type GetOauthApplicationsApplicationInput 

type GetOauthApplicationsApplicationInput interface {
	pulumi.Input

	ToGetOauthApplicationsApplicationOutput() GetOauthApplicationsApplicationOutput
	ToGetOauthApplicationsApplicationOutputWithContext(context.Context) GetOauthApplicationsApplicationOutput
}

GetOauthApplicationsApplicationInput is an input type that accepts GetOauthApplicationsApplicationArgs and GetOauthApplicationsApplicationOutput values. You can construct a concrete instance of `GetOauthApplicationsApplicationInput` via: 

GetOauthApplicationsApplicationArgs{...}

type GetOauthApplicationsApplicationOutput 

type GetOauthApplicationsApplicationOutput struct{ *pulumi.OutputState }

func (GetOauthApplicationsApplicationOutput) Avatar 

func (o GetOauthApplicationsApplicationOutput) Avatar() pulumi.StringOutput

The image source for the OAuth application's avatar.

func (GetOauthApplicationsApplicationOutput) ClientId 

func (o GetOauthApplicationsApplicationOutput) ClientId() pulumi.StringOutput

The OAuth application's unique client id.

func (GetOauthApplicationsApplicationOutput) CreatedAt 

func (o GetOauthApplicationsApplicationOutput) CreatedAt() pulumi.StringOutput

When the OAuth application was created.

func (GetOauthApplicationsApplicationOutput) Domain 

func (o GetOauthApplicationsApplicationOutput) Domain() pulumi.StringOutput

The domain of the OAuth application. Used for verification of a valid redirect uri.

func (GetOauthApplicationsApplicationOutput) ElementType 

func (GetOauthApplicationsApplicationOutput) ElementType() reflect.Type

func (GetOauthApplicationsApplicationOutput) Id 

func (o GetOauthApplicationsApplicationOutput) Id() pulumi.StringOutput

The ID of the OAuth application.

func (GetOauthApplicationsApplicationOutput) Name 

func (o GetOauthApplicationsApplicationOutput) Name() pulumi.StringOutput

The name of the OAuth application.

func (GetOauthApplicationsApplicationOutput) RedirectUri 

func (o GetOauthApplicationsApplicationOutput) RedirectUri() pulumi.StringOutput

The redirect URI of the OAuth application.

func (GetOauthApplicationsApplicationOutput) Scopes 

func (o GetOauthApplicationsApplicationOutput) Scopes() pulumi.StringArrayOutput

The scopes that the OAuth application requires on a user's accout.

func (GetOauthApplicationsApplicationOutput) ToGetOauthApplicationsApplicationOutput 

func (o GetOauthApplicationsApplicationOutput) ToGetOauthApplicationsApplicationOutput() GetOauthApplicationsApplicationOutput

func (GetOauthApplicationsApplicationOutput) ToGetOauthApplicationsApplicationOutputWithContext 

func (o GetOauthApplicationsApplicationOutput) ToGetOauthApplicationsApplicationOutputWithContext(ctx context.Context) GetOauthApplicationsApplicationOutput

func (GetOauthApplicationsApplicationOutput) Tokens 

func (o GetOauthApplicationsApplicationOutput) Tokens() pulumi.Float64Output

The number of tokens issued by the OAuth application.

func (GetOauthApplicationsApplicationOutput) UpdatedAt 

func (o GetOauthApplicationsApplicationOutput) UpdatedAt() pulumi.StringOutput

When the OAuth application was last updated.

type GetOauthApplicationsArgs 

type GetOauthApplicationsArgs struct {
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getOauthApplications.

type GetOauthApplicationsOutputArgs 

type GetOauthApplicationsOutputArgs struct {
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getOauthApplications.

func (GetOauthApplicationsOutputArgs) ElementType 

func (GetOauthApplicationsOutputArgs) ElementType() reflect.Type

type GetOauthApplicationsResult 

type GetOauthApplicationsResult struct {
	Applications []GetOauthApplicationsApplication `pulumi:"applications"`
	// The provider-assigned unique ID for this managed resource.
	Id           string `pulumi:"id"`
	Organization string `pulumi:"organization"`
}

A collection of values returned by getOauthApplications.

func GetOauthApplications 

func GetOauthApplications(ctx *pulumi.Context, args *GetOauthApplicationsArgs, opts ...pulumi.InvokeOption) (*GetOauthApplicationsResult, error)

A list of PlanetScale OAuth applications. (requires feature flag)

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOauthApplications(ctx, &planetscale.GetOauthApplicationsArgs{
			Organization: data.Planetscale_organization.Example.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("oauthApps", example)
		return nil
	})
}

```

type GetOauthApplicationsResultOutput 

type GetOauthApplicationsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getOauthApplications.

func GetOauthApplicationsOutput 

func GetOauthApplicationsOutput(ctx *pulumi.Context, args GetOauthApplicationsOutputArgs, opts ...pulumi.InvokeOption) GetOauthApplicationsResultOutput

func (GetOauthApplicationsResultOutput) Applications 

func (o GetOauthApplicationsResultOutput) Applications() GetOauthApplicationsApplicationArrayOutput

func (GetOauthApplicationsResultOutput) ElementType 

func (GetOauthApplicationsResultOutput) ElementType() reflect.Type

func (GetOauthApplicationsResultOutput) Id 

func (o GetOauthApplicationsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetOauthApplicationsResultOutput) Organization 

func (o GetOauthApplicationsResultOutput) Organization() pulumi.StringOutput

func (GetOauthApplicationsResultOutput) ToGetOauthApplicationsResultOutput 

func (o GetOauthApplicationsResultOutput) ToGetOauthApplicationsResultOutput() GetOauthApplicationsResultOutput

func (GetOauthApplicationsResultOutput) ToGetOauthApplicationsResultOutputWithContext 

func (o GetOauthApplicationsResultOutput) ToGetOauthApplicationsResultOutputWithContext(ctx context.Context) GetOauthApplicationsResultOutput

type GetOrganizationArgs 

type GetOrganizationArgs struct {
	// The name of the organization.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getOrganization.

type GetOrganizationFeatures 

type GetOrganizationFeatures struct {
	Insights      bool `pulumi:"insights"`
	SingleTenancy bool `pulumi:"singleTenancy"`
	Sso           bool `pulumi:"sso"`
}

type GetOrganizationFeaturesArgs 

type GetOrganizationFeaturesArgs struct {
	Insights      pulumi.BoolInput `pulumi:"insights"`
	SingleTenancy pulumi.BoolInput `pulumi:"singleTenancy"`
	Sso           pulumi.BoolInput `pulumi:"sso"`
}

func (GetOrganizationFeaturesArgs) ElementType 

func (GetOrganizationFeaturesArgs) ElementType() reflect.Type

func (GetOrganizationFeaturesArgs) ToGetOrganizationFeaturesOutput 

func (i GetOrganizationFeaturesArgs) ToGetOrganizationFeaturesOutput() GetOrganizationFeaturesOutput

func (GetOrganizationFeaturesArgs) ToGetOrganizationFeaturesOutputWithContext 

func (i GetOrganizationFeaturesArgs) ToGetOrganizationFeaturesOutputWithContext(ctx context.Context) GetOrganizationFeaturesOutput

type GetOrganizationFeaturesInput 

type GetOrganizationFeaturesInput interface {
	pulumi.Input

	ToGetOrganizationFeaturesOutput() GetOrganizationFeaturesOutput
	ToGetOrganizationFeaturesOutputWithContext(context.Context) GetOrganizationFeaturesOutput
}

GetOrganizationFeaturesInput is an input type that accepts GetOrganizationFeaturesArgs and GetOrganizationFeaturesOutput values. You can construct a concrete instance of `GetOrganizationFeaturesInput` via: 

GetOrganizationFeaturesArgs{...}

type GetOrganizationFeaturesOutput 

type GetOrganizationFeaturesOutput struct{ *pulumi.OutputState }

func (GetOrganizationFeaturesOutput) ElementType 

func (GetOrganizationFeaturesOutput) ElementType() reflect.Type

func (GetOrganizationFeaturesOutput) Insights 

func (o GetOrganizationFeaturesOutput) Insights() pulumi.BoolOutput

func (GetOrganizationFeaturesOutput) SingleTenancy 

func (o GetOrganizationFeaturesOutput) SingleTenancy() pulumi.BoolOutput

func (GetOrganizationFeaturesOutput) Sso 

func (o GetOrganizationFeaturesOutput) Sso() pulumi.BoolOutput

func (GetOrganizationFeaturesOutput) ToGetOrganizationFeaturesOutput 

func (o GetOrganizationFeaturesOutput) ToGetOrganizationFeaturesOutput() GetOrganizationFeaturesOutput

func (GetOrganizationFeaturesOutput) ToGetOrganizationFeaturesOutputWithContext 

func (o GetOrganizationFeaturesOutput) ToGetOrganizationFeaturesOutputWithContext(ctx context.Context) GetOrganizationFeaturesOutput

type GetOrganizationFlags 

type GetOrganizationFlags struct {
	ExampleFlag string `pulumi:"exampleFlag"`
}

type GetOrganizationFlagsArgs 

type GetOrganizationFlagsArgs struct {
	ExampleFlag pulumi.StringInput `pulumi:"exampleFlag"`
}

func (GetOrganizationFlagsArgs) ElementType 

func (GetOrganizationFlagsArgs) ElementType() reflect.Type

func (GetOrganizationFlagsArgs) ToGetOrganizationFlagsOutput 

func (i GetOrganizationFlagsArgs) ToGetOrganizationFlagsOutput() GetOrganizationFlagsOutput

func (GetOrganizationFlagsArgs) ToGetOrganizationFlagsOutputWithContext 

func (i GetOrganizationFlagsArgs) ToGetOrganizationFlagsOutputWithContext(ctx context.Context) GetOrganizationFlagsOutput

type GetOrganizationFlagsInput 

type GetOrganizationFlagsInput interface {
	pulumi.Input

	ToGetOrganizationFlagsOutput() GetOrganizationFlagsOutput
	ToGetOrganizationFlagsOutputWithContext(context.Context) GetOrganizationFlagsOutput
}

GetOrganizationFlagsInput is an input type that accepts GetOrganizationFlagsArgs and GetOrganizationFlagsOutput values. You can construct a concrete instance of `GetOrganizationFlagsInput` via: 

GetOrganizationFlagsArgs{...}

type GetOrganizationFlagsOutput 

type GetOrganizationFlagsOutput struct{ *pulumi.OutputState }

func (GetOrganizationFlagsOutput) ElementType 

func (GetOrganizationFlagsOutput) ElementType() reflect.Type

func (GetOrganizationFlagsOutput) ExampleFlag 

func (o GetOrganizationFlagsOutput) ExampleFlag() pulumi.StringOutput

func (GetOrganizationFlagsOutput) ToGetOrganizationFlagsOutput 

func (o GetOrganizationFlagsOutput) ToGetOrganizationFlagsOutput() GetOrganizationFlagsOutput

func (GetOrganizationFlagsOutput) ToGetOrganizationFlagsOutputWithContext 

func (o GetOrganizationFlagsOutput) ToGetOrganizationFlagsOutputWithContext(ctx context.Context) GetOrganizationFlagsOutput

type GetOrganizationOutputArgs 

type GetOrganizationOutputArgs struct {
	// The name of the organization.
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getOrganization.

func (GetOrganizationOutputArgs) ElementType 

func (GetOrganizationOutputArgs) ElementType() reflect.Type

type GetOrganizationRegionsArgs 

type GetOrganizationRegionsArgs struct {
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getOrganizationRegions.

type GetOrganizationRegionsOutputArgs 

type GetOrganizationRegionsOutputArgs struct {
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getOrganizationRegions.

func (GetOrganizationRegionsOutputArgs) ElementType 

func (GetOrganizationRegionsOutputArgs) ElementType() reflect.Type

type GetOrganizationRegionsRegion 

type GetOrganizationRegionsRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetOrganizationRegionsRegionArgs 

type GetOrganizationRegionsRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetOrganizationRegionsRegionArgs) ElementType 

func (GetOrganizationRegionsRegionArgs) ElementType() reflect.Type

func (GetOrganizationRegionsRegionArgs) ToGetOrganizationRegionsRegionOutput 

func (i GetOrganizationRegionsRegionArgs) ToGetOrganizationRegionsRegionOutput() GetOrganizationRegionsRegionOutput

func (GetOrganizationRegionsRegionArgs) ToGetOrganizationRegionsRegionOutputWithContext 

func (i GetOrganizationRegionsRegionArgs) ToGetOrganizationRegionsRegionOutputWithContext(ctx context.Context) GetOrganizationRegionsRegionOutput

type GetOrganizationRegionsRegionArray 

type GetOrganizationRegionsRegionArray []GetOrganizationRegionsRegionInput

func (GetOrganizationRegionsRegionArray) ElementType 

func (GetOrganizationRegionsRegionArray) ElementType() reflect.Type

func (GetOrganizationRegionsRegionArray) ToGetOrganizationRegionsRegionArrayOutput 

func (i GetOrganizationRegionsRegionArray) ToGetOrganizationRegionsRegionArrayOutput() GetOrganizationRegionsRegionArrayOutput

func (GetOrganizationRegionsRegionArray) ToGetOrganizationRegionsRegionArrayOutputWithContext 

func (i GetOrganizationRegionsRegionArray) ToGetOrganizationRegionsRegionArrayOutputWithContext(ctx context.Context) GetOrganizationRegionsRegionArrayOutput

type GetOrganizationRegionsRegionArrayInput 

type GetOrganizationRegionsRegionArrayInput interface {
	pulumi.Input

	ToGetOrganizationRegionsRegionArrayOutput() GetOrganizationRegionsRegionArrayOutput
	ToGetOrganizationRegionsRegionArrayOutputWithContext(context.Context) GetOrganizationRegionsRegionArrayOutput
}

GetOrganizationRegionsRegionArrayInput is an input type that accepts GetOrganizationRegionsRegionArray and GetOrganizationRegionsRegionArrayOutput values. You can construct a concrete instance of `GetOrganizationRegionsRegionArrayInput` via: 

GetOrganizationRegionsRegionArray{ GetOrganizationRegionsRegionArgs{...} }

type GetOrganizationRegionsRegionArrayOutput 

type GetOrganizationRegionsRegionArrayOutput struct{ *pulumi.OutputState }

func (GetOrganizationRegionsRegionArrayOutput) ElementType 

func (GetOrganizationRegionsRegionArrayOutput) ElementType() reflect.Type

func (GetOrganizationRegionsRegionArrayOutput) Index 

func (o GetOrganizationRegionsRegionArrayOutput) Index(i pulumi.IntInput) GetOrganizationRegionsRegionOutput

func (GetOrganizationRegionsRegionArrayOutput) ToGetOrganizationRegionsRegionArrayOutput 

func (o GetOrganizationRegionsRegionArrayOutput) ToGetOrganizationRegionsRegionArrayOutput() GetOrganizationRegionsRegionArrayOutput

func (GetOrganizationRegionsRegionArrayOutput) ToGetOrganizationRegionsRegionArrayOutputWithContext 

func (o GetOrganizationRegionsRegionArrayOutput) ToGetOrganizationRegionsRegionArrayOutputWithContext(ctx context.Context) GetOrganizationRegionsRegionArrayOutput

type GetOrganizationRegionsRegionInput 

type GetOrganizationRegionsRegionInput interface {
	pulumi.Input

	ToGetOrganizationRegionsRegionOutput() GetOrganizationRegionsRegionOutput
	ToGetOrganizationRegionsRegionOutputWithContext(context.Context) GetOrganizationRegionsRegionOutput
}

GetOrganizationRegionsRegionInput is an input type that accepts GetOrganizationRegionsRegionArgs and GetOrganizationRegionsRegionOutput values. You can construct a concrete instance of `GetOrganizationRegionsRegionInput` via: 

GetOrganizationRegionsRegionArgs{...}

type GetOrganizationRegionsRegionOutput 

type GetOrganizationRegionsRegionOutput struct{ *pulumi.OutputState }

func (GetOrganizationRegionsRegionOutput) DisplayName 

func (o GetOrganizationRegionsRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetOrganizationRegionsRegionOutput) ElementType 

func (GetOrganizationRegionsRegionOutput) ElementType() reflect.Type

func (GetOrganizationRegionsRegionOutput) Enabled 

func (o GetOrganizationRegionsRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetOrganizationRegionsRegionOutput) Id 

func (o GetOrganizationRegionsRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetOrganizationRegionsRegionOutput) Location 

func (o GetOrganizationRegionsRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetOrganizationRegionsRegionOutput) Provider 

func (o GetOrganizationRegionsRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetOrganizationRegionsRegionOutput) PublicIpAddresses 

func (o GetOrganizationRegionsRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetOrganizationRegionsRegionOutput) Slug 

func (o GetOrganizationRegionsRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetOrganizationRegionsRegionOutput) ToGetOrganizationRegionsRegionOutput 

func (o GetOrganizationRegionsRegionOutput) ToGetOrganizationRegionsRegionOutput() GetOrganizationRegionsRegionOutput

func (GetOrganizationRegionsRegionOutput) ToGetOrganizationRegionsRegionOutputWithContext 

func (o GetOrganizationRegionsRegionOutput) ToGetOrganizationRegionsRegionOutputWithContext(ctx context.Context) GetOrganizationRegionsRegionOutput

type GetOrganizationRegionsResult 

type GetOrganizationRegionsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id           string                         `pulumi:"id"`
	Organization string                         `pulumi:"organization"`
	Regions      []GetOrganizationRegionsRegion `pulumi:"regions"`
}

A collection of values returned by getOrganizationRegions.

func GetOrganizationRegions 

func GetOrganizationRegions(ctx *pulumi.Context, args *GetOrganizationRegionsArgs, opts ...pulumi.InvokeOption) (*GetOrganizationRegionsResult, error)

A list of PlanetScale regions for the organization.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOrganizationRegions(ctx, &planetscale.GetOrganizationRegionsArgs{
			Organization: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("orgRegions", example)
		return nil
	})
}

```

type GetOrganizationRegionsResultOutput 

type GetOrganizationRegionsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getOrganizationRegions.

func GetOrganizationRegionsOutput 

func GetOrganizationRegionsOutput(ctx *pulumi.Context, args GetOrganizationRegionsOutputArgs, opts ...pulumi.InvokeOption) GetOrganizationRegionsResultOutput

func (GetOrganizationRegionsResultOutput) ElementType 

func (GetOrganizationRegionsResultOutput) ElementType() reflect.Type

func (GetOrganizationRegionsResultOutput) Id 

func (o GetOrganizationRegionsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetOrganizationRegionsResultOutput) Organization 

func (o GetOrganizationRegionsResultOutput) Organization() pulumi.StringOutput

func (GetOrganizationRegionsResultOutput) Regions 

func (o GetOrganizationRegionsResultOutput) Regions() GetOrganizationRegionsRegionArrayOutput

func (GetOrganizationRegionsResultOutput) ToGetOrganizationRegionsResultOutput 

func (o GetOrganizationRegionsResultOutput) ToGetOrganizationRegionsResultOutput() GetOrganizationRegionsResultOutput

func (GetOrganizationRegionsResultOutput) ToGetOrganizationRegionsResultOutputWithContext 

func (o GetOrganizationRegionsResultOutput) ToGetOrganizationRegionsResultOutputWithContext(ctx context.Context) GetOrganizationRegionsResultOutput

type GetOrganizationResult 

type GetOrganizationResult struct {
	// Whether or not only administrators can access production branches in the organization.
	AdminOnlyProductionAccess bool `pulumi:"adminOnlyProductionAccess"`
	// The billing email of the organization.
	BillingEmail string `pulumi:"billingEmail"`
	// Whether or not more databases can be created in the organization.
	CanCreateDatabases bool `pulumi:"canCreateDatabases"`
	// When the organization was created.
	CreatedAt string `pulumi:"createdAt"`
	// The number of databases in the organization.
	DatabaseCount float64 `pulumi:"databaseCount"`
	// Features that are enabled on the organization.
	Features GetOrganizationFeatures `pulumi:"features"`
	// .
	Flags GetOrganizationFlags `pulumi:"flags"`
	// The number of remaining free databases that can be created in the organization.
	FreeDatabasesRemaining float64 `pulumi:"freeDatabasesRemaining"`
	// Whether or not the organization has past due billing invoices.
	HasPastDueInvoices bool `pulumi:"hasPastDueInvoices"`
	// The ID for the organization.
	Id string `pulumi:"id"`
	// Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
	IdpManagedRoles bool `pulumi:"idpManagedRoles"`
	// The name of the organization.
	Name string `pulumi:"name"`
	// The billing plan of the organization.
	Plan string `pulumi:"plan"`
	// Whether or not the organization has single tenancy enabled.
	SingleTenancy bool `pulumi:"singleTenancy"`
	// The number of sleeping databases in the organization.
	SleepingDatabaseCount float64 `pulumi:"sleepingDatabaseCount"`
	// Whether or not SSO is enabled on the organization.
	Sso bool `pulumi:"sso"`
	// Whether or not the organization uses a WorkOS directory.
	SsoDirectory bool `pulumi:"ssoDirectory"`
	// The URL of the organization's SSO portal.
	SsoPortalUrl string `pulumi:"ssoPortalUrl"`
	// When the organization was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
	// Whether or not the organization's billing information is valid.
	ValidBillingInfo bool `pulumi:"validBillingInfo"`
}

A collection of values returned by getOrganization.

func GetOrganization 

func GetOrganization(ctx *pulumi.Context, args *GetOrganizationArgs, opts ...pulumi.InvokeOption) (*GetOrganizationResult, error)

A PlanetScale organization.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOrganization(ctx, &planetscale.GetOrganizationArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("org", example)
		return nil
	})
}

```

type GetOrganizationResultOutput 

type GetOrganizationResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getOrganization.

func GetOrganizationOutput 

func GetOrganizationOutput(ctx *pulumi.Context, args GetOrganizationOutputArgs, opts ...pulumi.InvokeOption) GetOrganizationResultOutput

func (GetOrganizationResultOutput) AdminOnlyProductionAccess 

func (o GetOrganizationResultOutput) AdminOnlyProductionAccess() pulumi.BoolOutput

Whether or not only administrators can access production branches in the organization.

func (GetOrganizationResultOutput) BillingEmail 

func (o GetOrganizationResultOutput) BillingEmail() pulumi.StringOutput

The billing email of the organization.

func (GetOrganizationResultOutput) CanCreateDatabases 

func (o GetOrganizationResultOutput) CanCreateDatabases() pulumi.BoolOutput

Whether or not more databases can be created in the organization.

func (GetOrganizationResultOutput) CreatedAt 

func (o GetOrganizationResultOutput) CreatedAt() pulumi.StringOutput

When the organization was created.

func (GetOrganizationResultOutput) DatabaseCount 

func (o GetOrganizationResultOutput) DatabaseCount() pulumi.Float64Output

The number of databases in the organization.

func (GetOrganizationResultOutput) ElementType 

func (GetOrganizationResultOutput) ElementType() reflect.Type

func (GetOrganizationResultOutput) Features 

func (o GetOrganizationResultOutput) Features() GetOrganizationFeaturesOutput

Features that are enabled on the organization.

func (GetOrganizationResultOutput) Flags 

func (o GetOrganizationResultOutput) Flags() GetOrganizationFlagsOutput

.

func (GetOrganizationResultOutput) FreeDatabasesRemaining 

func (o GetOrganizationResultOutput) FreeDatabasesRemaining() pulumi.Float64Output

The number of remaining free databases that can be created in the organization.

func (GetOrganizationResultOutput) HasPastDueInvoices 

func (o GetOrganizationResultOutput) HasPastDueInvoices() pulumi.BoolOutput

Whether or not the organization has past due billing invoices.

func (GetOrganizationResultOutput) Id 

func (o GetOrganizationResultOutput) Id() pulumi.StringOutput

The ID for the organization.

func (GetOrganizationResultOutput) IdpManagedRoles 

func (o GetOrganizationResultOutput) IdpManagedRoles() pulumi.BoolOutput

Whether or not the IdP provider is be responsible for managing roles in PlanetScale.

func (GetOrganizationResultOutput) Name 

func (o GetOrganizationResultOutput) Name() pulumi.StringOutput

The name of the organization.

func (GetOrganizationResultOutput) Plan 

func (o GetOrganizationResultOutput) Plan() pulumi.StringOutput

The billing plan of the organization.

func (GetOrganizationResultOutput) SingleTenancy 

func (o GetOrganizationResultOutput) SingleTenancy() pulumi.BoolOutput

Whether or not the organization has single tenancy enabled.

func (GetOrganizationResultOutput) SleepingDatabaseCount 

func (o GetOrganizationResultOutput) SleepingDatabaseCount() pulumi.Float64Output

The number of sleeping databases in the organization.

func (GetOrganizationResultOutput) Sso 

func (o GetOrganizationResultOutput) Sso() pulumi.BoolOutput

Whether or not SSO is enabled on the organization.

func (GetOrganizationResultOutput) SsoDirectory 

func (o GetOrganizationResultOutput) SsoDirectory() pulumi.BoolOutput

Whether or not the organization uses a WorkOS directory.

func (GetOrganizationResultOutput) SsoPortalUrl 

func (o GetOrganizationResultOutput) SsoPortalUrl() pulumi.StringOutput

The URL of the organization's SSO portal.

func (GetOrganizationResultOutput) ToGetOrganizationResultOutput 

func (o GetOrganizationResultOutput) ToGetOrganizationResultOutput() GetOrganizationResultOutput

func (GetOrganizationResultOutput) ToGetOrganizationResultOutputWithContext 

func (o GetOrganizationResultOutput) ToGetOrganizationResultOutputWithContext(ctx context.Context) GetOrganizationResultOutput

func (GetOrganizationResultOutput) UpdatedAt 

func (o GetOrganizationResultOutput) UpdatedAt() pulumi.StringOutput

When the organization was last updated.

func (GetOrganizationResultOutput) ValidBillingInfo 

func (o GetOrganizationResultOutput) ValidBillingInfo() pulumi.BoolOutput

Whether or not the organization's billing information is valid.

type GetOrganizationsOrganization 

type GetOrganizationsOrganization struct {
	// Whether or not only administrators can access production branches in the organization.
	AdminOnlyProductionAccess bool `pulumi:"adminOnlyProductionAccess"`
	// The billing email of the organization.
	BillingEmail string `pulumi:"billingEmail"`
	// Whether or not more databases can be created in the organization.
	CanCreateDatabases bool `pulumi:"canCreateDatabases"`
	// When the organization was created.
	CreatedAt string `pulumi:"createdAt"`
	// The number of databases in the organization.
	DatabaseCount float64 `pulumi:"databaseCount"`
	// Features that are enabled on the organization.
	Features GetOrganizationsOrganizationFeatures `pulumi:"features"`
	// .
	Flags GetOrganizationsOrganizationFlags `pulumi:"flags"`
	// The number of remaining free databases that can be created in the organization.
	FreeDatabasesRemaining float64 `pulumi:"freeDatabasesRemaining"`
	// Whether or not the organization has past due billing invoices.
	HasPastDueInvoices bool `pulumi:"hasPastDueInvoices"`
	// The ID for the organization.
	Id string `pulumi:"id"`
	// Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
	IdpManagedRoles bool `pulumi:"idpManagedRoles"`
	// The name of the organization.
	Name string `pulumi:"name"`
	// The billing plan of the organization.
	Plan string `pulumi:"plan"`
	// Whether or not the organization has single tenancy enabled.
	SingleTenancy bool `pulumi:"singleTenancy"`
	// The number of sleeping databases in the organization.
	SleepingDatabaseCount float64 `pulumi:"sleepingDatabaseCount"`
	// Whether or not SSO is enabled on the organization.
	Sso bool `pulumi:"sso"`
	// Whether or not the organization uses a WorkOS directory.
	SsoDirectory bool `pulumi:"ssoDirectory"`
	// The URL of the organization's SSO portal.
	SsoPortalUrl string `pulumi:"ssoPortalUrl"`
	// When the organization was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
	// Whether or not the organization's billing information is valid.
	ValidBillingInfo bool `pulumi:"validBillingInfo"`
}

type GetOrganizationsOrganizationArgs 

type GetOrganizationsOrganizationArgs struct {
	// Whether or not only administrators can access production branches in the organization.
	AdminOnlyProductionAccess pulumi.BoolInput `pulumi:"adminOnlyProductionAccess"`
	// The billing email of the organization.
	BillingEmail pulumi.StringInput `pulumi:"billingEmail"`
	// Whether or not more databases can be created in the organization.
	CanCreateDatabases pulumi.BoolInput `pulumi:"canCreateDatabases"`
	// When the organization was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The number of databases in the organization.
	DatabaseCount pulumi.Float64Input `pulumi:"databaseCount"`
	// Features that are enabled on the organization.
	Features GetOrganizationsOrganizationFeaturesInput `pulumi:"features"`
	// .
	Flags GetOrganizationsOrganizationFlagsInput `pulumi:"flags"`
	// The number of remaining free databases that can be created in the organization.
	FreeDatabasesRemaining pulumi.Float64Input `pulumi:"freeDatabasesRemaining"`
	// Whether or not the organization has past due billing invoices.
	HasPastDueInvoices pulumi.BoolInput `pulumi:"hasPastDueInvoices"`
	// The ID for the organization.
	Id pulumi.StringInput `pulumi:"id"`
	// Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
	IdpManagedRoles pulumi.BoolInput `pulumi:"idpManagedRoles"`
	// The name of the organization.
	Name pulumi.StringInput `pulumi:"name"`
	// The billing plan of the organization.
	Plan pulumi.StringInput `pulumi:"plan"`
	// Whether or not the organization has single tenancy enabled.
	SingleTenancy pulumi.BoolInput `pulumi:"singleTenancy"`
	// The number of sleeping databases in the organization.
	SleepingDatabaseCount pulumi.Float64Input `pulumi:"sleepingDatabaseCount"`
	// Whether or not SSO is enabled on the organization.
	Sso pulumi.BoolInput `pulumi:"sso"`
	// Whether or not the organization uses a WorkOS directory.
	SsoDirectory pulumi.BoolInput `pulumi:"ssoDirectory"`
	// The URL of the organization's SSO portal.
	SsoPortalUrl pulumi.StringInput `pulumi:"ssoPortalUrl"`
	// When the organization was last updated.
	UpdatedAt pulumi.StringInput `pulumi:"updatedAt"`
	// Whether or not the organization's billing information is valid.
	ValidBillingInfo pulumi.BoolInput `pulumi:"validBillingInfo"`
}

func (GetOrganizationsOrganizationArgs) ElementType 

func (GetOrganizationsOrganizationArgs) ElementType() reflect.Type

func (GetOrganizationsOrganizationArgs) ToGetOrganizationsOrganizationOutput 

func (i GetOrganizationsOrganizationArgs) ToGetOrganizationsOrganizationOutput() GetOrganizationsOrganizationOutput

func (GetOrganizationsOrganizationArgs) ToGetOrganizationsOrganizationOutputWithContext 

func (i GetOrganizationsOrganizationArgs) ToGetOrganizationsOrganizationOutputWithContext(ctx context.Context) GetOrganizationsOrganizationOutput

type GetOrganizationsOrganizationArray 

type GetOrganizationsOrganizationArray []GetOrganizationsOrganizationInput

func (GetOrganizationsOrganizationArray) ElementType 

func (GetOrganizationsOrganizationArray) ElementType() reflect.Type

func (GetOrganizationsOrganizationArray) ToGetOrganizationsOrganizationArrayOutput 

func (i GetOrganizationsOrganizationArray) ToGetOrganizationsOrganizationArrayOutput() GetOrganizationsOrganizationArrayOutput

func (GetOrganizationsOrganizationArray) ToGetOrganizationsOrganizationArrayOutputWithContext 

func (i GetOrganizationsOrganizationArray) ToGetOrganizationsOrganizationArrayOutputWithContext(ctx context.Context) GetOrganizationsOrganizationArrayOutput

type GetOrganizationsOrganizationArrayInput 

type GetOrganizationsOrganizationArrayInput interface {
	pulumi.Input

	ToGetOrganizationsOrganizationArrayOutput() GetOrganizationsOrganizationArrayOutput
	ToGetOrganizationsOrganizationArrayOutputWithContext(context.Context) GetOrganizationsOrganizationArrayOutput
}

GetOrganizationsOrganizationArrayInput is an input type that accepts GetOrganizationsOrganizationArray and GetOrganizationsOrganizationArrayOutput values. You can construct a concrete instance of `GetOrganizationsOrganizationArrayInput` via: 

GetOrganizationsOrganizationArray{ GetOrganizationsOrganizationArgs{...} }

type GetOrganizationsOrganizationArrayOutput 

type GetOrganizationsOrganizationArrayOutput struct{ *pulumi.OutputState }

func (GetOrganizationsOrganizationArrayOutput) ElementType 

func (GetOrganizationsOrganizationArrayOutput) ElementType() reflect.Type

func (GetOrganizationsOrganizationArrayOutput) Index 

func (o GetOrganizationsOrganizationArrayOutput) Index(i pulumi.IntInput) GetOrganizationsOrganizationOutput

func (GetOrganizationsOrganizationArrayOutput) ToGetOrganizationsOrganizationArrayOutput 

func (o GetOrganizationsOrganizationArrayOutput) ToGetOrganizationsOrganizationArrayOutput() GetOrganizationsOrganizationArrayOutput

func (GetOrganizationsOrganizationArrayOutput) ToGetOrganizationsOrganizationArrayOutputWithContext 

func (o GetOrganizationsOrganizationArrayOutput) ToGetOrganizationsOrganizationArrayOutputWithContext(ctx context.Context) GetOrganizationsOrganizationArrayOutput

type GetOrganizationsOrganizationFeatures 

type GetOrganizationsOrganizationFeatures struct {
	Insights      bool `pulumi:"insights"`
	SingleTenancy bool `pulumi:"singleTenancy"`
	Sso           bool `pulumi:"sso"`
}

type GetOrganizationsOrganizationFeaturesArgs 

type GetOrganizationsOrganizationFeaturesArgs struct {
	Insights      pulumi.BoolInput `pulumi:"insights"`
	SingleTenancy pulumi.BoolInput `pulumi:"singleTenancy"`
	Sso           pulumi.BoolInput `pulumi:"sso"`
}

func (GetOrganizationsOrganizationFeaturesArgs) ElementType 

func (GetOrganizationsOrganizationFeaturesArgs) ElementType() reflect.Type

func (GetOrganizationsOrganizationFeaturesArgs) ToGetOrganizationsOrganizationFeaturesOutput 

func (i GetOrganizationsOrganizationFeaturesArgs) ToGetOrganizationsOrganizationFeaturesOutput() GetOrganizationsOrganizationFeaturesOutput

func (GetOrganizationsOrganizationFeaturesArgs) ToGetOrganizationsOrganizationFeaturesOutputWithContext 

func (i GetOrganizationsOrganizationFeaturesArgs) ToGetOrganizationsOrganizationFeaturesOutputWithContext(ctx context.Context) GetOrganizationsOrganizationFeaturesOutput

type GetOrganizationsOrganizationFeaturesInput 

type GetOrganizationsOrganizationFeaturesInput interface {
	pulumi.Input

	ToGetOrganizationsOrganizationFeaturesOutput() GetOrganizationsOrganizationFeaturesOutput
	ToGetOrganizationsOrganizationFeaturesOutputWithContext(context.Context) GetOrganizationsOrganizationFeaturesOutput
}

GetOrganizationsOrganizationFeaturesInput is an input type that accepts GetOrganizationsOrganizationFeaturesArgs and GetOrganizationsOrganizationFeaturesOutput values. You can construct a concrete instance of `GetOrganizationsOrganizationFeaturesInput` via: 

GetOrganizationsOrganizationFeaturesArgs{...}

type GetOrganizationsOrganizationFeaturesOutput 

type GetOrganizationsOrganizationFeaturesOutput struct{ *pulumi.OutputState }

func (GetOrganizationsOrganizationFeaturesOutput) ElementType 

func (GetOrganizationsOrganizationFeaturesOutput) ElementType() reflect.Type

func (GetOrganizationsOrganizationFeaturesOutput) Insights 

func (o GetOrganizationsOrganizationFeaturesOutput) Insights() pulumi.BoolOutput

func (GetOrganizationsOrganizationFeaturesOutput) SingleTenancy 

func (o GetOrganizationsOrganizationFeaturesOutput) SingleTenancy() pulumi.BoolOutput

func (GetOrganizationsOrganizationFeaturesOutput) Sso 

func (o GetOrganizationsOrganizationFeaturesOutput) Sso() pulumi.BoolOutput

func (GetOrganizationsOrganizationFeaturesOutput) ToGetOrganizationsOrganizationFeaturesOutput 

func (o GetOrganizationsOrganizationFeaturesOutput) ToGetOrganizationsOrganizationFeaturesOutput() GetOrganizationsOrganizationFeaturesOutput

func (GetOrganizationsOrganizationFeaturesOutput) ToGetOrganizationsOrganizationFeaturesOutputWithContext 

func (o GetOrganizationsOrganizationFeaturesOutput) ToGetOrganizationsOrganizationFeaturesOutputWithContext(ctx context.Context) GetOrganizationsOrganizationFeaturesOutput

type GetOrganizationsOrganizationFlags 

type GetOrganizationsOrganizationFlags struct {
	ExampleFlag string `pulumi:"exampleFlag"`
}

type GetOrganizationsOrganizationFlagsArgs 

type GetOrganizationsOrganizationFlagsArgs struct {
	ExampleFlag pulumi.StringInput `pulumi:"exampleFlag"`
}

func (GetOrganizationsOrganizationFlagsArgs) ElementType 

func (GetOrganizationsOrganizationFlagsArgs) ElementType() reflect.Type

func (GetOrganizationsOrganizationFlagsArgs) ToGetOrganizationsOrganizationFlagsOutput 

func (i GetOrganizationsOrganizationFlagsArgs) ToGetOrganizationsOrganizationFlagsOutput() GetOrganizationsOrganizationFlagsOutput

func (GetOrganizationsOrganizationFlagsArgs) ToGetOrganizationsOrganizationFlagsOutputWithContext 

func (i GetOrganizationsOrganizationFlagsArgs) ToGetOrganizationsOrganizationFlagsOutputWithContext(ctx context.Context) GetOrganizationsOrganizationFlagsOutput

type GetOrganizationsOrganizationFlagsInput 

type GetOrganizationsOrganizationFlagsInput interface {
	pulumi.Input

	ToGetOrganizationsOrganizationFlagsOutput() GetOrganizationsOrganizationFlagsOutput
	ToGetOrganizationsOrganizationFlagsOutputWithContext(context.Context) GetOrganizationsOrganizationFlagsOutput
}

GetOrganizationsOrganizationFlagsInput is an input type that accepts GetOrganizationsOrganizationFlagsArgs and GetOrganizationsOrganizationFlagsOutput values. You can construct a concrete instance of `GetOrganizationsOrganizationFlagsInput` via: 

GetOrganizationsOrganizationFlagsArgs{...}

type GetOrganizationsOrganizationFlagsOutput 

type GetOrganizationsOrganizationFlagsOutput struct{ *pulumi.OutputState }

func (GetOrganizationsOrganizationFlagsOutput) ElementType 

func (GetOrganizationsOrganizationFlagsOutput) ElementType() reflect.Type

func (GetOrganizationsOrganizationFlagsOutput) ExampleFlag 

func (o GetOrganizationsOrganizationFlagsOutput) ExampleFlag() pulumi.StringOutput

func (GetOrganizationsOrganizationFlagsOutput) ToGetOrganizationsOrganizationFlagsOutput 

func (o GetOrganizationsOrganizationFlagsOutput) ToGetOrganizationsOrganizationFlagsOutput() GetOrganizationsOrganizationFlagsOutput

func (GetOrganizationsOrganizationFlagsOutput) ToGetOrganizationsOrganizationFlagsOutputWithContext 

func (o GetOrganizationsOrganizationFlagsOutput) ToGetOrganizationsOrganizationFlagsOutputWithContext(ctx context.Context) GetOrganizationsOrganizationFlagsOutput

type GetOrganizationsOrganizationInput 

type GetOrganizationsOrganizationInput interface {
	pulumi.Input

	ToGetOrganizationsOrganizationOutput() GetOrganizationsOrganizationOutput
	ToGetOrganizationsOrganizationOutputWithContext(context.Context) GetOrganizationsOrganizationOutput
}

GetOrganizationsOrganizationInput is an input type that accepts GetOrganizationsOrganizationArgs and GetOrganizationsOrganizationOutput values. You can construct a concrete instance of `GetOrganizationsOrganizationInput` via: 

GetOrganizationsOrganizationArgs{...}

type GetOrganizationsOrganizationOutput 

type GetOrganizationsOrganizationOutput struct{ *pulumi.OutputState }

func (GetOrganizationsOrganizationOutput) AdminOnlyProductionAccess 

func (o GetOrganizationsOrganizationOutput) AdminOnlyProductionAccess() pulumi.BoolOutput

Whether or not only administrators can access production branches in the organization.

func (GetOrganizationsOrganizationOutput) BillingEmail 

func (o GetOrganizationsOrganizationOutput) BillingEmail() pulumi.StringOutput

The billing email of the organization.

func (GetOrganizationsOrganizationOutput) CanCreateDatabases 

func (o GetOrganizationsOrganizationOutput) CanCreateDatabases() pulumi.BoolOutput

Whether or not more databases can be created in the organization.

func (GetOrganizationsOrganizationOutput) CreatedAt 

func (o GetOrganizationsOrganizationOutput) CreatedAt() pulumi.StringOutput

When the organization was created.

func (GetOrganizationsOrganizationOutput) DatabaseCount 

func (o GetOrganizationsOrganizationOutput) DatabaseCount() pulumi.Float64Output

The number of databases in the organization.

func (GetOrganizationsOrganizationOutput) ElementType 

func (GetOrganizationsOrganizationOutput) ElementType() reflect.Type

func (GetOrganizationsOrganizationOutput) Features 

func (o GetOrganizationsOrganizationOutput) Features() GetOrganizationsOrganizationFeaturesOutput

Features that are enabled on the organization.

func (GetOrganizationsOrganizationOutput) Flags 

func (o GetOrganizationsOrganizationOutput) Flags() GetOrganizationsOrganizationFlagsOutput

.

func (GetOrganizationsOrganizationOutput) FreeDatabasesRemaining 

func (o GetOrganizationsOrganizationOutput) FreeDatabasesRemaining() pulumi.Float64Output

The number of remaining free databases that can be created in the organization.

func (GetOrganizationsOrganizationOutput) HasPastDueInvoices 

func (o GetOrganizationsOrganizationOutput) HasPastDueInvoices() pulumi.BoolOutput

Whether or not the organization has past due billing invoices.

func (GetOrganizationsOrganizationOutput) Id 

func (o GetOrganizationsOrganizationOutput) Id() pulumi.StringOutput

The ID for the organization.

func (GetOrganizationsOrganizationOutput) IdpManagedRoles 

func (o GetOrganizationsOrganizationOutput) IdpManagedRoles() pulumi.BoolOutput

Whether or not the IdP provider is be responsible for managing roles in PlanetScale.

func (GetOrganizationsOrganizationOutput) Name 

func (o GetOrganizationsOrganizationOutput) Name() pulumi.StringOutput

The name of the organization.

func (GetOrganizationsOrganizationOutput) Plan 

func (o GetOrganizationsOrganizationOutput) Plan() pulumi.StringOutput

The billing plan of the organization.

func (GetOrganizationsOrganizationOutput) SingleTenancy 

func (o GetOrganizationsOrganizationOutput) SingleTenancy() pulumi.BoolOutput

Whether or not the organization has single tenancy enabled.

func (GetOrganizationsOrganizationOutput) SleepingDatabaseCount 

func (o GetOrganizationsOrganizationOutput) SleepingDatabaseCount() pulumi.Float64Output

The number of sleeping databases in the organization.

func (GetOrganizationsOrganizationOutput) Sso 

func (o GetOrganizationsOrganizationOutput) Sso() pulumi.BoolOutput

Whether or not SSO is enabled on the organization.

func (GetOrganizationsOrganizationOutput) SsoDirectory 

func (o GetOrganizationsOrganizationOutput) SsoDirectory() pulumi.BoolOutput

Whether or not the organization uses a WorkOS directory.

func (GetOrganizationsOrganizationOutput) SsoPortalUrl 

func (o GetOrganizationsOrganizationOutput) SsoPortalUrl() pulumi.StringOutput

The URL of the organization's SSO portal.

func (GetOrganizationsOrganizationOutput) ToGetOrganizationsOrganizationOutput 

func (o GetOrganizationsOrganizationOutput) ToGetOrganizationsOrganizationOutput() GetOrganizationsOrganizationOutput

func (GetOrganizationsOrganizationOutput) ToGetOrganizationsOrganizationOutputWithContext 

func (o GetOrganizationsOrganizationOutput) ToGetOrganizationsOrganizationOutputWithContext(ctx context.Context) GetOrganizationsOrganizationOutput

func (GetOrganizationsOrganizationOutput) UpdatedAt 

func (o GetOrganizationsOrganizationOutput) UpdatedAt() pulumi.StringOutput

When the organization was last updated.

func (GetOrganizationsOrganizationOutput) ValidBillingInfo 

func (o GetOrganizationsOrganizationOutput) ValidBillingInfo() pulumi.BoolOutput

Whether or not the organization's billing information is valid.

type GetOrganizationsResult 

type GetOrganizationsResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id            string                         `pulumi:"id"`
	Organizations []GetOrganizationsOrganization `pulumi:"organizations"`
}

A collection of values returned by getOrganizations.

func GetOrganizations 

func GetOrganizations(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetOrganizationsResult, error)

A list of PlanetScale organizations.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOrganizations(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("orgs", example)
		return nil
	})
}

```

type GetOrganizationsResultOutput 

type GetOrganizationsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getOrganizations.

func GetOrganizationsOutput 

func GetOrganizationsOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetOrganizationsResultOutput

func (GetOrganizationsResultOutput) ElementType 

func (GetOrganizationsResultOutput) ElementType() reflect.Type

func (GetOrganizationsResultOutput) Id 

func (o GetOrganizationsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetOrganizationsResultOutput) Organizations 

func (o GetOrganizationsResultOutput) Organizations() GetOrganizationsOrganizationArrayOutput

func (GetOrganizationsResultOutput) ToGetOrganizationsResultOutput 

func (o GetOrganizationsResultOutput) ToGetOrganizationsResultOutput() GetOrganizationsResultOutput

func (GetOrganizationsResultOutput) ToGetOrganizationsResultOutputWithContext 

func (o GetOrganizationsResultOutput) ToGetOrganizationsResultOutputWithContext(ctx context.Context) GetOrganizationsResultOutput

type GetPasswordActor 

type GetPasswordActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetPasswordActorArgs 

type GetPasswordActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetPasswordActorArgs) ElementType 

func (GetPasswordActorArgs) ElementType() reflect.Type

func (GetPasswordActorArgs) ToGetPasswordActorOutput 

func (i GetPasswordActorArgs) ToGetPasswordActorOutput() GetPasswordActorOutput

func (GetPasswordActorArgs) ToGetPasswordActorOutputWithContext 

func (i GetPasswordActorArgs) ToGetPasswordActorOutputWithContext(ctx context.Context) GetPasswordActorOutput

type GetPasswordActorInput 

type GetPasswordActorInput interface {
	pulumi.Input

	ToGetPasswordActorOutput() GetPasswordActorOutput
	ToGetPasswordActorOutputWithContext(context.Context) GetPasswordActorOutput
}

GetPasswordActorInput is an input type that accepts GetPasswordActorArgs and GetPasswordActorOutput values. You can construct a concrete instance of `GetPasswordActorInput` via: 

GetPasswordActorArgs{...}

type GetPasswordActorOutput 

type GetPasswordActorOutput struct{ *pulumi.OutputState }

func (GetPasswordActorOutput) AvatarUrl 

func (o GetPasswordActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetPasswordActorOutput) DisplayName 

func (o GetPasswordActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetPasswordActorOutput) ElementType 

func (GetPasswordActorOutput) ElementType() reflect.Type

func (GetPasswordActorOutput) Id 

func (o GetPasswordActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetPasswordActorOutput) ToGetPasswordActorOutput 

func (o GetPasswordActorOutput) ToGetPasswordActorOutput() GetPasswordActorOutput

func (GetPasswordActorOutput) ToGetPasswordActorOutputWithContext 

func (o GetPasswordActorOutput) ToGetPasswordActorOutputWithContext(ctx context.Context) GetPasswordActorOutput

type GetPasswordDatabaseBranch 

type GetPasswordDatabaseBranch struct {
	AccessHostUrl    string `pulumi:"accessHostUrl"`
	Id               string `pulumi:"id"`
	MysqlEdgeAddress string `pulumi:"mysqlEdgeAddress"`
	Name             string `pulumi:"name"`
	Production       bool   `pulumi:"production"`
}

type GetPasswordDatabaseBranchArgs 

type GetPasswordDatabaseBranchArgs struct {
	AccessHostUrl    pulumi.StringInput `pulumi:"accessHostUrl"`
	Id               pulumi.StringInput `pulumi:"id"`
	MysqlEdgeAddress pulumi.StringInput `pulumi:"mysqlEdgeAddress"`
	Name             pulumi.StringInput `pulumi:"name"`
	Production       pulumi.BoolInput   `pulumi:"production"`
}

func (GetPasswordDatabaseBranchArgs) ElementType 

func (GetPasswordDatabaseBranchArgs) ElementType() reflect.Type

func (GetPasswordDatabaseBranchArgs) ToGetPasswordDatabaseBranchOutput 

func (i GetPasswordDatabaseBranchArgs) ToGetPasswordDatabaseBranchOutput() GetPasswordDatabaseBranchOutput

func (GetPasswordDatabaseBranchArgs) ToGetPasswordDatabaseBranchOutputWithContext 

func (i GetPasswordDatabaseBranchArgs) ToGetPasswordDatabaseBranchOutputWithContext(ctx context.Context) GetPasswordDatabaseBranchOutput

type GetPasswordDatabaseBranchInput 

type GetPasswordDatabaseBranchInput interface {
	pulumi.Input

	ToGetPasswordDatabaseBranchOutput() GetPasswordDatabaseBranchOutput
	ToGetPasswordDatabaseBranchOutputWithContext(context.Context) GetPasswordDatabaseBranchOutput
}

GetPasswordDatabaseBranchInput is an input type that accepts GetPasswordDatabaseBranchArgs and GetPasswordDatabaseBranchOutput values. You can construct a concrete instance of `GetPasswordDatabaseBranchInput` via: 

GetPasswordDatabaseBranchArgs{...}

type GetPasswordDatabaseBranchOutput 

type GetPasswordDatabaseBranchOutput struct{ *pulumi.OutputState }

func (GetPasswordDatabaseBranchOutput) AccessHostUrl 

func (o GetPasswordDatabaseBranchOutput) AccessHostUrl() pulumi.StringOutput

func (GetPasswordDatabaseBranchOutput) ElementType 

func (GetPasswordDatabaseBranchOutput) ElementType() reflect.Type

func (GetPasswordDatabaseBranchOutput) Id 

func (o GetPasswordDatabaseBranchOutput) Id() pulumi.StringOutput

func (GetPasswordDatabaseBranchOutput) MysqlEdgeAddress 

func (o GetPasswordDatabaseBranchOutput) MysqlEdgeAddress() pulumi.StringOutput

func (GetPasswordDatabaseBranchOutput) Name 

func (o GetPasswordDatabaseBranchOutput) Name() pulumi.StringOutput

func (GetPasswordDatabaseBranchOutput) Production 

func (o GetPasswordDatabaseBranchOutput) Production() pulumi.BoolOutput

func (GetPasswordDatabaseBranchOutput) ToGetPasswordDatabaseBranchOutput 

func (o GetPasswordDatabaseBranchOutput) ToGetPasswordDatabaseBranchOutput() GetPasswordDatabaseBranchOutput

func (GetPasswordDatabaseBranchOutput) ToGetPasswordDatabaseBranchOutputWithContext 

func (o GetPasswordDatabaseBranchOutput) ToGetPasswordDatabaseBranchOutputWithContext(ctx context.Context) GetPasswordDatabaseBranchOutput

type GetPasswordRegion 

type GetPasswordRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetPasswordRegionArgs 

type GetPasswordRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetPasswordRegionArgs) ElementType 

func (GetPasswordRegionArgs) ElementType() reflect.Type

func (GetPasswordRegionArgs) ToGetPasswordRegionOutput 

func (i GetPasswordRegionArgs) ToGetPasswordRegionOutput() GetPasswordRegionOutput

func (GetPasswordRegionArgs) ToGetPasswordRegionOutputWithContext 

func (i GetPasswordRegionArgs) ToGetPasswordRegionOutputWithContext(ctx context.Context) GetPasswordRegionOutput

type GetPasswordRegionInput 

type GetPasswordRegionInput interface {
	pulumi.Input

	ToGetPasswordRegionOutput() GetPasswordRegionOutput
	ToGetPasswordRegionOutputWithContext(context.Context) GetPasswordRegionOutput
}

GetPasswordRegionInput is an input type that accepts GetPasswordRegionArgs and GetPasswordRegionOutput values. You can construct a concrete instance of `GetPasswordRegionInput` via: 

GetPasswordRegionArgs{...}

type GetPasswordRegionOutput 

type GetPasswordRegionOutput struct{ *pulumi.OutputState }

func (GetPasswordRegionOutput) DisplayName 

func (o GetPasswordRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetPasswordRegionOutput) ElementType 

func (GetPasswordRegionOutput) ElementType() reflect.Type

func (GetPasswordRegionOutput) Enabled 

func (o GetPasswordRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetPasswordRegionOutput) Id 

func (o GetPasswordRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetPasswordRegionOutput) Location 

func (o GetPasswordRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetPasswordRegionOutput) Provider 

func (o GetPasswordRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetPasswordRegionOutput) PublicIpAddresses 

func (o GetPasswordRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetPasswordRegionOutput) Slug 

func (o GetPasswordRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetPasswordRegionOutput) ToGetPasswordRegionOutput 

func (o GetPasswordRegionOutput) ToGetPasswordRegionOutput() GetPasswordRegionOutput

func (GetPasswordRegionOutput) ToGetPasswordRegionOutputWithContext 

func (o GetPasswordRegionOutput) ToGetPasswordRegionOutputWithContext(ctx context.Context) GetPasswordRegionOutput

type GetPasswordsArgs 

type GetPasswordsArgs struct {
	Branch           string  `pulumi:"branch"`
	Database         string  `pulumi:"database"`
	Organization     string  `pulumi:"organization"`
	ReadOnlyRegionId *string `pulumi:"readOnlyRegionId"`
}

A collection of arguments for invoking getPasswords.

type GetPasswordsOutputArgs 

type GetPasswordsOutputArgs struct {
	Branch           pulumi.StringInput    `pulumi:"branch"`
	Database         pulumi.StringInput    `pulumi:"database"`
	Organization     pulumi.StringInput    `pulumi:"organization"`
	ReadOnlyRegionId pulumi.StringPtrInput `pulumi:"readOnlyRegionId"`
}

A collection of arguments for invoking getPasswords.

func (GetPasswordsOutputArgs) ElementType 

func (GetPasswordsOutputArgs) ElementType() reflect.Type

type GetPasswordsPassword 

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

type GetPasswordsPasswordActor 

type GetPasswordsPasswordActor struct {
	// The URL of the actor's avatar
	AvatarUrl string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName string `pulumi:"displayName"`
	// The ID of the actor
	Id string `pulumi:"id"`
}

type GetPasswordsPasswordActorArgs 

type GetPasswordsPasswordActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringInput `pulumi:"id"`
}

func (GetPasswordsPasswordActorArgs) ElementType 

func (GetPasswordsPasswordActorArgs) ElementType() reflect.Type

func (GetPasswordsPasswordActorArgs) ToGetPasswordsPasswordActorOutput 

func (i GetPasswordsPasswordActorArgs) ToGetPasswordsPasswordActorOutput() GetPasswordsPasswordActorOutput

func (GetPasswordsPasswordActorArgs) ToGetPasswordsPasswordActorOutputWithContext 

func (i GetPasswordsPasswordActorArgs) ToGetPasswordsPasswordActorOutputWithContext(ctx context.Context) GetPasswordsPasswordActorOutput

type GetPasswordsPasswordActorInput 

type GetPasswordsPasswordActorInput interface {
	pulumi.Input

	ToGetPasswordsPasswordActorOutput() GetPasswordsPasswordActorOutput
	ToGetPasswordsPasswordActorOutputWithContext(context.Context) GetPasswordsPasswordActorOutput
}

GetPasswordsPasswordActorInput is an input type that accepts GetPasswordsPasswordActorArgs and GetPasswordsPasswordActorOutput values. You can construct a concrete instance of `GetPasswordsPasswordActorInput` via: 

GetPasswordsPasswordActorArgs{...}

type GetPasswordsPasswordActorOutput 

type GetPasswordsPasswordActorOutput struct{ *pulumi.OutputState }

func (GetPasswordsPasswordActorOutput) AvatarUrl 

func (o GetPasswordsPasswordActorOutput) AvatarUrl() pulumi.StringOutput

The URL of the actor's avatar

func (GetPasswordsPasswordActorOutput) DisplayName 

func (o GetPasswordsPasswordActorOutput) DisplayName() pulumi.StringOutput

The name of the actor

func (GetPasswordsPasswordActorOutput) ElementType 

func (GetPasswordsPasswordActorOutput) ElementType() reflect.Type

func (GetPasswordsPasswordActorOutput) Id 

func (o GetPasswordsPasswordActorOutput) Id() pulumi.StringOutput

The ID of the actor

func (GetPasswordsPasswordActorOutput) ToGetPasswordsPasswordActorOutput 

func (o GetPasswordsPasswordActorOutput) ToGetPasswordsPasswordActorOutput() GetPasswordsPasswordActorOutput

func (GetPasswordsPasswordActorOutput) ToGetPasswordsPasswordActorOutputWithContext 

func (o GetPasswordsPasswordActorOutput) ToGetPasswordsPasswordActorOutputWithContext(ctx context.Context) GetPasswordsPasswordActorOutput

type GetPasswordsPasswordArgs 

type GetPasswordsPasswordArgs struct {
	// The host URL for the password.
	AccessHostUrl pulumi.StringInput `pulumi:"accessHostUrl"`
	// The actor that created this branch.
	Actor GetPasswordsPasswordActorInput `pulumi:"actor"`
	// The branch this password belongs to..
	Branch pulumi.StringInput `pulumi:"branch"`
	// When the password was created.
	CreatedAt pulumi.StringInput `pulumi:"createdAt"`
	// The datanase this branch password belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// The branch this password is allowed to access.
	DatabaseBranch GetPasswordsPasswordDatabaseBranchInput `pulumi:"databaseBranch"`
	// When the password was deleted.
	DeletedAt pulumi.StringInput `pulumi:"deletedAt"`
	// When the password will expire.
	ExpiresAt pulumi.StringInput `pulumi:"expiresAt"`
	// The ID for the password.
	Id pulumi.StringInput `pulumi:"id"`
	// The display name for the password.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this database branch password belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// If the password is for a read-only region, the ID of the region.
	ReadOnlyRegionId pulumi.StringInput `pulumi:"readOnlyRegionId"`
	// The region in which this password can be used.
	Region GetPasswordsPasswordRegionInput `pulumi:"region"`
	// Whether or not the password can be renewed.
	Renewable pulumi.BoolInput `pulumi:"renewable"`
	// The role for the password.
	Role pulumi.StringInput `pulumi:"role"`
	// Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
	TtlSeconds pulumi.Float64Input `pulumi:"ttlSeconds"`
	// The username for the password.
	Username pulumi.StringInput `pulumi:"username"`
}

func (GetPasswordsPasswordArgs) ElementType 

func (GetPasswordsPasswordArgs) ElementType() reflect.Type

func (GetPasswordsPasswordArgs) ToGetPasswordsPasswordOutput 

func (i GetPasswordsPasswordArgs) ToGetPasswordsPasswordOutput() GetPasswordsPasswordOutput

func (GetPasswordsPasswordArgs) ToGetPasswordsPasswordOutputWithContext 

func (i GetPasswordsPasswordArgs) ToGetPasswordsPasswordOutputWithContext(ctx context.Context) GetPasswordsPasswordOutput

type GetPasswordsPasswordArray 

type GetPasswordsPasswordArray []GetPasswordsPasswordInput

func (GetPasswordsPasswordArray) ElementType 

func (GetPasswordsPasswordArray) ElementType() reflect.Type

func (GetPasswordsPasswordArray) ToGetPasswordsPasswordArrayOutput 

func (i GetPasswordsPasswordArray) ToGetPasswordsPasswordArrayOutput() GetPasswordsPasswordArrayOutput

func (GetPasswordsPasswordArray) ToGetPasswordsPasswordArrayOutputWithContext 

func (i GetPasswordsPasswordArray) ToGetPasswordsPasswordArrayOutputWithContext(ctx context.Context) GetPasswordsPasswordArrayOutput

type GetPasswordsPasswordArrayInput 

type GetPasswordsPasswordArrayInput interface {
	pulumi.Input

	ToGetPasswordsPasswordArrayOutput() GetPasswordsPasswordArrayOutput
	ToGetPasswordsPasswordArrayOutputWithContext(context.Context) GetPasswordsPasswordArrayOutput
}

GetPasswordsPasswordArrayInput is an input type that accepts GetPasswordsPasswordArray and GetPasswordsPasswordArrayOutput values. You can construct a concrete instance of `GetPasswordsPasswordArrayInput` via: 

GetPasswordsPasswordArray{ GetPasswordsPasswordArgs{...} }

type GetPasswordsPasswordArrayOutput 

type GetPasswordsPasswordArrayOutput struct{ *pulumi.OutputState }

func (GetPasswordsPasswordArrayOutput) ElementType 

func (GetPasswordsPasswordArrayOutput) ElementType() reflect.Type

func (GetPasswordsPasswordArrayOutput) Index 

func (o GetPasswordsPasswordArrayOutput) Index(i pulumi.IntInput) GetPasswordsPasswordOutput

func (GetPasswordsPasswordArrayOutput) ToGetPasswordsPasswordArrayOutput 

func (o GetPasswordsPasswordArrayOutput) ToGetPasswordsPasswordArrayOutput() GetPasswordsPasswordArrayOutput

func (GetPasswordsPasswordArrayOutput) ToGetPasswordsPasswordArrayOutputWithContext 

func (o GetPasswordsPasswordArrayOutput) ToGetPasswordsPasswordArrayOutputWithContext(ctx context.Context) GetPasswordsPasswordArrayOutput

type GetPasswordsPasswordDatabaseBranch 

type GetPasswordsPasswordDatabaseBranch struct {
	AccessHostUrl    string `pulumi:"accessHostUrl"`
	Id               string `pulumi:"id"`
	MysqlEdgeAddress string `pulumi:"mysqlEdgeAddress"`
	Name             string `pulumi:"name"`
	Production       bool   `pulumi:"production"`
}

type GetPasswordsPasswordDatabaseBranchArgs 

type GetPasswordsPasswordDatabaseBranchArgs struct {
	AccessHostUrl    pulumi.StringInput `pulumi:"accessHostUrl"`
	Id               pulumi.StringInput `pulumi:"id"`
	MysqlEdgeAddress pulumi.StringInput `pulumi:"mysqlEdgeAddress"`
	Name             pulumi.StringInput `pulumi:"name"`
	Production       pulumi.BoolInput   `pulumi:"production"`
}

func (GetPasswordsPasswordDatabaseBranchArgs) ElementType 

func (GetPasswordsPasswordDatabaseBranchArgs) ElementType() reflect.Type

func (GetPasswordsPasswordDatabaseBranchArgs) ToGetPasswordsPasswordDatabaseBranchOutput 

func (i GetPasswordsPasswordDatabaseBranchArgs) ToGetPasswordsPasswordDatabaseBranchOutput() GetPasswordsPasswordDatabaseBranchOutput

func (GetPasswordsPasswordDatabaseBranchArgs) ToGetPasswordsPasswordDatabaseBranchOutputWithContext 

func (i GetPasswordsPasswordDatabaseBranchArgs) ToGetPasswordsPasswordDatabaseBranchOutputWithContext(ctx context.Context) GetPasswordsPasswordDatabaseBranchOutput

type GetPasswordsPasswordDatabaseBranchInput 

type GetPasswordsPasswordDatabaseBranchInput interface {
	pulumi.Input

	ToGetPasswordsPasswordDatabaseBranchOutput() GetPasswordsPasswordDatabaseBranchOutput
	ToGetPasswordsPasswordDatabaseBranchOutputWithContext(context.Context) GetPasswordsPasswordDatabaseBranchOutput
}

GetPasswordsPasswordDatabaseBranchInput is an input type that accepts GetPasswordsPasswordDatabaseBranchArgs and GetPasswordsPasswordDatabaseBranchOutput values. You can construct a concrete instance of `GetPasswordsPasswordDatabaseBranchInput` via: 

GetPasswordsPasswordDatabaseBranchArgs{...}

type GetPasswordsPasswordDatabaseBranchOutput 

type GetPasswordsPasswordDatabaseBranchOutput struct{ *pulumi.OutputState }

func (GetPasswordsPasswordDatabaseBranchOutput) AccessHostUrl 

func (o GetPasswordsPasswordDatabaseBranchOutput) AccessHostUrl() pulumi.StringOutput

func (GetPasswordsPasswordDatabaseBranchOutput) ElementType 

func (GetPasswordsPasswordDatabaseBranchOutput) ElementType() reflect.Type

func (GetPasswordsPasswordDatabaseBranchOutput) Id 

func (o GetPasswordsPasswordDatabaseBranchOutput) Id() pulumi.StringOutput

func (GetPasswordsPasswordDatabaseBranchOutput) MysqlEdgeAddress 

func (o GetPasswordsPasswordDatabaseBranchOutput) MysqlEdgeAddress() pulumi.StringOutput

func (GetPasswordsPasswordDatabaseBranchOutput) Name 

func (o GetPasswordsPasswordDatabaseBranchOutput) Name() pulumi.StringOutput

func (GetPasswordsPasswordDatabaseBranchOutput) Production 

func (o GetPasswordsPasswordDatabaseBranchOutput) Production() pulumi.BoolOutput

func (GetPasswordsPasswordDatabaseBranchOutput) ToGetPasswordsPasswordDatabaseBranchOutput 

func (o GetPasswordsPasswordDatabaseBranchOutput) ToGetPasswordsPasswordDatabaseBranchOutput() GetPasswordsPasswordDatabaseBranchOutput

func (GetPasswordsPasswordDatabaseBranchOutput) ToGetPasswordsPasswordDatabaseBranchOutputWithContext 

func (o GetPasswordsPasswordDatabaseBranchOutput) ToGetPasswordsPasswordDatabaseBranchOutputWithContext(ctx context.Context) GetPasswordsPasswordDatabaseBranchOutput

type GetPasswordsPasswordInput 

type GetPasswordsPasswordInput interface {
	pulumi.Input

	ToGetPasswordsPasswordOutput() GetPasswordsPasswordOutput
	ToGetPasswordsPasswordOutputWithContext(context.Context) GetPasswordsPasswordOutput
}

GetPasswordsPasswordInput is an input type that accepts GetPasswordsPasswordArgs and GetPasswordsPasswordOutput values. You can construct a concrete instance of `GetPasswordsPasswordInput` via: 

GetPasswordsPasswordArgs{...}

type GetPasswordsPasswordOutput 

type GetPasswordsPasswordOutput struct{ *pulumi.OutputState }

func (GetPasswordsPasswordOutput) AccessHostUrl 

func (o GetPasswordsPasswordOutput) AccessHostUrl() pulumi.StringOutput

The host URL for the password.

func (GetPasswordsPasswordOutput) Actor 

func (o GetPasswordsPasswordOutput) Actor() GetPasswordsPasswordActorOutput

The actor that created this branch.

func (GetPasswordsPasswordOutput) Branch 

func (o GetPasswordsPasswordOutput) Branch() pulumi.StringOutput

The branch this password belongs to..

func (GetPasswordsPasswordOutput) CreatedAt 

func (o GetPasswordsPasswordOutput) CreatedAt() pulumi.StringOutput

When the password was created.

func (GetPasswordsPasswordOutput) Database 

func (o GetPasswordsPasswordOutput) Database() pulumi.StringOutput

The datanase this branch password belongs to.

func (GetPasswordsPasswordOutput) DatabaseBranch 

func (o GetPasswordsPasswordOutput) DatabaseBranch() GetPasswordsPasswordDatabaseBranchOutput

The branch this password is allowed to access.

func (GetPasswordsPasswordOutput) DeletedAt 

func (o GetPasswordsPasswordOutput) DeletedAt() pulumi.StringOutput

When the password was deleted.

func (GetPasswordsPasswordOutput) ElementType 

func (GetPasswordsPasswordOutput) ElementType() reflect.Type

func (GetPasswordsPasswordOutput) ExpiresAt 

func (o GetPasswordsPasswordOutput) ExpiresAt() pulumi.StringOutput

When the password will expire.

func (GetPasswordsPasswordOutput) Id 

func (o GetPasswordsPasswordOutput) Id() pulumi.StringOutput

The ID for the password.

func (GetPasswordsPasswordOutput) Name 

func (o GetPasswordsPasswordOutput) Name() pulumi.StringOutput

The display name for the password.

func (GetPasswordsPasswordOutput) Organization 

func (o GetPasswordsPasswordOutput) Organization() pulumi.StringOutput

The organization this database branch password belongs to.

func (GetPasswordsPasswordOutput) ReadOnlyRegionId 

func (o GetPasswordsPasswordOutput) ReadOnlyRegionId() pulumi.StringOutput

If the password is for a read-only region, the ID of the region.

func (GetPasswordsPasswordOutput) Region 

func (o GetPasswordsPasswordOutput) Region() GetPasswordsPasswordRegionOutput

The region in which this password can be used.

func (GetPasswordsPasswordOutput) Renewable 

func (o GetPasswordsPasswordOutput) Renewable() pulumi.BoolOutput

Whether or not the password can be renewed.

func (GetPasswordsPasswordOutput) Role 

func (o GetPasswordsPasswordOutput) Role() pulumi.StringOutput

The role for the password.

func (GetPasswordsPasswordOutput) ToGetPasswordsPasswordOutput 

func (o GetPasswordsPasswordOutput) ToGetPasswordsPasswordOutput() GetPasswordsPasswordOutput

func (GetPasswordsPasswordOutput) ToGetPasswordsPasswordOutputWithContext 

func (o GetPasswordsPasswordOutput) ToGetPasswordsPasswordOutputWithContext(ctx context.Context) GetPasswordsPasswordOutput

func (GetPasswordsPasswordOutput) TtlSeconds 

func (o GetPasswordsPasswordOutput) TtlSeconds() pulumi.Float64Output

Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.

func (GetPasswordsPasswordOutput) Username 

func (o GetPasswordsPasswordOutput) Username() pulumi.StringOutput

The username for the password.

type GetPasswordsPasswordRegion 

type GetPasswordsPasswordRegion struct {
	// Name of the region.
	DisplayName string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled bool `pulumi:"enabled"`
	// The ID of the region.
	Id string `pulumi:"id"`
	// Location of the region.
	Location string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug string `pulumi:"slug"`
}

type GetPasswordsPasswordRegionArgs 

type GetPasswordsPasswordRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringInput `pulumi:"slug"`
}

func (GetPasswordsPasswordRegionArgs) ElementType 

func (GetPasswordsPasswordRegionArgs) ElementType() reflect.Type

func (GetPasswordsPasswordRegionArgs) ToGetPasswordsPasswordRegionOutput 

func (i GetPasswordsPasswordRegionArgs) ToGetPasswordsPasswordRegionOutput() GetPasswordsPasswordRegionOutput

func (GetPasswordsPasswordRegionArgs) ToGetPasswordsPasswordRegionOutputWithContext 

func (i GetPasswordsPasswordRegionArgs) ToGetPasswordsPasswordRegionOutputWithContext(ctx context.Context) GetPasswordsPasswordRegionOutput

type GetPasswordsPasswordRegionInput 

type GetPasswordsPasswordRegionInput interface {
	pulumi.Input

	ToGetPasswordsPasswordRegionOutput() GetPasswordsPasswordRegionOutput
	ToGetPasswordsPasswordRegionOutputWithContext(context.Context) GetPasswordsPasswordRegionOutput
}

GetPasswordsPasswordRegionInput is an input type that accepts GetPasswordsPasswordRegionArgs and GetPasswordsPasswordRegionOutput values. You can construct a concrete instance of `GetPasswordsPasswordRegionInput` via: 

GetPasswordsPasswordRegionArgs{...}

type GetPasswordsPasswordRegionOutput 

type GetPasswordsPasswordRegionOutput struct{ *pulumi.OutputState }

func (GetPasswordsPasswordRegionOutput) DisplayName 

func (o GetPasswordsPasswordRegionOutput) DisplayName() pulumi.StringOutput

Name of the region.

func (GetPasswordsPasswordRegionOutput) ElementType 

func (GetPasswordsPasswordRegionOutput) ElementType() reflect.Type

func (GetPasswordsPasswordRegionOutput) Enabled 

func (o GetPasswordsPasswordRegionOutput) Enabled() pulumi.BoolOutput

Whether or not the region is currently active.

func (GetPasswordsPasswordRegionOutput) Id 

func (o GetPasswordsPasswordRegionOutput) Id() pulumi.StringOutput

The ID of the region.

func (GetPasswordsPasswordRegionOutput) Location 

func (o GetPasswordsPasswordRegionOutput) Location() pulumi.StringOutput

Location of the region.

func (GetPasswordsPasswordRegionOutput) Provider 

func (o GetPasswordsPasswordRegionOutput) Provider() pulumi.StringOutput

Provider for the region (ex. AWS).

func (GetPasswordsPasswordRegionOutput) PublicIpAddresses 

func (o GetPasswordsPasswordRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (GetPasswordsPasswordRegionOutput) Slug 

func (o GetPasswordsPasswordRegionOutput) Slug() pulumi.StringOutput

The slug of the region.

func (GetPasswordsPasswordRegionOutput) ToGetPasswordsPasswordRegionOutput 

func (o GetPasswordsPasswordRegionOutput) ToGetPasswordsPasswordRegionOutput() GetPasswordsPasswordRegionOutput

func (GetPasswordsPasswordRegionOutput) ToGetPasswordsPasswordRegionOutputWithContext 

func (o GetPasswordsPasswordRegionOutput) ToGetPasswordsPasswordRegionOutputWithContext(ctx context.Context) GetPasswordsPasswordRegionOutput

type GetPasswordsResult 

type GetPasswordsResult struct {
	Branch   string `pulumi:"branch"`
	Database string `pulumi:"database"`
	// The provider-assigned unique ID for this managed resource.
	Id               string                 `pulumi:"id"`
	Organization     string                 `pulumi:"organization"`
	Passwords        []GetPasswordsPassword `pulumi:"passwords"`
	ReadOnlyRegionId *string                `pulumi:"readOnlyRegionId"`
}

A collection of values returned by getPasswords.

func GetPasswords 

func GetPasswords(ctx *pulumi.Context, args *GetPasswordsArgs, opts ...pulumi.InvokeOption) (*GetPasswordsResult, error)

A list of PlanetScale database passwords.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

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
	})
}

```

type GetPasswordsResultOutput 

type GetPasswordsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPasswords.

func GetPasswordsOutput 

func GetPasswordsOutput(ctx *pulumi.Context, args GetPasswordsOutputArgs, opts ...pulumi.InvokeOption) GetPasswordsResultOutput

func (GetPasswordsResultOutput) Branch 

func (o GetPasswordsResultOutput) Branch() pulumi.StringOutput

func (GetPasswordsResultOutput) Database 

func (o GetPasswordsResultOutput) Database() pulumi.StringOutput

func (GetPasswordsResultOutput) ElementType 

func (GetPasswordsResultOutput) ElementType() reflect.Type

func (GetPasswordsResultOutput) Id 

func (o GetPasswordsResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetPasswordsResultOutput) Organization 

func (o GetPasswordsResultOutput) Organization() pulumi.StringOutput

func (GetPasswordsResultOutput) Passwords 

func (o GetPasswordsResultOutput) Passwords() GetPasswordsPasswordArrayOutput

func (GetPasswordsResultOutput) ReadOnlyRegionId 

func (o GetPasswordsResultOutput) ReadOnlyRegionId() pulumi.StringPtrOutput

func (GetPasswordsResultOutput) ToGetPasswordsResultOutput 

func (o GetPasswordsResultOutput) ToGetPasswordsResultOutput() GetPasswordsResultOutput

func (GetPasswordsResultOutput) ToGetPasswordsResultOutputWithContext 

func (o GetPasswordsResultOutput) ToGetPasswordsResultOutputWithContext(ctx context.Context) GetPasswordsResultOutput

type GetUserResult 

type GetUserResult struct {
	// The URL source of the user's avatar.
	AvatarUrl string `pulumi:"avatarUrl"`
	// When the user was created.
	CreatedAt string `pulumi:"createdAt"`
	// The default organization for the user.
	DefaultOrganizationId string `pulumi:"defaultOrganizationId"`
	// Whether or not the user is managed by a WorkOS directory.
	DirectoryManaged bool `pulumi:"directoryManaged"`
	// The display name of the user.
	DisplayName string `pulumi:"displayName"`
	// The email of the user.
	Email string `pulumi:"email"`
	// Whether or not the user is verified by email.
	EmailVerified bool `pulumi:"emailVerified"`
	// The ID of the user.
	Id string `pulumi:"id"`
	// Whether or not the user is managed by an authentication provider.
	Managed bool `pulumi:"managed"`
	// The name of the user.
	Name string `pulumi:"name"`
	// Whether or not the user is managed by WorkOS.
	Sso bool `pulumi:"sso"`
	// Whether or not the user has configured two factor authentication.
	TwoFactorAuthConfigured bool `pulumi:"twoFactorAuthConfigured"`
	// When the user was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

A collection of values returned by getUser.

func GetUser 

func GetUser(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetUserResult, error)

A PlanetScale user.

Known limitations: - Does not work when the provider is configured with a service token.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetUser(ctx, nil, nil)
		if err != nil {
			return err
		}
		ctx.Export("currentUser", example)
		return nil
	})
}

```

type GetUserResultOutput 

type GetUserResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getUser.

func GetUserOutput 

func GetUserOutput(ctx *pulumi.Context, opts ...pulumi.InvokeOption) GetUserResultOutput

func (GetUserResultOutput) AvatarUrl 

func (o GetUserResultOutput) AvatarUrl() pulumi.StringOutput

The URL source of the user's avatar.

func (GetUserResultOutput) CreatedAt 

func (o GetUserResultOutput) CreatedAt() pulumi.StringOutput

When the user was created.

func (GetUserResultOutput) DefaultOrganizationId 

func (o GetUserResultOutput) DefaultOrganizationId() pulumi.StringOutput

The default organization for the user.

func (GetUserResultOutput) DirectoryManaged 

func (o GetUserResultOutput) DirectoryManaged() pulumi.BoolOutput

Whether or not the user is managed by a WorkOS directory.

func (GetUserResultOutput) DisplayName 

func (o GetUserResultOutput) DisplayName() pulumi.StringOutput

The display name of the user.

func (GetUserResultOutput) ElementType 

func (GetUserResultOutput) ElementType() reflect.Type

func (GetUserResultOutput) Email 

func (o GetUserResultOutput) Email() pulumi.StringOutput

The email of the user.

func (GetUserResultOutput) EmailVerified 

func (o GetUserResultOutput) EmailVerified() pulumi.BoolOutput

Whether or not the user is verified by email.

func (GetUserResultOutput) Id 

func (o GetUserResultOutput) Id() pulumi.StringOutput

The ID of the user.

func (GetUserResultOutput) Managed 

func (o GetUserResultOutput) Managed() pulumi.BoolOutput

Whether or not the user is managed by an authentication provider.

func (GetUserResultOutput) Name 

func (o GetUserResultOutput) Name() pulumi.StringOutput

The name of the user.

func (GetUserResultOutput) Sso 

func (o GetUserResultOutput) Sso() pulumi.BoolOutput

Whether or not the user is managed by WorkOS.

func (GetUserResultOutput) ToGetUserResultOutput 

func (o GetUserResultOutput) ToGetUserResultOutput() GetUserResultOutput

func (GetUserResultOutput) ToGetUserResultOutputWithContext 

func (o GetUserResultOutput) ToGetUserResultOutputWithContext(ctx context.Context) GetUserResultOutput

func (GetUserResultOutput) TwoFactorAuthConfigured 

func (o GetUserResultOutput) TwoFactorAuthConfigured() pulumi.BoolOutput

Whether or not the user has configured two factor authentication.

func (GetUserResultOutput) UpdatedAt 

func (o GetUserResultOutput) UpdatedAt() pulumi.StringOutput

When the user was last updated.

type LookupBackupArgs 

type LookupBackupArgs struct {
	// The branch this backup belongs to.
	Branch string `pulumi:"branch"`
	// The database this backup belongs to.
	Database string `pulumi:"database"`
	// The ID of the backup.
	Id string `pulumi:"id"`
	// The organization this backup belongs to.
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getBackup.

type LookupBackupOutputArgs 

type LookupBackupOutputArgs struct {
	// The branch this backup belongs to.
	Branch pulumi.StringInput `pulumi:"branch"`
	// The database this backup belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// The ID of the backup.
	Id pulumi.StringInput `pulumi:"id"`
	// The organization this backup belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getBackup.

func (LookupBackupOutputArgs) ElementType 

func (LookupBackupOutputArgs) ElementType() reflect.Type

type LookupBackupResult 

type LookupBackupResult struct {
	// The actor that created the backup.
	Actor GetBackupActor `pulumi:"actor"`
	// The backup policy being followed.
	BackupPolicy GetBackupBackupPolicy `pulumi:"backupPolicy"`
	// The branch this backup belongs to.
	Branch string `pulumi:"branch"`
	// When the backup was created.
	CreatedAt string `pulumi:"createdAt"`
	// The database this backup belongs to.
	Database string `pulumi:"database"`
	// The estimated storage cost of the backup.
	EstimatedStorageCost string `pulumi:"estimatedStorageCost"`
	// The ID of the backup.
	Id string `pulumi:"id"`
	// The name of the backup.
	Name string `pulumi:"name"`
	// The organization this backup belongs to.
	Organization string `pulumi:"organization"`
	// Whether or not the backup policy is required.
	Required bool `pulumi:"required"`
	// Branches that have been restored with this backup.
	RestoredBranches []string `pulumi:"restoredBranches"`
	// The size of the backup.
	Size float64 `pulumi:"size"`
	// The current state of the backup.
	State string `pulumi:"state"`
	// When the backup was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

A collection of values returned by getBackup.

func LookupBackup 

func LookupBackup(ctx *pulumi.Context, args *LookupBackupArgs, opts ...pulumi.InvokeOption) (*LookupBackupResult, error)

A PlanetScale backup.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.LookupBackup(ctx, &planetscale.LookupBackupArgs{
			Organization: "example.com",
			Database:     "example_db",
			Branch:       "main",
			Id:           "k20nb1b7ut18",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("backup", example)
		return nil
	})
}

```

type LookupBackupResultOutput 

type LookupBackupResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBackup.

func LookupBackupOutput 

func LookupBackupOutput(ctx *pulumi.Context, args LookupBackupOutputArgs, opts ...pulumi.InvokeOption) LookupBackupResultOutput

func (LookupBackupResultOutput) Actor 

func (o LookupBackupResultOutput) Actor() GetBackupActorOutput

The actor that created the backup.

func (LookupBackupResultOutput) BackupPolicy 

func (o LookupBackupResultOutput) BackupPolicy() GetBackupBackupPolicyOutput

The backup policy being followed.

func (LookupBackupResultOutput) Branch 

func (o LookupBackupResultOutput) Branch() pulumi.StringOutput

The branch this backup belongs to.

func (LookupBackupResultOutput) CreatedAt 

func (o LookupBackupResultOutput) CreatedAt() pulumi.StringOutput

When the backup was created.

func (LookupBackupResultOutput) Database 

func (o LookupBackupResultOutput) Database() pulumi.StringOutput

The database this backup belongs to.

func (LookupBackupResultOutput) ElementType 

func (LookupBackupResultOutput) ElementType() reflect.Type

func (LookupBackupResultOutput) EstimatedStorageCost 

func (o LookupBackupResultOutput) EstimatedStorageCost() pulumi.StringOutput

The estimated storage cost of the backup.

func (LookupBackupResultOutput) Id 

func (o LookupBackupResultOutput) Id() pulumi.StringOutput

The ID of the backup.

func (LookupBackupResultOutput) Name 

func (o LookupBackupResultOutput) Name() pulumi.StringOutput

The name of the backup.

func (LookupBackupResultOutput) Organization 

func (o LookupBackupResultOutput) Organization() pulumi.StringOutput

The organization this backup belongs to.

func (LookupBackupResultOutput) Required 

func (o LookupBackupResultOutput) Required() pulumi.BoolOutput

Whether or not the backup policy is required.

func (LookupBackupResultOutput) RestoredBranches 

func (o LookupBackupResultOutput) RestoredBranches() pulumi.StringArrayOutput

Branches that have been restored with this backup.

func (LookupBackupResultOutput) Size 

func (o LookupBackupResultOutput) Size() pulumi.Float64Output

The size of the backup.

func (LookupBackupResultOutput) State 

func (o LookupBackupResultOutput) State() pulumi.StringOutput

The current state of the backup.

func (LookupBackupResultOutput) ToLookupBackupResultOutput 

func (o LookupBackupResultOutput) ToLookupBackupResultOutput() LookupBackupResultOutput

func (LookupBackupResultOutput) ToLookupBackupResultOutputWithContext 

func (o LookupBackupResultOutput) ToLookupBackupResultOutputWithContext(ctx context.Context) LookupBackupResultOutput

func (LookupBackupResultOutput) UpdatedAt 

func (o LookupBackupResultOutput) UpdatedAt() pulumi.StringOutput

When the backup was last updated.

type LookupBranchArgs 

type LookupBranchArgs struct {
	// The database this branch belongs to.
	Database string `pulumi:"database"`
	// The name of the branch.
	Name string `pulumi:"name"`
	// The organization this branch belongs to.
	Organization string `pulumi:"organization"`
}

A collection of arguments for invoking getBranch.

type LookupBranchOutputArgs 

type LookupBranchOutputArgs struct {
	// The database this branch belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// The name of the branch.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this branch belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
}

A collection of arguments for invoking getBranch.

func (LookupBranchOutputArgs) ElementType 

func (LookupBranchOutputArgs) ElementType() reflect.Type

type LookupBranchResult 

type LookupBranchResult struct {
	// The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.
	AccessHostUrl string `pulumi:"accessHostUrl"`
	// The actor who created this branch.
	Actor GetBranchActor `pulumi:"actor"`
	// The SKU representing the branch's cluster size.
	ClusterRateName string `pulumi:"clusterRateName"`
	// When the branch was created.
	CreatedAt string `pulumi:"createdAt"`
	// The database this branch belongs to.
	Database string `pulumi:"database"`
	// Planetscale app URL for the branch.
	HtmlUrl string `pulumi:"htmlUrl"`
	// The ID of the branch.
	Id string `pulumi:"id"`
	// The ID of the backup from which the branch was restored.
	InitialRestoreId string `pulumi:"initialRestoreId"`
	// The MySQL address for the branch.
	MysqlAddress string `pulumi:"mysqlAddress"`
	// The address of the MySQL provider for the branch.
	MysqlEdgeAddress string `pulumi:"mysqlEdgeAddress"`
	// The name of the branch.
	Name string `pulumi:"name"`
	// The organization this branch belongs to.
	Organization string `pulumi:"organization"`
	// The name of the parent branch from which the branch was created.
	ParentBranch string `pulumi:"parentBranch"`
	// Whether or not the branch is a production branch.
	Production bool `pulumi:"production"`
	// Whether or not the branch is ready to serve queries.
	Ready bool `pulumi:"ready"`
	// The region in which this branch lives.
	Region GetBranchRegion `pulumi:"region"`
	// When a user last marked a backup restore checklist as completed.
	RestoreChecklistCompletedAt string                      `pulumi:"restoreChecklistCompletedAt"`
	RestoredFromBranch          GetBranchRestoredFromBranch `pulumi:"restoredFromBranch"`
	// When the schema for the branch was last updated.
	SchemaLastUpdatedAt string `pulumi:"schemaLastUpdatedAt"`
	// The number of shards in the branch.
	ShardCount float64 `pulumi:"shardCount"`
	// Whether or not the branch is sharded.
	Sharded bool `pulumi:"sharded"`
	// When the branch was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
}

A collection of values returned by getBranch.

func LookupBranch 

func LookupBranch(ctx *pulumi.Context, args *LookupBranchArgs, opts ...pulumi.InvokeOption) (*LookupBranchResult, error)

A PlanetScale branch.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.LookupBranch(ctx, &planetscale.LookupBranchArgs{
			Organization: "example.com",
			Database:     "example_db",
			Name:         "main",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("branch", example)
		return nil
	})
}

```

type LookupBranchResultOutput 

type LookupBranchResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getBranch.

func LookupBranchOutput 

func LookupBranchOutput(ctx *pulumi.Context, args LookupBranchOutputArgs, opts ...pulumi.InvokeOption) LookupBranchResultOutput

func (LookupBranchResultOutput) AccessHostUrl 

func (o LookupBranchResultOutput) AccessHostUrl() pulumi.StringOutput

The access host URL for the branch. This is a legacy field, use `mysqlEdgeAddress`.

func (LookupBranchResultOutput) Actor 

func (o LookupBranchResultOutput) Actor() GetBranchActorOutput

The actor who created this branch.

func (LookupBranchResultOutput) ClusterRateName 

func (o LookupBranchResultOutput) ClusterRateName() pulumi.StringOutput

The SKU representing the branch's cluster size.

func (LookupBranchResultOutput) CreatedAt 

func (o LookupBranchResultOutput) CreatedAt() pulumi.StringOutput

When the branch was created.

func (LookupBranchResultOutput) Database 

func (o LookupBranchResultOutput) Database() pulumi.StringOutput

The database this branch belongs to.

func (LookupBranchResultOutput) ElementType 

func (LookupBranchResultOutput) ElementType() reflect.Type

func (LookupBranchResultOutput) HtmlUrl 

func (o LookupBranchResultOutput) HtmlUrl() pulumi.StringOutput

Planetscale app URL for the branch.

func (LookupBranchResultOutput) Id 

func (o LookupBranchResultOutput) Id() pulumi.StringOutput

The ID of the branch.

func (LookupBranchResultOutput) InitialRestoreId 

func (o LookupBranchResultOutput) InitialRestoreId() pulumi.StringOutput

The ID of the backup from which the branch was restored.

func (LookupBranchResultOutput) MysqlAddress 

func (o LookupBranchResultOutput) MysqlAddress() pulumi.StringOutput

The MySQL address for the branch.

func (LookupBranchResultOutput) MysqlEdgeAddress 

func (o LookupBranchResultOutput) MysqlEdgeAddress() pulumi.StringOutput

The address of the MySQL provider for the branch.

func (LookupBranchResultOutput) Name 

func (o LookupBranchResultOutput) Name() pulumi.StringOutput

The name of the branch.

func (LookupBranchResultOutput) Organization 

func (o LookupBranchResultOutput) Organization() pulumi.StringOutput

The organization this branch belongs to.

func (LookupBranchResultOutput) ParentBranch 

func (o LookupBranchResultOutput) ParentBranch() pulumi.StringOutput

The name of the parent branch from which the branch was created.

func (LookupBranchResultOutput) Production 

func (o LookupBranchResultOutput) Production() pulumi.BoolOutput

Whether or not the branch is a production branch.

func (LookupBranchResultOutput) Ready 

func (o LookupBranchResultOutput) Ready() pulumi.BoolOutput

Whether or not the branch is ready to serve queries.

func (LookupBranchResultOutput) Region 

func (o LookupBranchResultOutput) Region() GetBranchRegionOutput

The region in which this branch lives.

func (LookupBranchResultOutput) RestoreChecklistCompletedAt 

func (o LookupBranchResultOutput) RestoreChecklistCompletedAt() pulumi.StringOutput

When a user last marked a backup restore checklist as completed.

func (LookupBranchResultOutput) RestoredFromBranch 

func (o LookupBranchResultOutput) RestoredFromBranch() GetBranchRestoredFromBranchOutput

func (LookupBranchResultOutput) SchemaLastUpdatedAt 

func (o LookupBranchResultOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the schema for the branch was last updated.

func (LookupBranchResultOutput) ShardCount 

func (o LookupBranchResultOutput) ShardCount() pulumi.Float64Output

The number of shards in the branch.

func (LookupBranchResultOutput) Sharded 

func (o LookupBranchResultOutput) Sharded() pulumi.BoolOutput

Whether or not the branch is sharded.

func (LookupBranchResultOutput) ToLookupBranchResultOutput 

func (o LookupBranchResultOutput) ToLookupBranchResultOutput() LookupBranchResultOutput

func (LookupBranchResultOutput) ToLookupBranchResultOutputWithContext 

func (o LookupBranchResultOutput) ToLookupBranchResultOutputWithContext(ctx context.Context) LookupBranchResultOutput

func (LookupBranchResultOutput) UpdatedAt 

func (o LookupBranchResultOutput) UpdatedAt() pulumi.StringOutput

When the branch was last updated.

type LookupDatabaseArgs 

type LookupDatabaseArgs struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching *bool `pulumi:"allowDataBranching"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations *bool `pulumi:"automaticMigrations"`
	// If the database was created from an import, describes the import process.
	DataImport *GetDatabaseDataImport `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch *string `pulumi:"defaultBranch"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries *bool `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount *float64 `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework *string `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName *string `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion *bool `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name string `pulumi:"name"`
	// The organization this database belongs to.
	Organization string `pulumi:"organization"`
	// The database plan.
	Plan *string `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole *bool `pulumi:"productionBranchWebConsole"`
	// The region the database lives in.
	Region *GetDatabaseRegion `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy *bool `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion *bool `pulumi:"restrictBranchRegion"`
}

A collection of arguments for invoking getDatabase.

type LookupDatabaseOutputArgs 

type LookupDatabaseOutputArgs struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching pulumi.BoolPtrInput `pulumi:"allowDataBranching"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations pulumi.BoolPtrInput `pulumi:"automaticMigrations"`
	// If the database was created from an import, describes the import process.
	DataImport GetDatabaseDataImportPtrInput `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch pulumi.StringPtrInput `pulumi:"defaultBranch"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries pulumi.BoolPtrInput `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount pulumi.Float64PtrInput `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework pulumi.StringPtrInput `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName pulumi.StringPtrInput `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion pulumi.BoolPtrInput `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name pulumi.StringInput `pulumi:"name"`
	// The organization this database belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// The database plan.
	Plan pulumi.StringPtrInput `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole pulumi.BoolPtrInput `pulumi:"productionBranchWebConsole"`
	// The region the database lives in.
	Region GetDatabaseRegionPtrInput `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy pulumi.BoolPtrInput `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion pulumi.BoolPtrInput `pulumi:"restrictBranchRegion"`
}

A collection of arguments for invoking getDatabase.

func (LookupDatabaseOutputArgs) ElementType 

func (LookupDatabaseOutputArgs) ElementType() reflect.Type

type LookupDatabaseResult 

type LookupDatabaseResult struct {
	// Whether seeding branches with data is enabled for all branches.
	AllowDataBranching bool `pulumi:"allowDataBranching"`
	// If the database has reached its backup restored branch limit.
	AtBackupRestoreBranchesLimit bool `pulumi:"atBackupRestoreBranchesLimit"`
	// If the database has reached its development branch limit.
	AtDevelopmentBranchLimit bool `pulumi:"atDevelopmentBranchLimit"`
	// Whether to automatically manage Rails migrations during deploy requests.
	AutomaticMigrations bool `pulumi:"automaticMigrations"`
	// The total number of database branches.
	BranchesCount float64 `pulumi:"branchesCount"`
	// The URL to retrieve this database's branches via the API.
	BranchesUrl string `pulumi:"branchesUrl"`
	// When the database was created.
	CreatedAt string `pulumi:"createdAt"`
	// If the database was created from an import, describes the import process.
	DataImport *GetDatabaseDataImport `pulumi:"dataImport"`
	// The default branch for the database.
	DefaultBranch string `pulumi:"defaultBranch"`
	// Number of read only regions in the default branch.
	DefaultBranchReadOnlyRegionsCount float64 `pulumi:"defaultBranchReadOnlyRegionsCount"`
	// Number of shards in the default branch.
	DefaultBranchShardCount float64 `pulumi:"defaultBranchShardCount"`
	// Number of tables in the default branch schema.
	DefaultBranchTableCount float64 `pulumi:"defaultBranchTableCount"`
	// The total number of database development branches.
	DevelopmentBranchesCount float64 `pulumi:"developmentBranchesCount"`
	// The total number of database development branches.
	HtmlUrl string `pulumi:"htmlUrl"`
	// The ID of the database.
	Id string `pulumi:"id"`
	// The URL to see this database's branches in the web UI.
	InsightsRawQueries bool `pulumi:"insightsRawQueries"`
	// The total number of ongoing issues within a database.
	IssuesCount float64 `pulumi:"issuesCount"`
	// Framework used for applying migrations.
	MigrationFramework string `pulumi:"migrationFramework"`
	// Table name to use for copying schema migration data.
	MigrationTableName string `pulumi:"migrationTableName"`
	// If the database requires multiple admins for deletion.
	MultipleAdminsRequiredForDeletion bool `pulumi:"multipleAdminsRequiredForDeletion"`
	// The name of this database.
	Name string `pulumi:"name"`
	// The organization this database belongs to.
	Organization string `pulumi:"organization"`
	// The database plan.
	Plan string `pulumi:"plan"`
	// Whether web console is enabled for production branches.
	ProductionBranchWebConsole bool `pulumi:"productionBranchWebConsole"`
	// The total number of database production branches.
	ProductionBranchesCount float64 `pulumi:"productionBranchesCount"`
	// If the database is ready to be used.
	Ready bool `pulumi:"ready"`
	// The region the database lives in.
	Region GetDatabaseRegion `pulumi:"region"`
	// Whether an approval is required to deploy schema changes to this database.
	RequireApprovalForDeploy bool `pulumi:"requireApprovalForDeploy"`
	// Whether to restrict branch creation to one region.
	RestrictBranchRegion bool `pulumi:"restrictBranchRegion"`
	// When the default branch schema was last changed.
	SchemaLastUpdatedAt string `pulumi:"schemaLastUpdatedAt"`
	// If the database is sharded.
	Sharded bool `pulumi:"sharded"`
	// State of the database.
	State string `pulumi:"state"`
	// When the database was last updated.
	UpdatedAt string `pulumi:"updatedAt"`
	// The URL to the database API endpoint.
	Url string `pulumi:"url"`
}

A collection of values returned by getDatabase.

func LookupDatabase 

func LookupDatabase(ctx *pulumi.Context, args *LookupDatabaseArgs, opts ...pulumi.InvokeOption) (*LookupDatabaseResult, error)

A PlanetScale database.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.LookupDatabase(ctx, &planetscale.LookupDatabaseArgs{
			Organization: "example",
			Name:         "again",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("db", example)
		return nil
	})
}

```

type LookupDatabaseResultOutput 

type LookupDatabaseResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getDatabase.

func LookupDatabaseOutput 

func LookupDatabaseOutput(ctx *pulumi.Context, args LookupDatabaseOutputArgs, opts ...pulumi.InvokeOption) LookupDatabaseResultOutput

func (LookupDatabaseResultOutput) AllowDataBranching 

func (o LookupDatabaseResultOutput) AllowDataBranching() pulumi.BoolOutput

Whether seeding branches with data is enabled for all branches.

func (LookupDatabaseResultOutput) AtBackupRestoreBranchesLimit 

func (o LookupDatabaseResultOutput) AtBackupRestoreBranchesLimit() pulumi.BoolOutput

If the database has reached its backup restored branch limit.

func (LookupDatabaseResultOutput) AtDevelopmentBranchLimit 

func (o LookupDatabaseResultOutput) AtDevelopmentBranchLimit() pulumi.BoolOutput

If the database has reached its development branch limit.

func (LookupDatabaseResultOutput) AutomaticMigrations 

func (o LookupDatabaseResultOutput) AutomaticMigrations() pulumi.BoolOutput

Whether to automatically manage Rails migrations during deploy requests.

func (LookupDatabaseResultOutput) BranchesCount 

func (o LookupDatabaseResultOutput) BranchesCount() pulumi.Float64Output

The total number of database branches.

func (LookupDatabaseResultOutput) BranchesUrl 

func (o LookupDatabaseResultOutput) BranchesUrl() pulumi.StringOutput

The URL to retrieve this database's branches via the API.

func (LookupDatabaseResultOutput) CreatedAt 

func (o LookupDatabaseResultOutput) CreatedAt() pulumi.StringOutput

When the database was created.

func (LookupDatabaseResultOutput) DataImport 

func (o LookupDatabaseResultOutput) DataImport() GetDatabaseDataImportPtrOutput

If the database was created from an import, describes the import process.

func (LookupDatabaseResultOutput) DefaultBranch 

func (o LookupDatabaseResultOutput) DefaultBranch() pulumi.StringOutput

The default branch for the database.

func (LookupDatabaseResultOutput) DefaultBranchReadOnlyRegionsCount 

func (o LookupDatabaseResultOutput) DefaultBranchReadOnlyRegionsCount() pulumi.Float64Output

Number of read only regions in the default branch.

func (LookupDatabaseResultOutput) DefaultBranchShardCount 

func (o LookupDatabaseResultOutput) DefaultBranchShardCount() pulumi.Float64Output

Number of shards in the default branch.

func (LookupDatabaseResultOutput) DefaultBranchTableCount 

func (o LookupDatabaseResultOutput) DefaultBranchTableCount() pulumi.Float64Output

Number of tables in the default branch schema.

func (LookupDatabaseResultOutput) DevelopmentBranchesCount 

func (o LookupDatabaseResultOutput) DevelopmentBranchesCount() pulumi.Float64Output

The total number of database development branches.

func (LookupDatabaseResultOutput) ElementType 

func (LookupDatabaseResultOutput) ElementType() reflect.Type

func (LookupDatabaseResultOutput) HtmlUrl 

func (o LookupDatabaseResultOutput) HtmlUrl() pulumi.StringOutput

The total number of database development branches.

func (LookupDatabaseResultOutput) Id 

func (o LookupDatabaseResultOutput) Id() pulumi.StringOutput

The ID of the database.

func (LookupDatabaseResultOutput) InsightsRawQueries 

func (o LookupDatabaseResultOutput) InsightsRawQueries() pulumi.BoolOutput

The URL to see this database's branches in the web UI.

func (LookupDatabaseResultOutput) IssuesCount 

func (o LookupDatabaseResultOutput) IssuesCount() pulumi.Float64Output

The total number of ongoing issues within a database.

func (LookupDatabaseResultOutput) MigrationFramework 

func (o LookupDatabaseResultOutput) MigrationFramework() pulumi.StringOutput

Framework used for applying migrations.

func (LookupDatabaseResultOutput) MigrationTableName 

func (o LookupDatabaseResultOutput) MigrationTableName() pulumi.StringOutput

Table name to use for copying schema migration data.

func (LookupDatabaseResultOutput) MultipleAdminsRequiredForDeletion 

func (o LookupDatabaseResultOutput) MultipleAdminsRequiredForDeletion() pulumi.BoolOutput

If the database requires multiple admins for deletion.

func (LookupDatabaseResultOutput) Name 

func (o LookupDatabaseResultOutput) Name() pulumi.StringOutput

The name of this database.

func (LookupDatabaseResultOutput) Organization 

func (o LookupDatabaseResultOutput) Organization() pulumi.StringOutput

The organization this database belongs to.

func (LookupDatabaseResultOutput) Plan 

func (o LookupDatabaseResultOutput) Plan() pulumi.StringOutput

The database plan.

func (LookupDatabaseResultOutput) ProductionBranchWebConsole 

func (o LookupDatabaseResultOutput) ProductionBranchWebConsole() pulumi.BoolOutput

Whether web console is enabled for production branches.

func (LookupDatabaseResultOutput) ProductionBranchesCount 

func (o LookupDatabaseResultOutput) ProductionBranchesCount() pulumi.Float64Output

The total number of database production branches.

func (LookupDatabaseResultOutput) Ready 

func (o LookupDatabaseResultOutput) Ready() pulumi.BoolOutput

If the database is ready to be used.

func (LookupDatabaseResultOutput) Region 

func (o LookupDatabaseResultOutput) Region() GetDatabaseRegionOutput

The region the database lives in.

func (LookupDatabaseResultOutput) RequireApprovalForDeploy 

func (o LookupDatabaseResultOutput) RequireApprovalForDeploy() pulumi.BoolOutput

Whether an approval is required to deploy schema changes to this database.

func (LookupDatabaseResultOutput) RestrictBranchRegion 

func (o LookupDatabaseResultOutput) RestrictBranchRegion() pulumi.BoolOutput

Whether to restrict branch creation to one region.

func (LookupDatabaseResultOutput) SchemaLastUpdatedAt 

func (o LookupDatabaseResultOutput) SchemaLastUpdatedAt() pulumi.StringOutput

When the default branch schema was last changed.

func (LookupDatabaseResultOutput) Sharded 

func (o LookupDatabaseResultOutput) Sharded() pulumi.BoolOutput

If the database is sharded.

func (LookupDatabaseResultOutput) State 

func (o LookupDatabaseResultOutput) State() pulumi.StringOutput

State of the database.

func (LookupDatabaseResultOutput) ToLookupDatabaseResultOutput 

func (o LookupDatabaseResultOutput) ToLookupDatabaseResultOutput() LookupDatabaseResultOutput

func (LookupDatabaseResultOutput) ToLookupDatabaseResultOutputWithContext 

func (o LookupDatabaseResultOutput) ToLookupDatabaseResultOutputWithContext(ctx context.Context) LookupDatabaseResultOutput

func (LookupDatabaseResultOutput) UpdatedAt 

func (o LookupDatabaseResultOutput) UpdatedAt() pulumi.StringOutput

When the database was last updated.

func (LookupDatabaseResultOutput) Url 

func (o LookupDatabaseResultOutput) Url() pulumi.StringOutput

The URL to the database API endpoint.

type LookupPasswordArgs 

type LookupPasswordArgs struct {
	// The branch this password belongs to..
	Branch string `pulumi:"branch"`
	// The datanase this branch password belongs to.
	Database string `pulumi:"database"`
	// The ID for the password.
	Id string `pulumi:"id"`
	// The organization this database branch password belongs to.
	Organization string `pulumi:"organization"`
	// If the password is for a read-only region, the ID of the region.
	ReadOnlyRegionId *string `pulumi:"readOnlyRegionId"`
}

A collection of arguments for invoking getPassword.

type LookupPasswordOutputArgs 

type LookupPasswordOutputArgs struct {
	// The branch this password belongs to..
	Branch pulumi.StringInput `pulumi:"branch"`
	// The datanase this branch password belongs to.
	Database pulumi.StringInput `pulumi:"database"`
	// The ID for the password.
	Id pulumi.StringInput `pulumi:"id"`
	// The organization this database branch password belongs to.
	Organization pulumi.StringInput `pulumi:"organization"`
	// If the password is for a read-only region, the ID of the region.
	ReadOnlyRegionId pulumi.StringPtrInput `pulumi:"readOnlyRegionId"`
}

A collection of arguments for invoking getPassword.

func (LookupPasswordOutputArgs) ElementType 

func (LookupPasswordOutputArgs) ElementType() reflect.Type

type LookupPasswordResult 

type LookupPasswordResult struct {
	// The host URL for the password.
	AccessHostUrl string `pulumi:"accessHostUrl"`
	// The actor that created this branch.
	Actor GetPasswordActor `pulumi:"actor"`
	// The branch this password belongs to..
	Branch string `pulumi:"branch"`
	// When the password was created.
	CreatedAt string `pulumi:"createdAt"`
	// The datanase this branch password belongs to.
	Database string `pulumi:"database"`
	// The branch this password is allowed to access.
	DatabaseBranch GetPasswordDatabaseBranch `pulumi:"databaseBranch"`
	// When the password was deleted.
	DeletedAt string `pulumi:"deletedAt"`
	// When the password will expire.
	ExpiresAt string `pulumi:"expiresAt"`
	// The ID for the password.
	Id string `pulumi:"id"`
	// The display name for the password.
	Name string `pulumi:"name"`
	// The organization this database branch password belongs to.
	Organization string `pulumi:"organization"`
	// If the password is for a read-only region, the ID of the region.
	ReadOnlyRegionId *string `pulumi:"readOnlyRegionId"`
	// The region in which this password can be used.
	Region GetPasswordRegion `pulumi:"region"`
	// Whether or not the password can be renewed.
	Renewable bool `pulumi:"renewable"`
	// The role for the password.
	Role string `pulumi:"role"`
	// Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
	TtlSeconds float64 `pulumi:"ttlSeconds"`
	// The username for the password.
	Username string `pulumi:"username"`
}

A collection of values returned by getPassword.

func LookupPassword 

func LookupPassword(ctx *pulumi.Context, args *LookupPasswordArgs, opts ...pulumi.InvokeOption) (*LookupPasswordResult, error)

A PlanetScale database password.

type LookupPasswordResultOutput 

type LookupPasswordResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getPassword.

func LookupPasswordOutput 

func LookupPasswordOutput(ctx *pulumi.Context, args LookupPasswordOutputArgs, opts ...pulumi.InvokeOption) LookupPasswordResultOutput

func (LookupPasswordResultOutput) AccessHostUrl 

func (o LookupPasswordResultOutput) AccessHostUrl() pulumi.StringOutput

The host URL for the password.

func (LookupPasswordResultOutput) Actor 

func (o LookupPasswordResultOutput) Actor() GetPasswordActorOutput

The actor that created this branch.

func (LookupPasswordResultOutput) Branch 

func (o LookupPasswordResultOutput) Branch() pulumi.StringOutput

The branch this password belongs to..

func (LookupPasswordResultOutput) CreatedAt 

func (o LookupPasswordResultOutput) CreatedAt() pulumi.StringOutput

When the password was created.

func (LookupPasswordResultOutput) Database 

func (o LookupPasswordResultOutput) Database() pulumi.StringOutput

The datanase this branch password belongs to.

func (LookupPasswordResultOutput) DatabaseBranch 

func (o LookupPasswordResultOutput) DatabaseBranch() GetPasswordDatabaseBranchOutput

The branch this password is allowed to access.

func (LookupPasswordResultOutput) DeletedAt 

func (o LookupPasswordResultOutput) DeletedAt() pulumi.StringOutput

When the password was deleted.

func (LookupPasswordResultOutput) ElementType 

func (LookupPasswordResultOutput) ElementType() reflect.Type

func (LookupPasswordResultOutput) ExpiresAt 

func (o LookupPasswordResultOutput) ExpiresAt() pulumi.StringOutput

When the password will expire.

func (LookupPasswordResultOutput) Id 

func (o LookupPasswordResultOutput) Id() pulumi.StringOutput

The ID for the password.

func (LookupPasswordResultOutput) Name 

func (o LookupPasswordResultOutput) Name() pulumi.StringOutput

The display name for the password.

func (LookupPasswordResultOutput) Organization 

func (o LookupPasswordResultOutput) Organization() pulumi.StringOutput

The organization this database branch password belongs to.

func (LookupPasswordResultOutput) ReadOnlyRegionId 

func (o LookupPasswordResultOutput) ReadOnlyRegionId() pulumi.StringPtrOutput

If the password is for a read-only region, the ID of the region.

func (LookupPasswordResultOutput) Region 

func (o LookupPasswordResultOutput) Region() GetPasswordRegionOutput

The region in which this password can be used.

func (LookupPasswordResultOutput) Renewable 

func (o LookupPasswordResultOutput) Renewable() pulumi.BoolOutput

Whether or not the password can be renewed.

func (LookupPasswordResultOutput) Role 

func (o LookupPasswordResultOutput) Role() pulumi.StringOutput

The role for the password.

func (LookupPasswordResultOutput) ToLookupPasswordResultOutput 

func (o LookupPasswordResultOutput) ToLookupPasswordResultOutput() LookupPasswordResultOutput

func (LookupPasswordResultOutput) ToLookupPasswordResultOutputWithContext 

func (o LookupPasswordResultOutput) ToLookupPasswordResultOutputWithContext(ctx context.Context) LookupPasswordResultOutput

func (LookupPasswordResultOutput) TtlSeconds 

func (o LookupPasswordResultOutput) TtlSeconds() pulumi.Float64Output

Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.

func (LookupPasswordResultOutput) Username 

func (o LookupPasswordResultOutput) Username() pulumi.StringOutput

The username for the password.

type Password 

type Password struct {
	pulumi.CustomResourceState

	// The host URL for the password.
	AccessHostUrl pulumi.StringOutput `pulumi:"accessHostUrl"`
	// The actor that created this branch.
	Actor PasswordActorOutput `pulumi:"actor"`
	// The branch this password belongs to.
	Branch pulumi.StringOutput `pulumi:"branch"`
	// When the password was created.
	CreatedAt pulumi.StringOutput `pulumi:"createdAt"`
	// The datanase this branch password belongs to.
	Database pulumi.StringOutput `pulumi:"database"`
	// The branch this password is allowed to access.
	DatabaseBranch PasswordDatabaseBranchOutput `pulumi:"databaseBranch"`
	// When the password was deleted.
	DeletedAt pulumi.StringOutput `pulumi:"deletedAt"`
	// When the password will expire.
	ExpiresAt pulumi.StringOutput `pulumi:"expiresAt"`
	// The display name for the password.
	Name pulumi.StringOutput `pulumi:"name"`
	// The organization this database branch password belongs to.
	Organization pulumi.StringOutput `pulumi:"organization"`
	// The plaintext password, only available if the password was created by this provider.
	Plaintext pulumi.StringOutput `pulumi:"plaintext"`
	// The region in which this password can be used.
	Region PasswordRegionOutput `pulumi:"region"`
	// Whether or not the password can be renewed.
	Renewable pulumi.BoolOutput `pulumi:"renewable"`
	// The role for the password.
	Role pulumi.StringOutput `pulumi:"role"`
	// Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
	TtlSeconds pulumi.Float64Output `pulumi:"ttlSeconds"`
	// The username for the password.
	Username pulumi.StringOutput `pulumi:"username"`
}

A PlanetScale database password.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/sst/pulumi-planetscale/sdk/go/planetscale"

) 

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

```

func GetPassword 

func GetPassword(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PasswordState, opts ...pulumi.ResourceOption) (*Password, error)

GetPassword gets an existing Password resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPassword 

func NewPassword(ctx *pulumi.Context,
	name string, args *PasswordArgs, opts ...pulumi.ResourceOption) (*Password, error)

NewPassword registers a new resource with the given unique name, arguments, and options.

func (*Password) ElementType 

func (*Password) ElementType() reflect.Type

func (*Password) ToPasswordOutput 

func (i *Password) ToPasswordOutput() PasswordOutput

func (*Password) ToPasswordOutputWithContext 

func (i *Password) ToPasswordOutputWithContext(ctx context.Context) PasswordOutput

type PasswordActor 

type PasswordActor struct {
	// The URL of the actor's avatar
	AvatarUrl *string `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName *string `pulumi:"displayName"`
	// The ID of the actor
	Id *string `pulumi:"id"`
}

type PasswordActorArgs 

type PasswordActorArgs struct {
	// The URL of the actor's avatar
	AvatarUrl pulumi.StringPtrInput `pulumi:"avatarUrl"`
	// The name of the actor
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// The ID of the actor
	Id pulumi.StringPtrInput `pulumi:"id"`
}

func (PasswordActorArgs) ElementType 

func (PasswordActorArgs) ElementType() reflect.Type

func (PasswordActorArgs) ToPasswordActorOutput 

func (i PasswordActorArgs) ToPasswordActorOutput() PasswordActorOutput

func (PasswordActorArgs) ToPasswordActorOutputWithContext 

func (i PasswordActorArgs) ToPasswordActorOutputWithContext(ctx context.Context) PasswordActorOutput

func (PasswordActorArgs) ToPasswordActorPtrOutput 

func (i PasswordActorArgs) ToPasswordActorPtrOutput() PasswordActorPtrOutput

func (PasswordActorArgs) ToPasswordActorPtrOutputWithContext 

func (i PasswordActorArgs) ToPasswordActorPtrOutputWithContext(ctx context.Context) PasswordActorPtrOutput

type PasswordActorInput 

type PasswordActorInput interface {
	pulumi.Input

	ToPasswordActorOutput() PasswordActorOutput
	ToPasswordActorOutputWithContext(context.Context) PasswordActorOutput
}

PasswordActorInput is an input type that accepts PasswordActorArgs and PasswordActorOutput values. You can construct a concrete instance of `PasswordActorInput` via: 

PasswordActorArgs{...}

type PasswordActorOutput 

type PasswordActorOutput struct{ *pulumi.OutputState }

func (PasswordActorOutput) AvatarUrl 

func (o PasswordActorOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (PasswordActorOutput) DisplayName 

func (o PasswordActorOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (PasswordActorOutput) ElementType 

func (PasswordActorOutput) ElementType() reflect.Type

func (PasswordActorOutput) Id 

func (o PasswordActorOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (PasswordActorOutput) ToPasswordActorOutput 

func (o PasswordActorOutput) ToPasswordActorOutput() PasswordActorOutput

func (PasswordActorOutput) ToPasswordActorOutputWithContext 

func (o PasswordActorOutput) ToPasswordActorOutputWithContext(ctx context.Context) PasswordActorOutput

func (PasswordActorOutput) ToPasswordActorPtrOutput 

func (o PasswordActorOutput) ToPasswordActorPtrOutput() PasswordActorPtrOutput

func (PasswordActorOutput) ToPasswordActorPtrOutputWithContext 

func (o PasswordActorOutput) ToPasswordActorPtrOutputWithContext(ctx context.Context) PasswordActorPtrOutput

type PasswordActorPtrInput 

type PasswordActorPtrInput interface {
	pulumi.Input

	ToPasswordActorPtrOutput() PasswordActorPtrOutput
	ToPasswordActorPtrOutputWithContext(context.Context) PasswordActorPtrOutput
}

PasswordActorPtrInput is an input type that accepts PasswordActorArgs, PasswordActorPtr and PasswordActorPtrOutput values. You can construct a concrete instance of `PasswordActorPtrInput` via: 

        PasswordActorArgs{...}

or:

        nil

func PasswordActorPtr 

func PasswordActorPtr(v *PasswordActorArgs) PasswordActorPtrInput

type PasswordActorPtrOutput 

type PasswordActorPtrOutput struct{ *pulumi.OutputState }

func (PasswordActorPtrOutput) AvatarUrl 

func (o PasswordActorPtrOutput) AvatarUrl() pulumi.StringPtrOutput

The URL of the actor's avatar

func (PasswordActorPtrOutput) DisplayName 

func (o PasswordActorPtrOutput) DisplayName() pulumi.StringPtrOutput

The name of the actor

func (PasswordActorPtrOutput) Elem 

func (o PasswordActorPtrOutput) Elem() PasswordActorOutput

func (PasswordActorPtrOutput) ElementType 

func (PasswordActorPtrOutput) ElementType() reflect.Type

func (PasswordActorPtrOutput) Id 

func (o PasswordActorPtrOutput) Id() pulumi.StringPtrOutput

The ID of the actor

func (PasswordActorPtrOutput) ToPasswordActorPtrOutput 

func (o PasswordActorPtrOutput) ToPasswordActorPtrOutput() PasswordActorPtrOutput

func (PasswordActorPtrOutput) ToPasswordActorPtrOutputWithContext 

func (o PasswordActorPtrOutput) ToPasswordActorPtrOutputWithContext(ctx context.Context) PasswordActorPtrOutput

type PasswordArgs 

type PasswordArgs struct {
	// The branch this password belongs to.
	Branch pulumi.StringInput
	// The datanase this branch password belongs to.
	Database pulumi.StringInput
	// The display name for the password.
	Name pulumi.StringPtrInput
	// The organization this database branch password belongs to.
	Organization pulumi.StringInput
	// The role for the password.
	Role pulumi.StringPtrInput
	// Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
	TtlSeconds pulumi.Float64PtrInput
}

The set of arguments for constructing a Password resource.

func (PasswordArgs) ElementType 

func (PasswordArgs) ElementType() reflect.Type

type PasswordArray 

type PasswordArray []PasswordInput

func (PasswordArray) ElementType 

func (PasswordArray) ElementType() reflect.Type

func (PasswordArray) ToPasswordArrayOutput 

func (i PasswordArray) ToPasswordArrayOutput() PasswordArrayOutput

func (PasswordArray) ToPasswordArrayOutputWithContext 

func (i PasswordArray) ToPasswordArrayOutputWithContext(ctx context.Context) PasswordArrayOutput

type PasswordArrayInput 

type PasswordArrayInput interface {
	pulumi.Input

	ToPasswordArrayOutput() PasswordArrayOutput
	ToPasswordArrayOutputWithContext(context.Context) PasswordArrayOutput
}

PasswordArrayInput is an input type that accepts PasswordArray and PasswordArrayOutput values. You can construct a concrete instance of `PasswordArrayInput` via: 

PasswordArray{ PasswordArgs{...} }

type PasswordArrayOutput 

type PasswordArrayOutput struct{ *pulumi.OutputState }

func (PasswordArrayOutput) ElementType 

func (PasswordArrayOutput) ElementType() reflect.Type

func (PasswordArrayOutput) Index 

func (o PasswordArrayOutput) Index(i pulumi.IntInput) PasswordOutput

func (PasswordArrayOutput) ToPasswordArrayOutput 

func (o PasswordArrayOutput) ToPasswordArrayOutput() PasswordArrayOutput

func (PasswordArrayOutput) ToPasswordArrayOutputWithContext 

func (o PasswordArrayOutput) ToPasswordArrayOutputWithContext(ctx context.Context) PasswordArrayOutput

type PasswordDatabaseBranch 

type PasswordDatabaseBranch struct {
	AccessHostUrl    *string `pulumi:"accessHostUrl"`
	Id               *string `pulumi:"id"`
	MysqlEdgeAddress *string `pulumi:"mysqlEdgeAddress"`
	Name             *string `pulumi:"name"`
	Production       *bool   `pulumi:"production"`
}

type PasswordDatabaseBranchArgs 

type PasswordDatabaseBranchArgs struct {
	AccessHostUrl    pulumi.StringPtrInput `pulumi:"accessHostUrl"`
	Id               pulumi.StringPtrInput `pulumi:"id"`
	MysqlEdgeAddress pulumi.StringPtrInput `pulumi:"mysqlEdgeAddress"`
	Name             pulumi.StringPtrInput `pulumi:"name"`
	Production       pulumi.BoolPtrInput   `pulumi:"production"`
}

func (PasswordDatabaseBranchArgs) ElementType 

func (PasswordDatabaseBranchArgs) ElementType() reflect.Type

func (PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchOutput 

func (i PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchOutput() PasswordDatabaseBranchOutput

func (PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchOutputWithContext 

func (i PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchOutputWithContext(ctx context.Context) PasswordDatabaseBranchOutput

func (PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchPtrOutput 

func (i PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchPtrOutput() PasswordDatabaseBranchPtrOutput

func (PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchPtrOutputWithContext 

func (i PasswordDatabaseBranchArgs) ToPasswordDatabaseBranchPtrOutputWithContext(ctx context.Context) PasswordDatabaseBranchPtrOutput

type PasswordDatabaseBranchInput 

type PasswordDatabaseBranchInput interface {
	pulumi.Input

	ToPasswordDatabaseBranchOutput() PasswordDatabaseBranchOutput
	ToPasswordDatabaseBranchOutputWithContext(context.Context) PasswordDatabaseBranchOutput
}

PasswordDatabaseBranchInput is an input type that accepts PasswordDatabaseBranchArgs and PasswordDatabaseBranchOutput values. You can construct a concrete instance of `PasswordDatabaseBranchInput` via: 

PasswordDatabaseBranchArgs{...}

type PasswordDatabaseBranchOutput 

type PasswordDatabaseBranchOutput struct{ *pulumi.OutputState }

func (PasswordDatabaseBranchOutput) AccessHostUrl 

func (o PasswordDatabaseBranchOutput) AccessHostUrl() pulumi.StringPtrOutput

func (PasswordDatabaseBranchOutput) ElementType 

func (PasswordDatabaseBranchOutput) ElementType() reflect.Type

func (PasswordDatabaseBranchOutput) Id 

func (o PasswordDatabaseBranchOutput) Id() pulumi.StringPtrOutput

func (PasswordDatabaseBranchOutput) MysqlEdgeAddress 

func (o PasswordDatabaseBranchOutput) MysqlEdgeAddress() pulumi.StringPtrOutput

func (PasswordDatabaseBranchOutput) Name 

func (o PasswordDatabaseBranchOutput) Name() pulumi.StringPtrOutput

func (PasswordDatabaseBranchOutput) Production 

func (o PasswordDatabaseBranchOutput) Production() pulumi.BoolPtrOutput

func (PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchOutput 

func (o PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchOutput() PasswordDatabaseBranchOutput

func (PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchOutputWithContext 

func (o PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchOutputWithContext(ctx context.Context) PasswordDatabaseBranchOutput

func (PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchPtrOutput 

func (o PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchPtrOutput() PasswordDatabaseBranchPtrOutput

func (PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchPtrOutputWithContext 

func (o PasswordDatabaseBranchOutput) ToPasswordDatabaseBranchPtrOutputWithContext(ctx context.Context) PasswordDatabaseBranchPtrOutput

type PasswordDatabaseBranchPtrInput 

type PasswordDatabaseBranchPtrInput interface {
	pulumi.Input

	ToPasswordDatabaseBranchPtrOutput() PasswordDatabaseBranchPtrOutput
	ToPasswordDatabaseBranchPtrOutputWithContext(context.Context) PasswordDatabaseBranchPtrOutput
}

PasswordDatabaseBranchPtrInput is an input type that accepts PasswordDatabaseBranchArgs, PasswordDatabaseBranchPtr and PasswordDatabaseBranchPtrOutput values. You can construct a concrete instance of `PasswordDatabaseBranchPtrInput` via: 

        PasswordDatabaseBranchArgs{...}

or:

        nil

func PasswordDatabaseBranchPtr 

func PasswordDatabaseBranchPtr(v *PasswordDatabaseBranchArgs) PasswordDatabaseBranchPtrInput

type PasswordDatabaseBranchPtrOutput 

type PasswordDatabaseBranchPtrOutput struct{ *pulumi.OutputState }

func (PasswordDatabaseBranchPtrOutput) AccessHostUrl 

func (o PasswordDatabaseBranchPtrOutput) AccessHostUrl() pulumi.StringPtrOutput

func (PasswordDatabaseBranchPtrOutput) Elem 

func (o PasswordDatabaseBranchPtrOutput) Elem() PasswordDatabaseBranchOutput

func (PasswordDatabaseBranchPtrOutput) ElementType 

func (PasswordDatabaseBranchPtrOutput) ElementType() reflect.Type

func (PasswordDatabaseBranchPtrOutput) Id 

func (o PasswordDatabaseBranchPtrOutput) Id() pulumi.StringPtrOutput

func (PasswordDatabaseBranchPtrOutput) MysqlEdgeAddress 

func (o PasswordDatabaseBranchPtrOutput) MysqlEdgeAddress() pulumi.StringPtrOutput

func (PasswordDatabaseBranchPtrOutput) Name 

func (o PasswordDatabaseBranchPtrOutput) Name() pulumi.StringPtrOutput

func (PasswordDatabaseBranchPtrOutput) Production 

func (o PasswordDatabaseBranchPtrOutput) Production() pulumi.BoolPtrOutput

func (PasswordDatabaseBranchPtrOutput) ToPasswordDatabaseBranchPtrOutput 

func (o PasswordDatabaseBranchPtrOutput) ToPasswordDatabaseBranchPtrOutput() PasswordDatabaseBranchPtrOutput

func (PasswordDatabaseBranchPtrOutput) ToPasswordDatabaseBranchPtrOutputWithContext 

func (o PasswordDatabaseBranchPtrOutput) ToPasswordDatabaseBranchPtrOutputWithContext(ctx context.Context) PasswordDatabaseBranchPtrOutput

type PasswordInput 

type PasswordInput interface {
	pulumi.Input

	ToPasswordOutput() PasswordOutput
	ToPasswordOutputWithContext(ctx context.Context) PasswordOutput
}

type PasswordMap 

type PasswordMap map[string]PasswordInput

func (PasswordMap) ElementType 

func (PasswordMap) ElementType() reflect.Type

func (PasswordMap) ToPasswordMapOutput 

func (i PasswordMap) ToPasswordMapOutput() PasswordMapOutput

func (PasswordMap) ToPasswordMapOutputWithContext 

func (i PasswordMap) ToPasswordMapOutputWithContext(ctx context.Context) PasswordMapOutput

type PasswordMapInput 

type PasswordMapInput interface {
	pulumi.Input

	ToPasswordMapOutput() PasswordMapOutput
	ToPasswordMapOutputWithContext(context.Context) PasswordMapOutput
}

PasswordMapInput is an input type that accepts PasswordMap and PasswordMapOutput values. You can construct a concrete instance of `PasswordMapInput` via: 

PasswordMap{ "key": PasswordArgs{...} }

type PasswordMapOutput 

type PasswordMapOutput struct{ *pulumi.OutputState }

func (PasswordMapOutput) ElementType 

func (PasswordMapOutput) ElementType() reflect.Type

func (PasswordMapOutput) MapIndex 

func (o PasswordMapOutput) MapIndex(k pulumi.StringInput) PasswordOutput

func (PasswordMapOutput) ToPasswordMapOutput 

func (o PasswordMapOutput) ToPasswordMapOutput() PasswordMapOutput

func (PasswordMapOutput) ToPasswordMapOutputWithContext 

func (o PasswordMapOutput) ToPasswordMapOutputWithContext(ctx context.Context) PasswordMapOutput

type PasswordOutput 

type PasswordOutput struct{ *pulumi.OutputState }

func (PasswordOutput) AccessHostUrl 

func (o PasswordOutput) AccessHostUrl() pulumi.StringOutput

The host URL for the password.

func (PasswordOutput) Actor 

func (o PasswordOutput) Actor() PasswordActorOutput

The actor that created this branch.

func (PasswordOutput) Branch 

func (o PasswordOutput) Branch() pulumi.StringOutput

The branch this password belongs to.

func (PasswordOutput) CreatedAt 

func (o PasswordOutput) CreatedAt() pulumi.StringOutput

When the password was created.

func (PasswordOutput) Database 

func (o PasswordOutput) Database() pulumi.StringOutput

The datanase this branch password belongs to.

func (PasswordOutput) DatabaseBranch 

func (o PasswordOutput) DatabaseBranch() PasswordDatabaseBranchOutput

The branch this password is allowed to access.

func (PasswordOutput) DeletedAt 

func (o PasswordOutput) DeletedAt() pulumi.StringOutput

When the password was deleted.

func (PasswordOutput) ElementType 

func (PasswordOutput) ElementType() reflect.Type

func (PasswordOutput) ExpiresAt 

func (o PasswordOutput) ExpiresAt() pulumi.StringOutput

When the password will expire.

func (PasswordOutput) Name 

func (o PasswordOutput) Name() pulumi.StringOutput

The display name for the password.

func (PasswordOutput) Organization 

func (o PasswordOutput) Organization() pulumi.StringOutput

The organization this database branch password belongs to.

func (PasswordOutput) Plaintext 

func (o PasswordOutput) Plaintext() pulumi.StringOutput

The plaintext password, only available if the password was created by this provider.

func (PasswordOutput) Region 

func (o PasswordOutput) Region() PasswordRegionOutput

The region in which this password can be used.

func (PasswordOutput) Renewable 

func (o PasswordOutput) Renewable() pulumi.BoolOutput

Whether or not the password can be renewed.

func (PasswordOutput) Role 

func (o PasswordOutput) Role() pulumi.StringOutput

The role for the password.

func (PasswordOutput) ToPasswordOutput 

func (o PasswordOutput) ToPasswordOutput() PasswordOutput

func (PasswordOutput) ToPasswordOutputWithContext 

func (o PasswordOutput) ToPasswordOutputWithContext(ctx context.Context) PasswordOutput

func (PasswordOutput) TtlSeconds 

func (o PasswordOutput) TtlSeconds() pulumi.Float64Output

Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.

func (PasswordOutput) Username 

func (o PasswordOutput) Username() pulumi.StringOutput

The username for the password.

type PasswordRegion 

type PasswordRegion struct {
	// Name of the region.
	DisplayName *string `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled *bool `pulumi:"enabled"`
	// The ID of the region.
	Id *string `pulumi:"id"`
	// Location of the region.
	Location *string `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider *string `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses []string `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug *string `pulumi:"slug"`
}

type PasswordRegionArgs 

type PasswordRegionArgs struct {
	// Name of the region.
	DisplayName pulumi.StringPtrInput `pulumi:"displayName"`
	// Whether or not the region is currently active.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// The ID of the region.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// Location of the region.
	Location pulumi.StringPtrInput `pulumi:"location"`
	// Provider for the region (ex. AWS).
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Public IP addresses for the region.
	PublicIpAddresses pulumi.StringArrayInput `pulumi:"publicIpAddresses"`
	// The slug of the region.
	Slug pulumi.StringPtrInput `pulumi:"slug"`
}

func (PasswordRegionArgs) ElementType 

func (PasswordRegionArgs) ElementType() reflect.Type

func (PasswordRegionArgs) ToPasswordRegionOutput 

func (i PasswordRegionArgs) ToPasswordRegionOutput() PasswordRegionOutput

func (PasswordRegionArgs) ToPasswordRegionOutputWithContext 

func (i PasswordRegionArgs) ToPasswordRegionOutputWithContext(ctx context.Context) PasswordRegionOutput

func (PasswordRegionArgs) ToPasswordRegionPtrOutput 

func (i PasswordRegionArgs) ToPasswordRegionPtrOutput() PasswordRegionPtrOutput

func (PasswordRegionArgs) ToPasswordRegionPtrOutputWithContext 

func (i PasswordRegionArgs) ToPasswordRegionPtrOutputWithContext(ctx context.Context) PasswordRegionPtrOutput

type PasswordRegionInput 

type PasswordRegionInput interface {
	pulumi.Input

	ToPasswordRegionOutput() PasswordRegionOutput
	ToPasswordRegionOutputWithContext(context.Context) PasswordRegionOutput
}

PasswordRegionInput is an input type that accepts PasswordRegionArgs and PasswordRegionOutput values. You can construct a concrete instance of `PasswordRegionInput` via: 

PasswordRegionArgs{...}

type PasswordRegionOutput 

type PasswordRegionOutput struct{ *pulumi.OutputState }

func (PasswordRegionOutput) DisplayName 

func (o PasswordRegionOutput) DisplayName() pulumi.StringPtrOutput

Name of the region.

func (PasswordRegionOutput) ElementType 

func (PasswordRegionOutput) ElementType() reflect.Type

func (PasswordRegionOutput) Enabled 

func (o PasswordRegionOutput) Enabled() pulumi.BoolPtrOutput

Whether or not the region is currently active.

func (PasswordRegionOutput) Id 

func (o PasswordRegionOutput) Id() pulumi.StringPtrOutput

The ID of the region.

func (PasswordRegionOutput) Location 

func (o PasswordRegionOutput) Location() pulumi.StringPtrOutput

Location of the region.

func (PasswordRegionOutput) Provider 

func (o PasswordRegionOutput) Provider() pulumi.StringPtrOutput

Provider for the region (ex. AWS).

func (PasswordRegionOutput) PublicIpAddresses 

func (o PasswordRegionOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (PasswordRegionOutput) Slug 

func (o PasswordRegionOutput) Slug() pulumi.StringPtrOutput

The slug of the region.

func (PasswordRegionOutput) ToPasswordRegionOutput 

func (o PasswordRegionOutput) ToPasswordRegionOutput() PasswordRegionOutput

func (PasswordRegionOutput) ToPasswordRegionOutputWithContext 

func (o PasswordRegionOutput) ToPasswordRegionOutputWithContext(ctx context.Context) PasswordRegionOutput

func (PasswordRegionOutput) ToPasswordRegionPtrOutput 

func (o PasswordRegionOutput) ToPasswordRegionPtrOutput() PasswordRegionPtrOutput

func (PasswordRegionOutput) ToPasswordRegionPtrOutputWithContext 

func (o PasswordRegionOutput) ToPasswordRegionPtrOutputWithContext(ctx context.Context) PasswordRegionPtrOutput

type PasswordRegionPtrInput 

type PasswordRegionPtrInput interface {
	pulumi.Input

	ToPasswordRegionPtrOutput() PasswordRegionPtrOutput
	ToPasswordRegionPtrOutputWithContext(context.Context) PasswordRegionPtrOutput
}

PasswordRegionPtrInput is an input type that accepts PasswordRegionArgs, PasswordRegionPtr and PasswordRegionPtrOutput values. You can construct a concrete instance of `PasswordRegionPtrInput` via: 

        PasswordRegionArgs{...}

or:

        nil

func PasswordRegionPtr 

func PasswordRegionPtr(v *PasswordRegionArgs) PasswordRegionPtrInput

type PasswordRegionPtrOutput 

type PasswordRegionPtrOutput struct{ *pulumi.OutputState }

func (PasswordRegionPtrOutput) DisplayName 

func (o PasswordRegionPtrOutput) DisplayName() pulumi.StringPtrOutput

Name of the region.

func (PasswordRegionPtrOutput) Elem 

func (o PasswordRegionPtrOutput) Elem() PasswordRegionOutput

func (PasswordRegionPtrOutput) ElementType 

func (PasswordRegionPtrOutput) ElementType() reflect.Type

func (PasswordRegionPtrOutput) Enabled 

func (o PasswordRegionPtrOutput) Enabled() pulumi.BoolPtrOutput

Whether or not the region is currently active.

func (PasswordRegionPtrOutput) Id 

func (o PasswordRegionPtrOutput) Id() pulumi.StringPtrOutput

The ID of the region.

func (PasswordRegionPtrOutput) Location 

func (o PasswordRegionPtrOutput) Location() pulumi.StringPtrOutput

Location of the region.

func (PasswordRegionPtrOutput) Provider 

func (o PasswordRegionPtrOutput) Provider() pulumi.StringPtrOutput

Provider for the region (ex. AWS).

func (PasswordRegionPtrOutput) PublicIpAddresses 

func (o PasswordRegionPtrOutput) PublicIpAddresses() pulumi.StringArrayOutput

Public IP addresses for the region.

func (PasswordRegionPtrOutput) Slug 

func (o PasswordRegionPtrOutput) Slug() pulumi.StringPtrOutput

The slug of the region.

func (PasswordRegionPtrOutput) ToPasswordRegionPtrOutput 

func (o PasswordRegionPtrOutput) ToPasswordRegionPtrOutput() PasswordRegionPtrOutput

func (PasswordRegionPtrOutput) ToPasswordRegionPtrOutputWithContext 

func (o PasswordRegionPtrOutput) ToPasswordRegionPtrOutputWithContext(ctx context.Context) PasswordRegionPtrOutput

type PasswordState 

type PasswordState struct {
	// The host URL for the password.
	AccessHostUrl pulumi.StringPtrInput
	// The actor that created this branch.
	Actor PasswordActorPtrInput
	// The branch this password belongs to.
	Branch pulumi.StringPtrInput
	// When the password was created.
	CreatedAt pulumi.StringPtrInput
	// The datanase this branch password belongs to.
	Database pulumi.StringPtrInput
	// The branch this password is allowed to access.
	DatabaseBranch PasswordDatabaseBranchPtrInput
	// When the password was deleted.
	DeletedAt pulumi.StringPtrInput
	// When the password will expire.
	ExpiresAt pulumi.StringPtrInput
	// The display name for the password.
	Name pulumi.StringPtrInput
	// The organization this database branch password belongs to.
	Organization pulumi.StringPtrInput
	// The plaintext password, only available if the password was created by this provider.
	Plaintext pulumi.StringPtrInput
	// The region in which this password can be used.
	Region PasswordRegionPtrInput
	// Whether or not the password can be renewed.
	Renewable pulumi.BoolPtrInput
	// The role for the password.
	Role pulumi.StringPtrInput
	// Time to live (in seconds) for the password. The password will be invalid and unrenewable when TTL has passed.
	TtlSeconds pulumi.Float64PtrInput
	// The username for the password.
	Username pulumi.StringPtrInput
}

func (PasswordState) ElementType 

func (PasswordState) ElementType() reflect.Type

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with
	// `service_token_name` and `service_token`.
	AccessToken pulumi.StringPtrOutput `pulumi:"accessToken"`
	// If set, points the API client to a different endpoint than `https:://api.planetscale.com/v1`.
	Endpoint pulumi.StringPtrOutput `pulumi:"endpoint"`
	// Value of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN`. Mutually exclusive with
	// `access_token`.
	ServiceToken pulumi.StringPtrOutput `pulumi:"serviceToken"`
	// Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with
	// `access_token`.
	ServiceTokenName pulumi.StringPtrOutput `pulumi:"serviceTokenName"`
}

The provider type for the planetscale package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
	// Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with
	// `service_token_name` and `service_token`.
	AccessToken pulumi.StringPtrInput
	// If set, points the API client to a different endpoint than `https:://api.planetscale.com/v1`.
	Endpoint pulumi.StringPtrInput
	// Value of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN`. Mutually exclusive with
	// `access_token`.
	ServiceToken pulumi.StringPtrInput
	// Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with
	// `access_token`.
	ServiceTokenName pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) AccessToken 

func (o ProviderOutput) AccessToken() pulumi.StringPtrOutput

Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with `service_token_name` and `service_token`.

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Endpoint 

func (o ProviderOutput) Endpoint() pulumi.StringPtrOutput

If set, points the API client to a different endpoint than `https:://api.planetscale.com/v1`.

func (ProviderOutput) ServiceToken 

func (o ProviderOutput) ServiceToken() pulumi.StringPtrOutput

Value of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN`. Mutually exclusive with `access_token`.

func (ProviderOutput) ServiceTokenName 

func (o ProviderOutput) ServiceTokenName() pulumi.StringPtrOutput

Name of the service token to use. Alternatively, use `PLANETSCALE_SERVICE_TOKEN_NAME`. Mutually exclusive with `access_token`.

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.