v1beta

package
v0.0.1-alpha.100 Latest Latest
Warning

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

 Go to latest Published: Jan 25, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Unknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.
	InstanceTypeDatabaseInstanceTypeUnspecified = InstanceType("DATABASE_INSTANCE_TYPE_UNSPECIFIED")
	// The default database that is provisioned when a project is created.
	InstanceTypeDefaultDatabase = InstanceType("DEFAULT_DATABASE")
	// A database that the user created.
	InstanceTypeUserDatabase = InstanceType("USER_DATABASE")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Instance 

type Instance struct {
	pulumi.CustomResourceState

	// The globally unique identifier of the database instance.
	DatabaseId pulumi.StringPtrOutput `pulumi:"databaseId"`
	// Output Only. The globally unique hostname of the database.
	DatabaseUrl pulumi.StringOutput `pulumi:"databaseUrl"`
	Location    pulumi.StringOutput `pulumi:"location"`
	// The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// The database's lifecycle state. Read-only.
	State pulumi.StringOutput `pulumi:"state"`
	// Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
	Type pulumi.StringOutput `pulumi:"type"`
}

Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.

func GetInstance 

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *InstanceState, opts ...pulumi.ResourceOption) (*Instance, error)

GetInstance gets an existing Instance 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 NewInstance 

func NewInstance(ctx *pulumi.Context,
	name string, args *InstanceArgs, opts ...pulumi.ResourceOption) (*Instance, error)

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

func (*Instance) ElementType 

func (*Instance) ElementType() reflect.Type

func (*Instance) ToInstanceOutput 

func (i *Instance) ToInstanceOutput() InstanceOutput

func (*Instance) ToInstanceOutputWithContext 

func (i *Instance) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

type InstanceArgs 

type InstanceArgs struct {
	// The globally unique identifier of the database instance.
	DatabaseId pulumi.StringPtrInput
	Location   pulumi.StringPtrInput
	// The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
	// Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
	Type InstanceTypePtrInput
}

The set of arguments for constructing a Instance resource.

func (InstanceArgs) ElementType 

func (InstanceArgs) ElementType() reflect.Type

type InstanceInput 

type InstanceInput interface {
	pulumi.Input

	ToInstanceOutput() InstanceOutput
	ToInstanceOutputWithContext(ctx context.Context) InstanceOutput
}

type InstanceOutput 

type InstanceOutput struct{ *pulumi.OutputState }

func (InstanceOutput) DatabaseId added in v0.21.0 

func (o InstanceOutput) DatabaseId() pulumi.StringPtrOutput

The globally unique identifier of the database instance.

func (InstanceOutput) DatabaseUrl added in v0.19.0 

func (o InstanceOutput) DatabaseUrl() pulumi.StringOutput

Output Only. The globally unique hostname of the database.

func (InstanceOutput) ElementType 

func (InstanceOutput) ElementType() reflect.Type

func (InstanceOutput) Location added in v0.21.0 

func (o InstanceOutput) Location() pulumi.StringOutput

func (InstanceOutput) Name added in v0.19.0 

func (o InstanceOutput) Name() pulumi.StringOutput

The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.

func (InstanceOutput) Project added in v0.19.0 

func (o InstanceOutput) Project() pulumi.StringOutput

func (InstanceOutput) State added in v0.19.0 

func (o InstanceOutput) State() pulumi.StringOutput

The database's lifecycle state. Read-only.

func (InstanceOutput) ToInstanceOutput 

func (o InstanceOutput) ToInstanceOutput() InstanceOutput

func (InstanceOutput) ToInstanceOutputWithContext 

func (o InstanceOutput) ToInstanceOutputWithContext(ctx context.Context) InstanceOutput

func (InstanceOutput) Type added in v0.19.0 

func (o InstanceOutput) Type() pulumi.StringOutput

Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.

type InstanceState 

type InstanceState struct {
}

func (InstanceState) ElementType 

func (InstanceState) ElementType() reflect.Type

type InstanceType added in v0.4.0 

type InstanceType string

Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.

func (InstanceType) ElementType added in v0.4.0 

func (InstanceType) ElementType() reflect.Type

func (InstanceType) ToInstanceTypeOutput added in v0.6.0 

func (e InstanceType) ToInstanceTypeOutput() InstanceTypeOutput

func (InstanceType) ToInstanceTypeOutputWithContext added in v0.6.0 

func (e InstanceType) ToInstanceTypeOutputWithContext(ctx context.Context) InstanceTypeOutput

func (InstanceType) ToInstanceTypePtrOutput added in v0.6.0 

func (e InstanceType) ToInstanceTypePtrOutput() InstanceTypePtrOutput

func (InstanceType) ToInstanceTypePtrOutputWithContext added in v0.6.0 

func (e InstanceType) ToInstanceTypePtrOutputWithContext(ctx context.Context) InstanceTypePtrOutput

func (InstanceType) ToStringOutput added in v0.4.0 

func (e InstanceType) ToStringOutput() pulumi.StringOutput

func (InstanceType) ToStringOutputWithContext added in v0.4.0 

func (e InstanceType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (InstanceType) ToStringPtrOutput added in v0.4.0 

func (e InstanceType) ToStringPtrOutput() pulumi.StringPtrOutput

func (InstanceType) ToStringPtrOutputWithContext added in v0.4.0 

func (e InstanceType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type InstanceTypeInput added in v0.6.0 

type InstanceTypeInput interface {
	pulumi.Input

	ToInstanceTypeOutput() InstanceTypeOutput
	ToInstanceTypeOutputWithContext(context.Context) InstanceTypeOutput
}

InstanceTypeInput is an input type that accepts values of the InstanceType enum A concrete instance of `InstanceTypeInput` can be one of the following: 

InstanceTypeDatabaseInstanceTypeUnspecified
InstanceTypeDefaultDatabase
InstanceTypeUserDatabase

type InstanceTypeOutput added in v0.6.0 

type InstanceTypeOutput struct{ *pulumi.OutputState }

func (InstanceTypeOutput) ElementType added in v0.6.0 

func (InstanceTypeOutput) ElementType() reflect.Type

func (InstanceTypeOutput) ToInstanceTypeOutput added in v0.6.0 

func (o InstanceTypeOutput) ToInstanceTypeOutput() InstanceTypeOutput

func (InstanceTypeOutput) ToInstanceTypeOutputWithContext added in v0.6.0 

func (o InstanceTypeOutput) ToInstanceTypeOutputWithContext(ctx context.Context) InstanceTypeOutput

func (InstanceTypeOutput) ToInstanceTypePtrOutput added in v0.6.0 

func (o InstanceTypeOutput) ToInstanceTypePtrOutput() InstanceTypePtrOutput

func (InstanceTypeOutput) ToInstanceTypePtrOutputWithContext added in v0.6.0 

func (o InstanceTypeOutput) ToInstanceTypePtrOutputWithContext(ctx context.Context) InstanceTypePtrOutput

func (InstanceTypeOutput) ToStringOutput added in v0.6.0 

func (o InstanceTypeOutput) ToStringOutput() pulumi.StringOutput

func (InstanceTypeOutput) ToStringOutputWithContext added in v0.6.0 

func (o InstanceTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (InstanceTypeOutput) ToStringPtrOutput added in v0.6.0 

func (o InstanceTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (InstanceTypeOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o InstanceTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type InstanceTypePtrInput added in v0.6.0 

type InstanceTypePtrInput interface {
	pulumi.Input

	ToInstanceTypePtrOutput() InstanceTypePtrOutput
	ToInstanceTypePtrOutputWithContext(context.Context) InstanceTypePtrOutput
}

func InstanceTypePtr added in v0.6.0 

func InstanceTypePtr(v string) InstanceTypePtrInput

type InstanceTypePtrOutput added in v0.6.0 

type InstanceTypePtrOutput struct{ *pulumi.OutputState }

func (InstanceTypePtrOutput) Elem added in v0.6.0 

func (o InstanceTypePtrOutput) Elem() InstanceTypeOutput

func (InstanceTypePtrOutput) ElementType added in v0.6.0 

func (InstanceTypePtrOutput) ElementType() reflect.Type

func (InstanceTypePtrOutput) ToInstanceTypePtrOutput added in v0.6.0 

func (o InstanceTypePtrOutput) ToInstanceTypePtrOutput() InstanceTypePtrOutput

func (InstanceTypePtrOutput) ToInstanceTypePtrOutputWithContext added in v0.6.0 

func (o InstanceTypePtrOutput) ToInstanceTypePtrOutputWithContext(ctx context.Context) InstanceTypePtrOutput

func (InstanceTypePtrOutput) ToStringPtrOutput added in v0.6.0 

func (o InstanceTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (InstanceTypePtrOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o InstanceTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LookupInstanceArgs added in v0.4.0 

type LookupInstanceArgs struct {
	InstanceId string  `pulumi:"instanceId"`
	Location   string  `pulumi:"location"`
	Project    *string `pulumi:"project"`
}

type LookupInstanceOutputArgs added in v0.8.0 

type LookupInstanceOutputArgs struct {
	InstanceId pulumi.StringInput    `pulumi:"instanceId"`
	Location   pulumi.StringInput    `pulumi:"location"`
	Project    pulumi.StringPtrInput `pulumi:"project"`
}

func (LookupInstanceOutputArgs) ElementType added in v0.8.0 

func (LookupInstanceOutputArgs) ElementType() reflect.Type

type LookupInstanceResult added in v0.4.0 

type LookupInstanceResult struct {
	// Output Only. The globally unique hostname of the database.
	DatabaseUrl string `pulumi:"databaseUrl"`
	// The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
	Name string `pulumi:"name"`
	// The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
	Project string `pulumi:"project"`
	// The database's lifecycle state. Read-only.
	State string `pulumi:"state"`
	// Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
	Type string `pulumi:"type"`
}

func LookupInstance added in v0.4.0 

func LookupInstance(ctx *pulumi.Context, args *LookupInstanceArgs, opts ...pulumi.InvokeOption) (*LookupInstanceResult, error)

Gets the DatabaseInstance identified by the specified resource name.

type LookupInstanceResultOutput added in v0.8.0 

type LookupInstanceResultOutput struct{ *pulumi.OutputState }

func LookupInstanceOutput added in v0.8.0 

func LookupInstanceOutput(ctx *pulumi.Context, args LookupInstanceOutputArgs, opts ...pulumi.InvokeOption) LookupInstanceResultOutput

func (LookupInstanceResultOutput) DatabaseUrl added in v0.8.0 

func (o LookupInstanceResultOutput) DatabaseUrl() pulumi.StringOutput

Output Only. The globally unique hostname of the database.

func (LookupInstanceResultOutput) ElementType added in v0.8.0 

func (LookupInstanceResultOutput) ElementType() reflect.Type

func (LookupInstanceResultOutput) Name added in v0.8.0 

func (o LookupInstanceResultOutput) Name() pulumi.StringOutput

The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.

func (LookupInstanceResultOutput) Project added in v0.8.0 

func (o LookupInstanceResultOutput) Project() pulumi.StringOutput

The resource name of the project this instance belongs to. For example: `projects/{project-number}`.

func (LookupInstanceResultOutput) State added in v0.8.0 

func (o LookupInstanceResultOutput) State() pulumi.StringOutput

The database's lifecycle state. Read-only.

func (LookupInstanceResultOutput) ToLookupInstanceResultOutput added in v0.8.0 

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutput() LookupInstanceResultOutput

func (LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext added in v0.8.0 

func (o LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext(ctx context.Context) LookupInstanceResultOutput

func (LookupInstanceResultOutput) Type added in v0.8.0 

func (o LookupInstanceResultOutput) Type() pulumi.StringOutput

Immutable. The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.

Source Files

View all Source files

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.