instances.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package mongodb

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/internal"
)

// Use this data source to query detailed information of mongodb instances
// ## Example Usage
//
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/mongodb"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := mongodb.Instances(ctx, &mongodb.InstancesArgs{
//				InstanceId: pulumi.StringRef("mongo-replica-xxx"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
func Instances(ctx *pulumi.Context, args *InstancesArgs, opts ...pulumi.InvokeOption) (*InstancesResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv InstancesResult
	err := ctx.Invoke("volcengine:mongodb/instances:Instances", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking Instances.
type InstancesArgs struct {
	// The end time of creation to query.
	CreateEndTime *string `pulumi:"createEndTime"`
	// The start time of creation to query.
	CreateStartTime *string `pulumi:"createStartTime"`
	// The db engine to query, valid value contains `MongoDB`.
	DbEngine *string `pulumi:"dbEngine"`
	// The version of db engine to query, valid value contains `MongoDB_4_0`.
	DbEngineVersion *string `pulumi:"dbEngineVersion"`
	// The instance ID to query.
	InstanceId *string `pulumi:"instanceId"`
	// The instance name to query.
	InstanceName *string `pulumi:"instanceName"`
	// The instance status to query.
	InstanceStatus *string `pulumi:"instanceStatus"`
	// The type of instance to query, the valid value contains `ReplicaSet` or `ShardedCluster`.
	InstanceType *string `pulumi:"instanceType"`
	// A Name Regex of DB instance.
	NameRegex *string `pulumi:"nameRegex"`
	// File name where to save data source results.
	OutputFile *string `pulumi:"outputFile"`
	// Tags.
	Tags []InstancesTag `pulumi:"tags"`
	// The end time of update to query.
	UpdateEndTime *string `pulumi:"updateEndTime"`
	// The start time of update to query.
	UpdateStartTime *string `pulumi:"updateStartTime"`
	// The vpc id of instance to query.
	VpcId *string `pulumi:"vpcId"`
	// The zone ID to query.
	ZoneId *string `pulumi:"zoneId"`
}

// A collection of values returned by Instances.
type InstancesResult struct {
	CreateEndTime   *string `pulumi:"createEndTime"`
	CreateStartTime *string `pulumi:"createStartTime"`
	// The db engine.
	DbEngine *string `pulumi:"dbEngine"`
	// The version of database engine.
	DbEngineVersion *string `pulumi:"dbEngineVersion"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The instance ID.
	InstanceId *string `pulumi:"instanceId"`
	// The instance name.
	InstanceName *string `pulumi:"instanceName"`
	// The instance status.
	InstanceStatus *string `pulumi:"instanceStatus"`
	// The instance type.
	InstanceType *string `pulumi:"instanceType"`
	// The collection of mongodb instances query.
	Instances  []InstancesInstance `pulumi:"instances"`
	NameRegex  *string             `pulumi:"nameRegex"`
	OutputFile *string             `pulumi:"outputFile"`
	// Tags.
	Tags []InstancesTag `pulumi:"tags"`
	// The total count of mongodb instances query.
	TotalCount      int     `pulumi:"totalCount"`
	UpdateEndTime   *string `pulumi:"updateEndTime"`
	UpdateStartTime *string `pulumi:"updateStartTime"`
	// The vpc ID.
	VpcId *string `pulumi:"vpcId"`
	// The zone ID of instance.
	ZoneId *string `pulumi:"zoneId"`
}

func InstancesOutput(ctx *pulumi.Context, args InstancesOutputArgs, opts ...pulumi.InvokeOption) InstancesResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (InstancesResult, error) {
			args := v.(InstancesArgs)
			r, err := Instances(ctx, &args, opts...)
			var s InstancesResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(InstancesResultOutput)
}

// A collection of arguments for invoking Instances.
type InstancesOutputArgs struct {
	// The end time of creation to query.
	CreateEndTime pulumi.StringPtrInput `pulumi:"createEndTime"`
	// The start time of creation to query.
	CreateStartTime pulumi.StringPtrInput `pulumi:"createStartTime"`
	// The db engine to query, valid value contains `MongoDB`.
	DbEngine pulumi.StringPtrInput `pulumi:"dbEngine"`
	// The version of db engine to query, valid value contains `MongoDB_4_0`.
	DbEngineVersion pulumi.StringPtrInput `pulumi:"dbEngineVersion"`
	// The instance ID to query.
	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
	// The instance name to query.
	InstanceName pulumi.StringPtrInput `pulumi:"instanceName"`
	// The instance status to query.
	InstanceStatus pulumi.StringPtrInput `pulumi:"instanceStatus"`
	// The type of instance to query, the valid value contains `ReplicaSet` or `ShardedCluster`.
	InstanceType pulumi.StringPtrInput `pulumi:"instanceType"`
	// A Name Regex of DB instance.
	NameRegex pulumi.StringPtrInput `pulumi:"nameRegex"`
	// File name where to save data source results.
	OutputFile pulumi.StringPtrInput `pulumi:"outputFile"`
	// Tags.
	Tags InstancesTagArrayInput `pulumi:"tags"`
	// The end time of update to query.
	UpdateEndTime pulumi.StringPtrInput `pulumi:"updateEndTime"`
	// The start time of update to query.
	UpdateStartTime pulumi.StringPtrInput `pulumi:"updateStartTime"`
	// The vpc id of instance to query.
	VpcId pulumi.StringPtrInput `pulumi:"vpcId"`
	// The zone ID to query.
	ZoneId pulumi.StringPtrInput `pulumi:"zoneId"`
}

func (InstancesOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*InstancesArgs)(nil)).Elem()
}

// A collection of values returned by Instances.
type InstancesResultOutput struct{ *pulumi.OutputState }

func (InstancesResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*InstancesResult)(nil)).Elem()
}

func (o InstancesResultOutput) ToInstancesResultOutput() InstancesResultOutput {
	return o
}

func (o InstancesResultOutput) ToInstancesResultOutputWithContext(ctx context.Context) InstancesResultOutput {
	return o
}

func (o InstancesResultOutput) CreateEndTime() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.CreateEndTime }).(pulumi.StringPtrOutput)
}

func (o InstancesResultOutput) CreateStartTime() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.CreateStartTime }).(pulumi.StringPtrOutput)
}

// The db engine.
func (o InstancesResultOutput) DbEngine() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.DbEngine }).(pulumi.StringPtrOutput)
}

// The version of database engine.
func (o InstancesResultOutput) DbEngineVersion() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.DbEngineVersion }).(pulumi.StringPtrOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o InstancesResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v InstancesResult) string { return v.Id }).(pulumi.StringOutput)
}

// The instance ID.
func (o InstancesResultOutput) InstanceId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.InstanceId }).(pulumi.StringPtrOutput)
}

// The instance name.
func (o InstancesResultOutput) InstanceName() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.InstanceName }).(pulumi.StringPtrOutput)
}

// The instance status.
func (o InstancesResultOutput) InstanceStatus() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.InstanceStatus }).(pulumi.StringPtrOutput)
}

// The instance type.
func (o InstancesResultOutput) InstanceType() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.InstanceType }).(pulumi.StringPtrOutput)
}

// The collection of mongodb instances query.
func (o InstancesResultOutput) Instances() InstancesInstanceArrayOutput {
	return o.ApplyT(func(v InstancesResult) []InstancesInstance { return v.Instances }).(InstancesInstanceArrayOutput)
}

func (o InstancesResultOutput) NameRegex() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.NameRegex }).(pulumi.StringPtrOutput)
}

func (o InstancesResultOutput) OutputFile() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.OutputFile }).(pulumi.StringPtrOutput)
}

// Tags.
func (o InstancesResultOutput) Tags() InstancesTagArrayOutput {
	return o.ApplyT(func(v InstancesResult) []InstancesTag { return v.Tags }).(InstancesTagArrayOutput)
}

// The total count of mongodb instances query.
func (o InstancesResultOutput) TotalCount() pulumi.IntOutput {
	return o.ApplyT(func(v InstancesResult) int { return v.TotalCount }).(pulumi.IntOutput)
}

func (o InstancesResultOutput) UpdateEndTime() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.UpdateEndTime }).(pulumi.StringPtrOutput)
}

func (o InstancesResultOutput) UpdateStartTime() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.UpdateStartTime }).(pulumi.StringPtrOutput)
}

// The vpc ID.
func (o InstancesResultOutput) VpcId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.VpcId }).(pulumi.StringPtrOutput)
}

// The zone ID of instance.
func (o InstancesResultOutput) ZoneId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v InstancesResult) *string { return v.ZoneId }).(pulumi.StringPtrOutput)
}

func init() {
	pulumi.RegisterOutputType(InstancesResultOutput{})
}