neptune

class pulumi_aws.neptune.Cluster(resource_name, opts=None, apply_immediately=None, availability_zones=None, backup_retention_period=None, cluster_identifier=None, cluster_identifier_prefix=None, engine=None, engine_version=None, final_snapshot_identifier=None, iam_database_authentication_enabled=None, iam_roles=None, kms_key_arn=None, neptune_cluster_parameter_group_name=None, neptune_subnet_group_name=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, replication_source_identifier=None, skip_final_snapshot=None, snapshot_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None, __name__=None, __opts__=None)

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).

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
  • availability_zones (pulumi.Input[list]) – A list of EC2 Availability Zones that instances in the Neptune cluster can be created in.
  • backup_retention_period (pulumi.Input[int]) – The days to retain backups for. Default 1
  • cluster_identifier (pulumi.Input[str]) – The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
  • cluster_identifier_prefix (pulumi.Input[str]) – Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
  • engine (pulumi.Input[str]) – The name of the database engine to be used for this Neptune cluster. Defaults to neptune.
  • engine_version (pulumi.Input[str]) – The database engine version.
  • final_snapshot_identifier (pulumi.Input[str]) – The name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
  • iam_database_authentication_enabled (pulumi.Input[bool]) – Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
  • iam_roles (pulumi.Input[list]) – A List of ARNs for the IAM roles to associate to the Neptune Cluster.
  • kms_key_arn (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_arn, storage_encrypted needs to be set to true.
  • neptune_cluster_parameter_group_name (pulumi.Input[str]) – A cluster parameter group to associate with the cluster.
  • neptune_subnet_group_name (pulumi.Input[str]) – A Neptune subnet group to associate with this Neptune instance.
  • port (pulumi.Input[int]) – The port on which the Neptune accepts connections. Default is 8182.
  • preferred_backup_window (pulumi.Input[str]) – 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
  • preferred_maintenance_window (pulumi.Input[str]) – The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
  • replication_source_identifier (pulumi.Input[str]) – ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
  • skip_final_snapshot (pulumi.Input[bool]) – 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.
  • snapshot_identifier (pulumi.Input[str]) – 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.
  • storage_encrypted (pulumi.Input[bool]) – Specifies whether the Neptune cluster is encrypted. The default is false if not specified.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the Neptune cluster.
  • vpc_security_group_ids (pulumi.Input[list]) – List of VPC security groups to associate with the Cluster
apply_immediately = None

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

arn = None

The Neptune Cluster Amazon Resource Name (ARN)

availability_zones = None

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

backup_retention_period = None

The days to retain backups for. Default 1

cluster_identifier = None

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

cluster_identifier_prefix = None

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

cluster_members = None

List of Neptune Instances that are a part of this cluster

cluster_resource_id = None

The Neptune Cluster Resource ID

endpoint = None

The DNS address of the Neptune instance

engine = None

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

engine_version = None

The database engine version.

final_snapshot_identifier = None

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

hosted_zone_id = None

The Route53 Hosted Zone ID of the endpoint

iam_database_authentication_enabled = None

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

iam_roles = None

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

kms_key_arn = None

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

neptune_cluster_parameter_group_name = None

A cluster parameter group to associate with the cluster.

neptune_subnet_group_name = None

A Neptune subnet group to associate with this Neptune instance.

port = None

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

preferred_backup_window = None

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

preferred_maintenance_window = None

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

reader_endpoint = None

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

replication_source_identifier = None

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

skip_final_snapshot = None

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.

snapshot_identifier = None

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.

storage_encrypted = None

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

tags = None

A mapping of tags to assign to the Neptune cluster.

vpc_security_group_ids = None

List of VPC security groups to associate with the Cluster

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.ClusterInstance(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, cluster_identifier=None, engine=None, engine_version=None, identifier=None, identifier_prefix=None, instance_class=None, neptune_parameter_group_name=None, neptune_subnet_group_name=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, tags=None, __name__=None, __opts__=None)

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.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.
  • auto_minor_version_upgrade (pulumi.Input[bool]) – Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true.
  • availability_zone (pulumi.Input[str]) – The EC2 Availability Zone that the neptune instance is created in.
  • cluster_identifier (pulumi.Input[str]) – The identifier of the ``aws_neptune_cluster` <https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html>`_ in which to launch this instance.
  • engine (pulumi.Input[str]) – The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune.
  • engine_version (pulumi.Input[str]) – The neptune engine version.
  • identifier (pulumi.Input[str]) – The indentifier for the neptune instance, if omitted, Terraform will assign a random, unique identifier.
  • identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
  • instance_class (pulumi.Input[str]) – The instance class to use.
  • neptune_parameter_group_name (pulumi.Input[str]) – The name of the neptune parameter group to associate with this instance.
  • neptune_subnet_group_name (pulumi.Input[str]) – A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached ``aws_neptune_cluster` <https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html>`_.
  • port (pulumi.Input[int]) – The port on which the DB accepts connections. Defaults to 8182.
  • preferred_backup_window (pulumi.Input[str]) – The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”
  • preferred_maintenance_window (pulumi.Input[str]) – The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.
  • promotion_tier (pulumi.Input[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 (pulumi.Input[bool]) – Bool to control if instance is publicly accessible. Default is false.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the instance.
address = None

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

apply_immediately = None

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

arn = None

Amazon Resource Name (ARN) of neptune instance

auto_minor_version_upgrade = None

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

availability_zone = None

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

cluster_identifier = None

The identifier of the ``aws_neptune_cluster` <https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html>`_ in which to launch this instance.

dbi_resource_id = None

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

endpoint = None

The connection endpoint in address:port format.

engine = None

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

engine_version = None

The neptune engine version.

identifier = None

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

identifier_prefix = None

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

instance_class = None

The instance class to use.

kms_key_arn = None

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

neptune_parameter_group_name = None

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

neptune_subnet_group_name = None

A subnet group to associate with this neptune instance. NOTE: This must match the neptune_subnet_group_name of the attached ``aws_neptune_cluster` <https://www.terraform.io/docs/providers/aws/r/neptune_cluster.html>`_.

port = None

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

preferred_backup_window = None

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

preferred_maintenance_window = None

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

promotion_tier = None

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

publicly_accessible = None

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

storage_encrypted = None

Specifies whether the neptune cluster is encrypted.

tags = None

A mapping of tags to assign to the instance.

writer = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.ClusterParameterGroup(resource_name, opts=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __name__=None, __opts__=None)

Manages a Neptune Cluster Parameter Group

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the neptune cluster parameter group. Defaults to “Managed by Terraform”.
  • family (pulumi.Input[str]) – The family of the neptune cluster parameter group.
  • name (pulumi.Input[str]) – The name of the neptune parameter.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • parameters (pulumi.Input[list]) – A list of neptune parameters to apply.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the neptune cluster parameter group.

description = None

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

family = None

The family of the neptune cluster parameter group.

name = None

The name of the neptune parameter.

name_prefix = None

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

parameters = None

A list of neptune parameters to apply.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.ClusterSnapshot(resource_name, opts=None, db_cluster_identifier=None, db_cluster_snapshot_identifier=None, __name__=None, __opts__=None)

Manages a Neptune database cluster snapshot.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • db_cluster_identifier (pulumi.Input[str]) – The DB Cluster Identifier from which to take the snapshot.
  • db_cluster_snapshot_identifier (pulumi.Input[str]) – The Identifier for the snapshot.
allocated_storage = None

Specifies the allocated storage size in gigabytes (GB).

availability_zones = None

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

db_cluster_identifier = None

The DB Cluster Identifier from which to take the snapshot.

db_cluster_snapshot_arn = None

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

db_cluster_snapshot_identifier = None

The Identifier for the snapshot.

engine = None

Specifies the name of the database engine.

engine_version = None

Version of the database engine for this DB cluster snapshot.

kms_key_id = None

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

license_model = None

License model information for the restored DB cluster.

port = None

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

status = None

The status of this DB Cluster Snapshot.

storage_encrypted = None

Specifies whether the DB cluster snapshot is encrypted.

vpc_id = None

The VPC ID associated with the DB cluster snapshot.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.EventSubscription(resource_name, opts=None, enabled=None, event_categories=None, name=None, name_prefix=None, sns_topic_arn=None, source_ids=None, source_type=None, tags=None, __name__=None, __opts__=None)

The following additional atttributes are provided:

  • id - The name of the Neptune event notification subscription.
  • arn - The Amazon Resource Name of the Neptune event notification subscription.
  • customer_aws_id - The AWS customer account associated with the Neptune event notification subscription.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • enabled (pulumi.Input[bool]) – A boolean flag to enable/disable the subscription. Defaults to true.
  • event_categories (pulumi.Input[list]) – 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.
  • name (pulumi.Input[str]) – The name of the Neptune event subscription. By default generated by Terraform.
  • name_prefix (pulumi.Input[str]) – The name of the Neptune event subscription. Conflicts with name.
  • sns_topic_arn (pulumi.Input[str]) – The ARN of the SNS topic to send events to.
  • source_ids (pulumi.Input[list]) – 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.
  • source_type (pulumi.Input[str]) – 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.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
enabled = None

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

event_categories = None

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.

name = None

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

name_prefix = None

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

sns_topic_arn = None

The ARN of the SNS topic to send events to.

source_ids = None

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.

source_type = None

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.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, parameters=None, tags=None, __name__=None, __opts__=None)

Manages a Neptune Parameter Group

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the Neptune parameter group. Defaults to “Managed by Terraform”.
  • family (pulumi.Input[str]) – The family of the Neptune parameter group.
  • name (pulumi.Input[str]) – The name of the Neptune parameter.
  • parameters (pulumi.Input[list]) – A list of Neptune parameters to apply.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The Neptune parameter group Amazon Resource Name (ARN).

description = None

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

family = None

The family of the Neptune parameter group.

name = None

The name of the Neptune parameter.

parameters = None

A list of Neptune parameters to apply.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.neptune.SubnetGroup(resource_name, opts=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None, __name__=None, __opts__=None)

Provides an Neptune subnet group resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the neptune subnet group. Defaults to “Managed by Terraform”.
  • name (pulumi.Input[str]) – The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the neptune subnet group.

description = None

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

name = None

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

name_prefix = None

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

subnet_ids = None

A list of VPC subnet IDs.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str