github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/docdb/getOrderableDbInstance.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 docdb

import (
	"context"
	"reflect"

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

// Information about DocumentDB orderable DB instances.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/docdb"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := docdb.GetOrderableDbInstance(ctx, &docdb.GetOrderableDbInstanceArgs{
//				Engine:        pulumi.StringRef("docdb"),
//				EngineVersion: pulumi.StringRef("3.6.0"),
//				LicenseModel:  pulumi.StringRef("na"),
//				PreferredInstanceClasses: []string{
//					"db.r5.large",
//					"db.r4.large",
//					"db.t3.medium",
//				},
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func GetOrderableDbInstance(ctx *pulumi.Context, args *GetOrderableDbInstanceArgs, opts ...pulumi.InvokeOption) (*GetOrderableDbInstanceResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv GetOrderableDbInstanceResult
	err := ctx.Invoke("aws:docdb/getOrderableDbInstance:getOrderableDbInstance", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getOrderableDbInstance.
type GetOrderableDbInstanceArgs struct {
	// DB engine. Default: `docdb`
	Engine *string `pulumi:"engine"`
	// Version of the DB engine.
	EngineVersion *string `pulumi:"engineVersion"`
	// DB instance class. Examples of classes are `db.r5.12xlarge`, `db.r5.24xlarge`, `db.r5.2xlarge`, `db.r5.4xlarge`, `db.r5.large`, `db.r5.xlarge`, and `db.t3.medium`. (Conflicts with `preferredInstanceClasses`.)
	InstanceClass *string `pulumi:"instanceClass"`
	// License model. Default: `na`
	LicenseModel *string `pulumi:"licenseModel"`
	// Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with `instanceClass`.)
	PreferredInstanceClasses []string `pulumi:"preferredInstanceClasses"`
	// Enable to show only VPC.
	Vpc *bool `pulumi:"vpc"`
}

// A collection of values returned by getOrderableDbInstance.
type GetOrderableDbInstanceResult struct {
	// Availability zones where the instance is available.
	AvailabilityZones []string `pulumi:"availabilityZones"`
	Engine            *string  `pulumi:"engine"`
	EngineVersion     string   `pulumi:"engineVersion"`
	// The provider-assigned unique ID for this managed resource.
	Id                       string   `pulumi:"id"`
	InstanceClass            string   `pulumi:"instanceClass"`
	LicenseModel             *string  `pulumi:"licenseModel"`
	PreferredInstanceClasses []string `pulumi:"preferredInstanceClasses"`
	Vpc                      bool     `pulumi:"vpc"`
}

func GetOrderableDbInstanceOutput(ctx *pulumi.Context, args GetOrderableDbInstanceOutputArgs, opts ...pulumi.InvokeOption) GetOrderableDbInstanceResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetOrderableDbInstanceResult, error) {
			args := v.(GetOrderableDbInstanceArgs)
			r, err := GetOrderableDbInstance(ctx, &args, opts...)
			var s GetOrderableDbInstanceResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetOrderableDbInstanceResultOutput)
}

// A collection of arguments for invoking getOrderableDbInstance.
type GetOrderableDbInstanceOutputArgs struct {
	// DB engine. Default: `docdb`
	Engine pulumi.StringPtrInput `pulumi:"engine"`
	// Version of the DB engine.
	EngineVersion pulumi.StringPtrInput `pulumi:"engineVersion"`
	// DB instance class. Examples of classes are `db.r5.12xlarge`, `db.r5.24xlarge`, `db.r5.2xlarge`, `db.r5.4xlarge`, `db.r5.large`, `db.r5.xlarge`, and `db.t3.medium`. (Conflicts with `preferredInstanceClasses`.)
	InstanceClass pulumi.StringPtrInput `pulumi:"instanceClass"`
	// License model. Default: `na`
	LicenseModel pulumi.StringPtrInput `pulumi:"licenseModel"`
	// Ordered list of preferred DocumentDB DB instance classes. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. (Conflicts with `instanceClass`.)
	PreferredInstanceClasses pulumi.StringArrayInput `pulumi:"preferredInstanceClasses"`
	// Enable to show only VPC.
	Vpc pulumi.BoolPtrInput `pulumi:"vpc"`
}

func (GetOrderableDbInstanceOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*GetOrderableDbInstanceArgs)(nil)).Elem()
}

// A collection of values returned by getOrderableDbInstance.
type GetOrderableDbInstanceResultOutput struct{ *pulumi.OutputState }

func (GetOrderableDbInstanceResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*GetOrderableDbInstanceResult)(nil)).Elem()
}

func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutput() GetOrderableDbInstanceResultOutput {
	return o
}

func (o GetOrderableDbInstanceResultOutput) ToGetOrderableDbInstanceResultOutputWithContext(ctx context.Context) GetOrderableDbInstanceResultOutput {
	return o
}

// Availability zones where the instance is available.
func (o GetOrderableDbInstanceResultOutput) AvailabilityZones() pulumi.StringArrayOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) []string { return v.AvailabilityZones }).(pulumi.StringArrayOutput)
}

func (o GetOrderableDbInstanceResultOutput) Engine() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) *string { return v.Engine }).(pulumi.StringPtrOutput)
}

func (o GetOrderableDbInstanceResultOutput) EngineVersion() pulumi.StringOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) string { return v.EngineVersion }).(pulumi.StringOutput)
}

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

func (o GetOrderableDbInstanceResultOutput) InstanceClass() pulumi.StringOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) string { return v.InstanceClass }).(pulumi.StringOutput)
}

func (o GetOrderableDbInstanceResultOutput) LicenseModel() pulumi.StringPtrOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) *string { return v.LicenseModel }).(pulumi.StringPtrOutput)
}

func (o GetOrderableDbInstanceResultOutput) PreferredInstanceClasses() pulumi.StringArrayOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) []string { return v.PreferredInstanceClasses }).(pulumi.StringArrayOutput)
}

func (o GetOrderableDbInstanceResultOutput) Vpc() pulumi.BoolOutput {
	return o.ApplyT(func(v GetOrderableDbInstanceResult) bool { return v.Vpc }).(pulumi.BoolOutput)
}

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