Docs Packages
  1. Pulumi Registry
  2. AWS Classic
  3. API Docs
  4. neptune
  5. getOrderableDbInstance
aws logo
AWS Classic v5.41.0, May 15 23

aws.neptune.getOrderableDbInstance

Explore with Pulumi AI

Information about Neptune orderable DB instances.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Neptune.GetOrderableDbInstance.Invoke(new()
    {
        EngineVersion = "1.0.3.0",
        PreferredInstanceClasses = new[]
        {
            "db.r5.large",
            "db.r4.large",
            "db.t3.medium",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/neptune"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := neptune.GetOrderableDbInstance(ctx, &neptune.GetOrderableDbInstanceArgs{
			EngineVersion: pulumi.StringRef("1.0.3.0"),
			PreferredInstanceClasses: []string{
				"db.r5.large",
				"db.r4.large",
				"db.t3.medium",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.NeptuneFunctions;
import com.pulumi.aws.neptune.inputs.GetOrderableDbInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = NeptuneFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
            .engineVersion("1.0.3.0")
            .preferredInstanceClasses(            
                "db.r5.large",
                "db.r4.large",
                "db.t3.medium")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.neptune.get_orderable_db_instance(engine_version="1.0.3.0",
    preferred_instance_classes=[
        "db.r5.large",
        "db.r4.large",
        "db.t3.medium",
    ])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.neptune.getOrderableDbInstance({
    engineVersion: "1.0.3.0",
    preferredInstanceClasses: [
        "db.r5.large",
        "db.r4.large",
        "db.t3.medium",
    ],
});

variables:
  test:
    fn::invoke:
      Function: aws:neptune:getOrderableDbInstance
      Arguments:
        engineVersion: 1.0.3.0
        preferredInstanceClasses:
          - db.r5.large
          - db.r4.large
          - db.t3.medium

Using getOrderableDbInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getOrderableDbInstance(args: GetOrderableDbInstanceArgs, opts?: InvokeOptions): Promise<GetOrderableDbInstanceResult>
function getOrderableDbInstanceOutput(args: GetOrderableDbInstanceOutputArgs, opts?: InvokeOptions): Output<GetOrderableDbInstanceResult>
def get_orderable_db_instance(engine: Optional[str] = None,
                              engine_version: Optional[str] = None,
                              instance_class: Optional[str] = None,
                              license_model: Optional[str] = None,
                              preferred_instance_classes: Optional[Sequence[str]] = None,
                              vpc: Optional[bool] = None,
                              opts: Optional[InvokeOptions] = None) -> GetOrderableDbInstanceResult
def get_orderable_db_instance_output(engine: Optional[pulumi.Input[str]] = None,
                              engine_version: Optional[pulumi.Input[str]] = None,
                              instance_class: Optional[pulumi.Input[str]] = None,
                              license_model: Optional[pulumi.Input[str]] = None,
                              preferred_instance_classes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              vpc: Optional[pulumi.Input[bool]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetOrderableDbInstanceResult]
func GetOrderableDbInstance(ctx *Context, args *GetOrderableDbInstanceArgs, opts ...InvokeOption) (*GetOrderableDbInstanceResult, error)
func GetOrderableDbInstanceOutput(ctx *Context, args *GetOrderableDbInstanceOutputArgs, opts ...InvokeOption) GetOrderableDbInstanceResultOutput

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

public static class GetOrderableDbInstance 
{
    public static Task<GetOrderableDbInstanceResult> InvokeAsync(GetOrderableDbInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetOrderableDbInstanceResult> Invoke(GetOrderableDbInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOrderableDbInstanceResult> getOrderableDbInstance(GetOrderableDbInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:neptune/getOrderableDbInstance:getOrderableDbInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

Engine string

DB engine. (Default: neptune)

EngineVersion string

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

InstanceClass string

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

LicenseModel string

License model. (Default: amazon-license)

PreferredInstanceClasses List<string>

Ordered list of preferred Neptune 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.

Vpc bool

Enable to show only VPC offerings.

Engine string

DB engine. (Default: neptune)

EngineVersion string

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

InstanceClass string

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

LicenseModel string

License model. (Default: amazon-license)

PreferredInstanceClasses []string

Ordered list of preferred Neptune 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.

Vpc bool

Enable to show only VPC offerings.

engine String

DB engine. (Default: neptune)

engineVersion String

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

instanceClass String

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

licenseModel String

License model. (Default: amazon-license)

preferredInstanceClasses List<String>

Ordered list of preferred Neptune 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.

vpc Boolean

Enable to show only VPC offerings.

engine string

DB engine. (Default: neptune)

engineVersion string

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

instanceClass string

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

licenseModel string

License model. (Default: amazon-license)

preferredInstanceClasses string[]

Ordered list of preferred Neptune 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.

vpc boolean

Enable to show only VPC offerings.

engine str

DB engine. (Default: neptune)

engine_version str

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

instance_class str

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

license_model str

License model. (Default: amazon-license)

preferred_instance_classes Sequence[str]

Ordered list of preferred Neptune 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.

vpc bool

Enable to show only VPC offerings.

engine String

DB engine. (Default: neptune)

engineVersion String

Version of the DB engine. For example, 1.0.1.0, 1.0.1.2, 1.0.2.2, and 1.0.3.0.

instanceClass String

DB instance class. Examples of classes are db.r5.large, db.r5.xlarge, db.r4.large, db.r5.4xlarge, db.r5.12xlarge, db.r4.xlarge, and db.t3.medium.

licenseModel String

License model. (Default: amazon-license)

preferredInstanceClasses List<String>

Ordered list of preferred Neptune 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.

vpc Boolean

Enable to show only VPC offerings.

getOrderableDbInstance Result

The following output properties are available:

AvailabilityZones List<string>

Availability zones where the instance is available.

EngineVersion string
Id string

The provider-assigned unique ID for this managed resource.

InstanceClass string
MaxIopsPerDbInstance int

Maximum total provisioned IOPS for a DB instance.

MaxIopsPerGib double

Maximum provisioned IOPS per GiB for a DB instance.

MaxStorageSize int

Maximum storage size for a DB instance.

MinIopsPerDbInstance int

Minimum total provisioned IOPS for a DB instance.

MinIopsPerGib double

Minimum provisioned IOPS per GiB for a DB instance.

MinStorageSize int

Minimum storage size for a DB instance.

MultiAzCapable bool

Whether a DB instance is Multi-AZ capable.

ReadReplicaCapable bool

Whether a DB instance can have a read replica.

StorageType string

Storage type for a DB instance.

SupportsEnhancedMonitoring bool

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

SupportsIamDatabaseAuthentication bool

Whether a DB instance supports IAM database authentication.

SupportsIops bool

Whether a DB instance supports provisioned IOPS.

SupportsPerformanceInsights bool

Whether a DB instance supports Performance Insights.

SupportsStorageEncryption bool

Whether a DB instance supports encrypted storage.

Vpc bool
Engine string
LicenseModel string
PreferredInstanceClasses List<string>
AvailabilityZones []string

Availability zones where the instance is available.

EngineVersion string
Id string

The provider-assigned unique ID for this managed resource.

InstanceClass string
MaxIopsPerDbInstance int

Maximum total provisioned IOPS for a DB instance.

MaxIopsPerGib float64

Maximum provisioned IOPS per GiB for a DB instance.

MaxStorageSize int

Maximum storage size for a DB instance.

MinIopsPerDbInstance int

Minimum total provisioned IOPS for a DB instance.

MinIopsPerGib float64

Minimum provisioned IOPS per GiB for a DB instance.

MinStorageSize int

Minimum storage size for a DB instance.

MultiAzCapable bool

Whether a DB instance is Multi-AZ capable.

ReadReplicaCapable bool

Whether a DB instance can have a read replica.

StorageType string

Storage type for a DB instance.

SupportsEnhancedMonitoring bool

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

SupportsIamDatabaseAuthentication bool

Whether a DB instance supports IAM database authentication.

SupportsIops bool

Whether a DB instance supports provisioned IOPS.

SupportsPerformanceInsights bool

Whether a DB instance supports Performance Insights.

SupportsStorageEncryption bool

Whether a DB instance supports encrypted storage.

Vpc bool
Engine string
LicenseModel string
PreferredInstanceClasses []string
availabilityZones List<String>

Availability zones where the instance is available.

engineVersion String
id String

The provider-assigned unique ID for this managed resource.

instanceClass String
maxIopsPerDbInstance Integer

Maximum total provisioned IOPS for a DB instance.

maxIopsPerGib Double

Maximum provisioned IOPS per GiB for a DB instance.

maxStorageSize Integer

Maximum storage size for a DB instance.

minIopsPerDbInstance Integer

Minimum total provisioned IOPS for a DB instance.

minIopsPerGib Double

Minimum provisioned IOPS per GiB for a DB instance.

minStorageSize Integer

Minimum storage size for a DB instance.

multiAzCapable Boolean

Whether a DB instance is Multi-AZ capable.

readReplicaCapable Boolean

Whether a DB instance can have a read replica.

storageType String

Storage type for a DB instance.

supportsEnhancedMonitoring Boolean

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supportsIamDatabaseAuthentication Boolean

Whether a DB instance supports IAM database authentication.

supportsIops Boolean

Whether a DB instance supports provisioned IOPS.

supportsPerformanceInsights Boolean

Whether a DB instance supports Performance Insights.

supportsStorageEncryption Boolean

Whether a DB instance supports encrypted storage.

vpc Boolean
engine String
licenseModel String
preferredInstanceClasses List<String>
availabilityZones string[]

Availability zones where the instance is available.

engineVersion string
id string

The provider-assigned unique ID for this managed resource.

instanceClass string
maxIopsPerDbInstance number

Maximum total provisioned IOPS for a DB instance.

maxIopsPerGib number

Maximum provisioned IOPS per GiB for a DB instance.

maxStorageSize number

Maximum storage size for a DB instance.

minIopsPerDbInstance number

Minimum total provisioned IOPS for a DB instance.

minIopsPerGib number

Minimum provisioned IOPS per GiB for a DB instance.

minStorageSize number

Minimum storage size for a DB instance.

multiAzCapable boolean

Whether a DB instance is Multi-AZ capable.

readReplicaCapable boolean

Whether a DB instance can have a read replica.

storageType string

Storage type for a DB instance.

supportsEnhancedMonitoring boolean

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supportsIamDatabaseAuthentication boolean

Whether a DB instance supports IAM database authentication.

supportsIops boolean

Whether a DB instance supports provisioned IOPS.

supportsPerformanceInsights boolean

Whether a DB instance supports Performance Insights.

supportsStorageEncryption boolean

Whether a DB instance supports encrypted storage.

vpc boolean
engine string
licenseModel string
preferredInstanceClasses string[]
availability_zones Sequence[str]

Availability zones where the instance is available.

engine_version str
id str

The provider-assigned unique ID for this managed resource.

instance_class str
max_iops_per_db_instance int

Maximum total provisioned IOPS for a DB instance.

max_iops_per_gib float

Maximum provisioned IOPS per GiB for a DB instance.

max_storage_size int

Maximum storage size for a DB instance.

min_iops_per_db_instance int

Minimum total provisioned IOPS for a DB instance.

min_iops_per_gib float

Minimum provisioned IOPS per GiB for a DB instance.

min_storage_size int

Minimum storage size for a DB instance.

multi_az_capable bool

Whether a DB instance is Multi-AZ capable.

read_replica_capable bool

Whether a DB instance can have a read replica.

storage_type str

Storage type for a DB instance.

supports_enhanced_monitoring bool

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supports_iam_database_authentication bool

Whether a DB instance supports IAM database authentication.

supports_iops bool

Whether a DB instance supports provisioned IOPS.

supports_performance_insights bool

Whether a DB instance supports Performance Insights.

supports_storage_encryption bool

Whether a DB instance supports encrypted storage.

vpc bool
engine str
license_model str
preferred_instance_classes Sequence[str]
availabilityZones List<String>

Availability zones where the instance is available.

engineVersion String
id String

The provider-assigned unique ID for this managed resource.

instanceClass String
maxIopsPerDbInstance Number

Maximum total provisioned IOPS for a DB instance.

maxIopsPerGib Number

Maximum provisioned IOPS per GiB for a DB instance.

maxStorageSize Number

Maximum storage size for a DB instance.

minIopsPerDbInstance Number

Minimum total provisioned IOPS for a DB instance.

minIopsPerGib Number

Minimum provisioned IOPS per GiB for a DB instance.

minStorageSize Number

Minimum storage size for a DB instance.

multiAzCapable Boolean

Whether a DB instance is Multi-AZ capable.

readReplicaCapable Boolean

Whether a DB instance can have a read replica.

storageType String

Storage type for a DB instance.

supportsEnhancedMonitoring Boolean

Whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supportsIamDatabaseAuthentication Boolean

Whether a DB instance supports IAM database authentication.

supportsIops Boolean

Whether a DB instance supports provisioned IOPS.

supportsPerformanceInsights Boolean

Whether a DB instance supports Performance Insights.

supportsStorageEncryption Boolean

Whether a DB instance supports encrypted storage.

vpc Boolean
engine String
licenseModel String
preferredInstanceClasses List<String>

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.