Try AWS Native preview for resources not in the classic version.
aws.neptune.ClusterInstance
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
A Cluster Instance Resource defines attributes that are specific to a single instance in a Neptune Cluster.
You can simply add neptune instances and Neptune manages the replication. You can use the count
meta-parameter to make multiple instances and join them all to the same Neptune Cluster, or you may specify different Cluster Instance resources with various instance_class
sizes.
Example Usage
The following example will create a neptune cluster with two neptune instances(one writer and one reader).
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Neptune.Cluster("default", new()
{
ClusterIdentifier = "neptune-cluster-demo",
Engine = "neptune",
BackupRetentionPeriod = 5,
PreferredBackupWindow = "07:00-09:00",
SkipFinalSnapshot = true,
IamDatabaseAuthenticationEnabled = true,
ApplyImmediately = true,
});
var example = new List<Aws.Neptune.ClusterInstance>();
for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
{
var range = new { Value = rangeIndex };
example.Add(new Aws.Neptune.ClusterInstance($"example-{range.Value}", new()
{
ClusterIdentifier = @default.Id,
Engine = "neptune",
InstanceClass = "db.r4.large",
ApplyImmediately = true,
}));
}
});
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.NewCluster(ctx, "default", &neptune.ClusterArgs{
ClusterIdentifier: pulumi.String("neptune-cluster-demo"),
Engine: pulumi.String("neptune"),
BackupRetentionPeriod: pulumi.Int(5),
PreferredBackupWindow: pulumi.String("07:00-09:00"),
SkipFinalSnapshot: pulumi.Bool(true),
IamDatabaseAuthenticationEnabled: pulumi.Bool(true),
ApplyImmediately: pulumi.Bool(true),
})
if err != nil {
return err
}
var example []*neptune.ClusterInstance
for index := 0; index < 2; index++ {
key0 := index
_ := index
__res, err := neptune.NewClusterInstance(ctx, fmt.Sprintf("example-%v", key0), &neptune.ClusterInstanceArgs{
ClusterIdentifier: _default.ID(),
Engine: pulumi.String("neptune"),
InstanceClass: pulumi.String("db.r4.large"),
ApplyImmediately: pulumi.Bool(true),
})
if err != nil {
return err
}
example = append(example, __res)
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.Cluster;
import com.pulumi.aws.neptune.ClusterArgs;
import com.pulumi.aws.neptune.ClusterInstance;
import com.pulumi.aws.neptune.ClusterInstanceArgs;
import com.pulumi.codegen.internal.KeyedValue;
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) {
var default_ = new Cluster("default", ClusterArgs.builder()
.clusterIdentifier("neptune-cluster-demo")
.engine("neptune")
.backupRetentionPeriod(5)
.preferredBackupWindow("07:00-09:00")
.skipFinalSnapshot(true)
.iamDatabaseAuthenticationEnabled(true)
.applyImmediately(true)
.build());
for (var i = 0; i < 2; i++) {
new ClusterInstance("example-" + i, ClusterInstanceArgs.builder()
.clusterIdentifier(default_.id())
.engine("neptune")
.instanceClass("db.r4.large")
.applyImmediately(true)
.build());
}
}
}
import pulumi
import pulumi_aws as aws
default = aws.neptune.Cluster("default",
cluster_identifier="neptune-cluster-demo",
engine="neptune",
backup_retention_period=5,
preferred_backup_window="07:00-09:00",
skip_final_snapshot=True,
iam_database_authentication_enabled=True,
apply_immediately=True)
example = []
for range in [{"value": i} for i in range(0, 2)]:
example.append(aws.neptune.ClusterInstance(f"example-{range['value']}",
cluster_identifier=default.id,
engine="neptune",
instance_class="db.r4.large",
apply_immediately=True))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.neptune.Cluster("default", {
clusterIdentifier: "neptune-cluster-demo",
engine: "neptune",
backupRetentionPeriod: 5,
preferredBackupWindow: "07:00-09:00",
skipFinalSnapshot: true,
iamDatabaseAuthenticationEnabled: true,
applyImmediately: true,
});
const example: aws.neptune.ClusterInstance[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
example.push(new aws.neptune.ClusterInstance(`example-${range.value}`, {
clusterIdentifier: _default.id,
engine: "neptune",
instanceClass: "db.r4.large",
applyImmediately: true,
}));
}
resources:
default:
type: aws:neptune:Cluster
properties:
clusterIdentifier: neptune-cluster-demo
engine: neptune
backupRetentionPeriod: 5
preferredBackupWindow: 07:00-09:00
skipFinalSnapshot: true
iamDatabaseAuthenticationEnabled: true
applyImmediately: true
example:
type: aws:neptune:ClusterInstance
properties:
clusterIdentifier: ${default.id}
engine: neptune
instanceClass: db.r4.large
applyImmediately: true
options: {}
Create ClusterInstance Resource
new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: CustomResourceOptions);
@overload
def ClusterInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
apply_immediately: Optional[bool] = None,
auto_minor_version_upgrade: Optional[bool] = None,
availability_zone: Optional[str] = None,
cluster_identifier: Optional[str] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
identifier: Optional[str] = None,
identifier_prefix: Optional[str] = None,
instance_class: Optional[str] = None,
neptune_parameter_group_name: Optional[str] = None,
neptune_subnet_group_name: Optional[str] = None,
port: Optional[int] = None,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
promotion_tier: Optional[int] = None,
publicly_accessible: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterInstance(resource_name: str,
args: ClusterInstanceArgs,
opts: Optional[ResourceOptions] = None)
func NewClusterInstance(ctx *Context, name string, args ClusterInstanceArgs, opts ...ResourceOption) (*ClusterInstance, error)
public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions? opts = null)
public ClusterInstance(String name, ClusterInstanceArgs args)
public ClusterInstance(String name, ClusterInstanceArgs args, CustomResourceOptions options)
type: aws:neptune:ClusterInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ClusterInstance resource accepts the following input properties:
- Cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- Instance
Class string The instance class to use.
- Apply
Immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- Availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- Engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- Engine
Version string The neptune engine version.
- Identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- Neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- Port int
The port on which the DB accepts connections. Defaults to
8182
.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default is
false
.- Dictionary<string, string>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- Instance
Class string The instance class to use.
- Apply
Immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- Availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- Engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- Engine
Version string The neptune engine version.
- Identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- Neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- Port int
The port on which the DB accepts connections. Defaults to
8182
.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default is
false
.- map[string]string
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier String The identifier of the
aws.neptune.Cluster
in which to launch this instance.- instance
Class String The instance class to use.
- apply
Immediately Boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone String The EC2 Availability Zone that the neptune instance is created in.
- engine String
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version String The neptune engine version.
- identifier String
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- neptune
Parameter StringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet StringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port Integer
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Integer Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- Map<String,String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- instance
Class string The instance class to use.
- apply
Immediately boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version string The neptune engine version.
- identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port number
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default is
false
.- {[key: string]: string}
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster_
identifier str The identifier of the
aws.neptune.Cluster
in which to launch this instance.- instance_
class str The instance class to use.
- apply_
immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto_
minor_ boolversion_ upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability_
zone str The EC2 Availability Zone that the neptune instance is created in.
- engine str
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine_
version str The neptune engine version.
- identifier str
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier_
prefix str Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- neptune_
parameter_ strgroup_ name The name of the neptune parameter group to associate with this instance.
- neptune_
subnet_ strgroup_ name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port int
The port on which the DB accepts connections. Defaults to
8182
.- preferred_
backup_ strwindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred_
maintenance_ strwindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion_
tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly_
accessible bool Bool to control if instance is publicly accessible. Default is
false
.- Mapping[str, str]
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier String The identifier of the
aws.neptune.Cluster
in which to launch this instance.- instance
Class String The instance class to use.
- apply
Immediately Boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone String The EC2 Availability Zone that the neptune instance is created in.
- engine String
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version String The neptune engine version.
- identifier String
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- neptune
Parameter StringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet StringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port Number
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- Map<String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterInstance resource produces the following output properties:
- Address string
The hostname of the instance. See also
endpoint
andport
.- Arn string
Amazon Resource Name (ARN) of neptune instance
- Dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- Endpoint string
The connection endpoint in
address:port
format.- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- Storage
Encrypted bool Specifies whether the neptune cluster is encrypted.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- Address string
The hostname of the instance. See also
endpoint
andport
.- Arn string
Amazon Resource Name (ARN) of neptune instance
- Dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- Endpoint string
The connection endpoint in
address:port
format.- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- Storage
Encrypted bool Specifies whether the neptune cluster is encrypted.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address String
The hostname of the instance. See also
endpoint
andport
.- arn String
Amazon Resource Name (ARN) of neptune instance
- dbi
Resource StringId The region-unique, immutable identifier for the neptune instance.
- endpoint String
The connection endpoint in
address:port
format.- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- storage
Encrypted Boolean Specifies whether the neptune cluster is encrypted.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address string
The hostname of the instance. See also
endpoint
andport
.- arn string
Amazon Resource Name (ARN) of neptune instance
- dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- endpoint string
The connection endpoint in
address:port
format.- id string
The provider-assigned unique ID for this managed resource.
- kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- storage
Encrypted boolean Specifies whether the neptune cluster is encrypted.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address str
The hostname of the instance. See also
endpoint
andport
.- arn str
Amazon Resource Name (ARN) of neptune instance
- dbi_
resource_ strid The region-unique, immutable identifier for the neptune instance.
- endpoint str
The connection endpoint in
address:port
format.- id str
The provider-assigned unique ID for this managed resource.
- kms_
key_ strarn The ARN for the KMS encryption key if one is set to the neptune cluster.
- storage_
encrypted bool Specifies whether the neptune cluster is encrypted.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address String
The hostname of the instance. See also
endpoint
andport
.- arn String
Amazon Resource Name (ARN) of neptune instance
- dbi
Resource StringId The region-unique, immutable identifier for the neptune instance.
- endpoint String
The connection endpoint in
address:port
format.- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- storage
Encrypted Boolean Specifies whether the neptune cluster is encrypted.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
Look up Existing ClusterInstance Resource
Get an existing ClusterInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ClusterInstanceState, opts?: CustomResourceOptions): ClusterInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
apply_immediately: Optional[bool] = None,
arn: Optional[str] = None,
auto_minor_version_upgrade: Optional[bool] = None,
availability_zone: Optional[str] = None,
cluster_identifier: Optional[str] = None,
dbi_resource_id: Optional[str] = None,
endpoint: Optional[str] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
identifier: Optional[str] = None,
identifier_prefix: Optional[str] = None,
instance_class: Optional[str] = None,
kms_key_arn: Optional[str] = None,
neptune_parameter_group_name: Optional[str] = None,
neptune_subnet_group_name: Optional[str] = None,
port: Optional[int] = None,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
promotion_tier: Optional[int] = None,
publicly_accessible: Optional[bool] = None,
storage_encrypted: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
writer: Optional[bool] = None) -> ClusterInstance
func GetClusterInstance(ctx *Context, name string, id IDInput, state *ClusterInstanceState, opts ...ResourceOption) (*ClusterInstance, error)
public static ClusterInstance Get(string name, Input<string> id, ClusterInstanceState? state, CustomResourceOptions? opts = null)
public static ClusterInstance get(String name, Output<String> id, ClusterInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Address string
The hostname of the instance. See also
endpoint
andport
.- Apply
Immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
Amazon Resource Name (ARN) of neptune instance
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- Availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- Cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- Dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- Endpoint string
The connection endpoint in
address:port
format.- Engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- Engine
Version string The neptune engine version.
- Identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class string The instance class to use.
- Kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- Neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- Neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- Port int
The port on which the DB accepts connections. Defaults to
8182
.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default is
false
.- Storage
Encrypted bool Specifies whether the neptune cluster is encrypted.
- Dictionary<string, string>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- Address string
The hostname of the instance. See also
endpoint
andport
.- Apply
Immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
Amazon Resource Name (ARN) of neptune instance
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- Availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- Cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- Dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- Endpoint string
The connection endpoint in
address:port
format.- Engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- Engine
Version string The neptune engine version.
- Identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class string The instance class to use.
- Kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- Neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- Neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- Port int
The port on which the DB accepts connections. Defaults to
8182
.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default is
false
.- Storage
Encrypted bool Specifies whether the neptune cluster is encrypted.
- map[string]string
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address String
The hostname of the instance. See also
endpoint
andport
.- apply
Immediately Boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
Amazon Resource Name (ARN) of neptune instance
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone String The EC2 Availability Zone that the neptune instance is created in.
- cluster
Identifier String The identifier of the
aws.neptune.Cluster
in which to launch this instance.- dbi
Resource StringId The region-unique, immutable identifier for the neptune instance.
- endpoint String
The connection endpoint in
address:port
format.- engine String
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version String The neptune engine version.
- identifier String
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class String The instance class to use.
- kms
Key StringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- neptune
Parameter StringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet StringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port Integer
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Integer Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- storage
Encrypted Boolean Specifies whether the neptune cluster is encrypted.
- Map<String,String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address string
The hostname of the instance. See also
endpoint
andport
.- apply
Immediately boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn string
Amazon Resource Name (ARN) of neptune instance
- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone string The EC2 Availability Zone that the neptune instance is created in.
- cluster
Identifier string The identifier of the
aws.neptune.Cluster
in which to launch this instance.- dbi
Resource stringId The region-unique, immutable identifier for the neptune instance.
- endpoint string
The connection endpoint in
address:port
format.- engine string
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version string The neptune engine version.
- identifier string
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class string The instance class to use.
- kms
Key stringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- neptune
Parameter stringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet stringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port number
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default is
false
.- storage
Encrypted boolean Specifies whether the neptune cluster is encrypted.
- {[key: string]: string}
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address str
The hostname of the instance. See also
endpoint
andport
.- apply_
immediately bool Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn str
Amazon Resource Name (ARN) of neptune instance
- auto_
minor_ boolversion_ upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability_
zone str The EC2 Availability Zone that the neptune instance is created in.
- cluster_
identifier str The identifier of the
aws.neptune.Cluster
in which to launch this instance.- dbi_
resource_ strid The region-unique, immutable identifier for the neptune instance.
- endpoint str
The connection endpoint in
address:port
format.- engine str
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine_
version str The neptune engine version.
- identifier str
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier_
prefix str Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance_
class str The instance class to use.
- kms_
key_ strarn The ARN for the KMS encryption key if one is set to the neptune cluster.
- neptune_
parameter_ strgroup_ name The name of the neptune parameter group to associate with this instance.
- neptune_
subnet_ strgroup_ name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port int
The port on which the DB accepts connections. Defaults to
8182
.- preferred_
backup_ strwindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred_
maintenance_ strwindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion_
tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly_
accessible bool Bool to control if instance is publicly accessible. Default is
false
.- storage_
encrypted bool Specifies whether the neptune cluster is encrypted.
- Mapping[str, str]
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- address String
The hostname of the instance. See also
endpoint
andport
.- apply
Immediately Boolean Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
Amazon Resource Name (ARN) of neptune instance
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true
.- availability
Zone String The EC2 Availability Zone that the neptune instance is created in.
- cluster
Identifier String The identifier of the
aws.neptune.Cluster
in which to launch this instance.- dbi
Resource StringId The region-unique, immutable identifier for the neptune instance.
- endpoint String
The connection endpoint in
address:port
format.- engine String
The name of the database engine to be used for the neptune instance. Defaults to
neptune
. Valid Values:neptune
.- engine
Version String The neptune engine version.
- identifier String
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class String The instance class to use.
- kms
Key StringArn The ARN for the KMS encryption key if one is set to the neptune cluster.
- neptune
Parameter StringGroup Name The name of the neptune parameter group to associate with this instance.
- neptune
Subnet StringGroup Name A subnet group to associate with this neptune instance. NOTE: This must match the
neptune_subnet_group_name
of the attachedaws.neptune.Cluster
.- port Number
The port on which the DB accepts connections. Defaults to
8182
.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- storage
Encrypted Boolean Specifies whether the neptune cluster is encrypted.
- Map<String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
Import
aws_neptune_cluster_instance
can be imported by using the instance identifier, e.g.,
$ pulumi import aws:neptune/clusterInstance:ClusterInstance example my-instance
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.