Fork me on GitHub

Module neptune

@pulumi/aws > neptune

Index

neptune/cluster.ts neptune/clusterInstance.ts neptune/clusterParameterGroup.ts neptune/clusterSnapshot.ts neptune/eventSubscription.ts neptune/parameterGroup.ts neptune/subnetGroup.ts

class Cluster

Provides an Neptune Cluster Resource. A Cluster Resource defines attributes that are applied to the entire cluster of Neptune Cluster Instances.

Changes to a Neptune Cluster can occur when you manually change a parameter, such as backup_retention_period, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property arn

public arn: pulumi.Output<string>;

The Neptune Cluster Amazon Resource Name (ARN)

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.

property backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<number | undefined>;

The days to retain backups for. Default 1

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The cluster identifier. If omitted, Terraform will assign a random, unique identifier.

property clusterIdentifierPrefix

public clusterIdentifierPrefix: pulumi.Output<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.

property clusterMembers

public clusterMembers: pulumi.Output<string[]>;

List of Neptune Instances that are a part of this cluster

property clusterResourceId

public clusterResourceId: pulumi.Output<string>;

The Neptune Cluster Resource ID

property endpoint

public endpoint: pulumi.Output<string>;

The DNS address of the Neptune instance

property engine

public engine: pulumi.Output<string | undefined>;

The name of the database engine to be used for this Neptune cluster. Defaults to neptune.

property engineVersion

public engineVersion: pulumi.Output<string>;

The database engine version.

property finalSnapshotIdentifier

public finalSnapshotIdentifier: pulumi.Output<string | undefined>;

The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

property hostedZoneId

public hostedZoneId: pulumi.Output<string>;

The Route53 Hosted Zone ID of the endpoint

property iamDatabaseAuthenticationEnabled

public iamDatabaseAuthenticationEnabled: pulumi.Output<boolean | undefined>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

property iamRoles

public iamRoles: pulumi.Output<string[] | undefined>;

A List of ARNs for the IAM roles to associate to the Neptune Cluster.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string>;

The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.

property neptuneClusterParameterGroupName

public neptuneClusterParameterGroupName: pulumi.Output<string | undefined>;

A cluster parameter group to associate with the cluster.

property neptuneSubnetGroupName

public neptuneSubnetGroupName: pulumi.Output<string>;

A Neptune subnet group to associate with this Neptune instance.

property port

public port: pulumi.Output<number | undefined>;

The port on which the Neptune accepts connections. Default is 8182.

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property readerEndpoint

public readerEndpoint: pulumi.Output<string>;

A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas

property replicationSourceIdentifier

public replicationSourceIdentifier: pulumi.Output<string | undefined>;

ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

property skipFinalSnapshot

public skipFinalSnapshot: pulumi.Output<boolean | undefined>;

Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from final_snapshot_identifier. Default is false.

property snapshotIdentifier

public snapshotIdentifier: pulumi.Output<string | undefined>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean | undefined>;

Specifies whether the Neptune cluster is encrypted. The default is false if not specified.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the Neptune cluster.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

List of VPC security groups to associate with the Cluster

class ClusterInstance

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][1] 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.

constructor

new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterInstance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterInstanceState): ClusterInstance

Get an existing ClusterInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The hostname of the instance. See also endpoint and port.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of neptune instance

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean | undefined>;

Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The EC2 Availability Zone that the neptune instance is created in.

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The identifier of the aws_neptune_cluster in which to launch this instance.

property dbiResourceId

public dbiResourceId: pulumi.Output<string>;

The region-unique, immutable identifier for the neptune instance.

property endpoint

public endpoint: pulumi.Output<string>;

The connection endpoint in address:port format.

property engine

public engine: pulumi.Output<string | undefined>;

The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune.

property engineVersion

public engineVersion: pulumi.Output<string>;

The neptune engine version.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifier

public identifier: pulumi.Output<string>;

The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.

property identifierPrefix

public identifierPrefix: pulumi.Output<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

public instanceClass: pulumi.Output<string>;

The instance class to use.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string>;

The ARN for the KMS encryption key if one is set to the neptune cluster.

property neptuneParameterGroupName

public neptuneParameterGroupName: pulumi.Output<string | undefined>;

The name of the neptune parameter group to associate with this instance.

property neptuneSubnetGroupName

public neptuneSubnetGroupName: pulumi.Output<string>;

A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached aws_neptune_cluster.

property port

public port: pulumi.Output<number | undefined>;

The port on which the DB accepts connections. Defaults to 8182.

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

public promotionTier: pulumi.Output<number | undefined>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean | undefined>;

Bool to control if instance is publicly accessible. Default is false.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the neptune cluster is encrypted.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property writer

public writer: pulumi.Output<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

class ClusterParameterGroup

Manages a Neptune Cluster Parameter Group

constructor

new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterParameterGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterParameterGroupState): ClusterParameterGroup

Get an existing ClusterParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the neptune cluster parameter group.

property description

public description: pulumi.Output<string | undefined>;

The description of the neptune cluster parameter group. Defaults to “Managed by Terraform”.

property family

public family: pulumi.Output<string>;

The family of the neptune cluster parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the neptune parameter.

property namePrefix

public namePrefix: pulumi.Output<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

public parameters: pulumi.Output<{ ... }[] | undefined>;

A list of neptune parameters to apply.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ClusterSnapshot

Manages a Neptune database cluster snapshot.

constructor

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterSnapshot resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterSnapshotState): ClusterSnapshot

Get an existing ClusterSnapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedStorage

public allocatedStorage: pulumi.Output<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

property dbClusterIdentifier

public dbClusterIdentifier: pulumi.Output<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

public dbClusterSnapshotArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

property dbClusterSnapshotIdentifier

public dbClusterSnapshotIdentifier: pulumi.Output<string>;

The Identifier for the snapshot.

property engine

public engine: pulumi.Output<string>;

Specifies the name of the database engine.

property engineVersion

public engineVersion: pulumi.Output<string>;

Version of the database engine for this DB cluster snapshot.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

property licenseModel

public licenseModel: pulumi.Output<string>;

License model information for the restored DB cluster.

property port

public port: pulumi.Output<number>;

Port that the DB cluster was listening on at the time of the snapshot.

property snapshotType

public snapshotType: pulumi.Output<string>;

property sourceDbClusterSnapshotArn

public sourceDbClusterSnapshotArn: pulumi.Output<string>;

property status

public status: pulumi.Output<string>;

The status of this DB Cluster Snapshot.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the DB cluster snapshot is encrypted.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The VPC ID associated with the DB cluster snapshot.

class EventSubscription

constructor

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState): EventSubscription

Get an existing EventSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property customerAwsId

public customerAwsId: pulumi.Output<string>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

public eventCategories: pulumi.Output<string[] | undefined>;

A list of event categories for a source_type that you want to subscribe to. Run aws neptune describe-event-categories to find all the event categories.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Neptune event subscription. By default generated by Terraform.

property namePrefix

public namePrefix: pulumi.Output<string>;

The name of the Neptune event subscription. Conflicts with name.

property snsTopicArn

public snsTopicArn: pulumi.Output<string>;

The ARN of the SNS topic to send events to.

property sourceIds

public sourceIds: pulumi.Output<string[] | undefined>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.

property sourceType

public sourceType: pulumi.Output<string | undefined>;

The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. If not set, all sources will be subscribed to.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ParameterGroup

Manages a Neptune Parameter Group

constructor

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ParameterGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState): ParameterGroup

Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Neptune parameter group Amazon Resource Name (ARN).

property description

public description: pulumi.Output<string | undefined>;

The description of the Neptune parameter group. Defaults to “Managed by Terraform”.

property family

public family: pulumi.Output<string>;

The family of the Neptune parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Neptune parameter.

property parameters

public parameters: pulumi.Output<{ ... }[] | undefined>;

A list of Neptune parameters to apply.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class SubnetGroup

Provides an Neptune subnet group resource.

constructor

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetGroupState): SubnetGroup

Get an existing SubnetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the neptune subnet group.

property description

public description: pulumi.Output<string | undefined>;

The description of the neptune subnet group. Defaults to “Managed by Terraform”.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.

property namePrefix

public namePrefix: pulumi.Output<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

A list of VPC subnet IDs.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, Terraform will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for this Neptune cluster. Defaults to neptune.

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

A List of ARNs for the IAM roles to associate to the Neptune Cluster.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.

property neptuneClusterParameterGroupName

neptuneClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property neptuneSubnetGroupName

neptuneSubnetGroupName?: pulumi.Input<string>;

A Neptune subnet group to associate with this Neptune instance.

property port

port?: pulumi.Input<number>;

The port on which the Neptune accepts connections. Default is 8182.

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property replicationSourceIdentifier

replicationSourceIdentifier?: pulumi.Input<string>;

ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from final_snapshot_identifier. Default is false.

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the Neptune cluster is encrypted. The default is false if not specified.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the Neptune cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

interface ClusterInstanceArgs

The set of arguments for constructing a ClusterInstance resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the neptune instance is created in.

property clusterIdentifier

clusterIdentifier: pulumi.Input<string>;

The identifier of the aws_neptune_cluster in which to launch this instance.

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune.

property engineVersion

engineVersion?: pulumi.Input<string>;

The neptune engine version.

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

instanceClass: pulumi.Input<string>;

The instance class to use.

property neptuneParameterGroupName

neptuneParameterGroupName?: pulumi.Input<string>;

The name of the neptune parameter group to associate with this instance.

property neptuneSubnetGroupName

neptuneSubnetGroupName?: pulumi.Input<string>;

A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached aws_neptune_cluster.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections. Defaults to 8182.

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

Bool to control if instance is publicly accessible. Default is false.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the instance.

interface ClusterInstanceState

Input properties used for looking up and filtering ClusterInstance resources.

property address

address?: pulumi.Input<string>;

The hostname of the instance. See also endpoint and port.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of neptune instance

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the neptune instance is created in.

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The identifier of the aws_neptune_cluster in which to launch this instance.

property dbiResourceId

dbiResourceId?: pulumi.Input<string>;

The region-unique, immutable identifier for the neptune instance.

property endpoint

endpoint?: pulumi.Input<string>;

The connection endpoint in address:port format.

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune.

property engineVersion

engineVersion?: pulumi.Input<string>;

The neptune engine version.

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

instanceClass?: pulumi.Input<string>;

The instance class to use.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

The ARN for the KMS encryption key if one is set to the neptune cluster.

property neptuneParameterGroupName

neptuneParameterGroupName?: pulumi.Input<string>;

The name of the neptune parameter group to associate with this instance.

property neptuneSubnetGroupName

neptuneSubnetGroupName?: pulumi.Input<string>;

A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached aws_neptune_cluster.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections. Defaults to 8182.

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

Bool to control if instance is publicly accessible. Default is false.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the neptune cluster is encrypted.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the instance.

property writer

writer?: pulumi.Input<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

interface ClusterParameterGroupArgs

The set of arguments for constructing a ClusterParameterGroup resource.

property description

description?: pulumi.Input<string>;

The description of the neptune cluster parameter group. Defaults to “Managed by Terraform”.

property family

family: pulumi.Input<string>;

The family of the neptune cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the neptune parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of neptune parameters to apply.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ClusterParameterGroupState

Input properties used for looking up and filtering ClusterParameterGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the neptune cluster parameter group.

property description

description?: pulumi.Input<string>;

The description of the neptune cluster parameter group. Defaults to “Managed by Terraform”.

property family

family?: pulumi.Input<string>;

The family of the neptune cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the neptune parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of neptune parameters to apply.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ClusterSnapshotArgs

The set of arguments for constructing a ClusterSnapshot resource.

property dbClusterIdentifier

dbClusterIdentifier: pulumi.Input<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier: pulumi.Input<string>;

The Identifier for the snapshot.

interface ClusterSnapshotState

Input properties used for looking up and filtering ClusterSnapshot resources.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

property dbClusterIdentifier

dbClusterIdentifier?: pulumi.Input<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

dbClusterSnapshotArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier?: pulumi.Input<string>;

The Identifier for the snapshot.

property engine

engine?: pulumi.Input<string>;

Specifies the name of the database engine.

property engineVersion

engineVersion?: pulumi.Input<string>;

Version of the database engine for this DB cluster snapshot.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

property licenseModel

licenseModel?: pulumi.Input<string>;

License model information for the restored DB cluster.

property port

port?: pulumi.Input<number>;

Port that the DB cluster was listening on at the time of the snapshot.

property snapshotType

snapshotType?: pulumi.Input<string>;

property sourceDbClusterSnapshotArn

sourceDbClusterSnapshotArn?: pulumi.Input<string>;

property status

status?: pulumi.Input<string>;

The status of this DB Cluster Snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster snapshot is encrypted.

property vpcId

vpcId?: pulumi.Input<string>;

The VPC ID associated with the DB cluster snapshot.

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property arn

arn?: pulumi.Input<string>;

The Neptune Cluster Amazon Resource Name (ARN)

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, Terraform will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifer.

property clusterMembers

clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of Neptune Instances that are a part of this cluster

property clusterResourceId

clusterResourceId?: pulumi.Input<string>;

The Neptune Cluster Resource ID

property endpoint

endpoint?: pulumi.Input<string>;

The DNS address of the Neptune instance

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for this Neptune cluster. Defaults to neptune.

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.

property hostedZoneId

hostedZoneId?: pulumi.Input<string>;

The Route53 Hosted Zone ID of the endpoint

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

A List of ARNs for the IAM roles to associate to the Neptune Cluster.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.

property neptuneClusterParameterGroupName

neptuneClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property neptuneSubnetGroupName

neptuneSubnetGroupName?: pulumi.Input<string>;

A Neptune subnet group to associate with this Neptune instance.

property port

port?: pulumi.Input<number>;

The port on which the Neptune accepts connections. Default is 8182.

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property readerEndpoint

readerEndpoint?: pulumi.Input<string>;

A read-only endpoint for the Neptune cluster, automatically load-balanced across replicas

property replicationSourceIdentifier

replicationSourceIdentifier?: pulumi.Input<string>;

ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

Determines whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from final_snapshot_identifier. Default is false.

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the Neptune cluster is encrypted. The default is false if not specified.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the Neptune cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

interface EventSubscriptionArgs

The set of arguments for constructing a EventSubscription resource.

property enabled

enabled?: pulumi.Input<boolean>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

A list of event categories for a source_type that you want to subscribe to. Run aws neptune describe-event-categories to find all the event categories.

property name

name?: pulumi.Input<string>;

The name of the Neptune event subscription. By default generated by Terraform.

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the Neptune event subscription. Conflicts with name.

property snsTopicArn

snsTopicArn: pulumi.Input<string>;

The ARN of the SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.

property sourceType

sourceType?: pulumi.Input<string>;

The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. If not set, all sources will be subscribed to.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface EventSubscriptionState

Input properties used for looking up and filtering EventSubscription resources.

property arn

arn?: pulumi.Input<string>;

property customerAwsId

customerAwsId?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

A list of event categories for a source_type that you want to subscribe to. Run aws neptune describe-event-categories to find all the event categories.

property name

name?: pulumi.Input<string>;

The name of the Neptune event subscription. By default generated by Terraform.

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the Neptune event subscription. Conflicts with name.

property snsTopicArn

snsTopicArn?: pulumi.Input<string>;

The ARN of the SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.

property sourceType

sourceType?: pulumi.Input<string>;

The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. If not set, all sources will be subscribed to.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface ParameterGroupArgs

The set of arguments for constructing a ParameterGroup resource.

property description

description?: pulumi.Input<string>;

The description of the Neptune parameter group. Defaults to “Managed by Terraform”.

property family

family: pulumi.Input<string>;

The family of the Neptune parameter group.

property name

name?: pulumi.Input<string>;

The name of the Neptune parameter.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of Neptune parameters to apply.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface ParameterGroupState

Input properties used for looking up and filtering ParameterGroup resources.

property arn

arn?: pulumi.Input<string>;

The Neptune parameter group Amazon Resource Name (ARN).

property description

description?: pulumi.Input<string>;

The description of the Neptune parameter group. Defaults to “Managed by Terraform”.

property family

family?: pulumi.Input<string>;

The family of the Neptune parameter group.

property name

name?: pulumi.Input<string>;

The name of the Neptune parameter.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of Neptune parameters to apply.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface SubnetGroupArgs

The set of arguments for constructing a SubnetGroup resource.

property description

description?: pulumi.Input<string>;

The description of the neptune subnet group. Defaults to “Managed by Terraform”.

property name

name?: pulumi.Input<string>;

The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface SubnetGroupState

Input properties used for looking up and filtering SubnetGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the neptune subnet group.

property description

description?: pulumi.Input<string>;

The description of the neptune subnet group. Defaults to “Managed by Terraform”.

property name

name?: pulumi.Input<string>;

The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.