neptune_cluster_instance.md

permalink
/neptune_cluster_instance/

neptune_cluster_instance

neptune_cluster_instance represents the aws_neptune_cluster_instance Terraform resource.

This package contains functions and utilities for setting up the resource using Jsonnet code.

Index

• fn new()
• fn newAttrs()
• fn withApplyImmediately()
• fn withAutoMinorVersionUpgrade()
• fn withAvailabilityZone()
• fn withClusterIdentifier()
• fn withEngine()
• fn withEngineVersion()
• fn withIdentifier()
• fn withIdentifierPrefix()
• fn withInstanceClass()
• fn withNeptuneParameterGroupName()
• fn withNeptuneSubnetGroupName()
• fn withPort()
• fn withPreferredBackupWindow()
• fn withPreferredMaintenanceWindow()
• fn withPromotionTier()
• fn withPubliclyAccessible()
• fn withTags()
• fn withTagsAll()
• fn withTimeouts()
• fn withTimeoutsMixin()
• obj timeouts
  • fn new()

Fields

fn new

new()

aws.neptune_cluster_instance.new injects a new aws_neptune_cluster_instance Terraform resource block into the root module document.

Additionally, this inserts a private function into the _ref attribute that generates references to attributes of the resource. For example, if you added a new instance to the root using:

# arguments omitted for brevity
aws.neptune_cluster_instance.new('some_id')

You can get the reference to the id field of the created aws.neptune_cluster_instance using the reference:

$._ref.aws_neptune_cluster_instance.some_id.get('id')

This is the same as directly entering "${ aws_neptune_cluster_instance.some_id.id }" as the value.

NOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use super, self, or $ to refer to the root object. Instead, make an explicit outer object using local.

Args:

• resourceLabel (string): The name label of the block.
• apply_immediately (bool): Set the apply_immediately field on the resulting resource block. When null, the apply_immediately field will be omitted from the resulting object.
• auto_minor_version_upgrade (bool): Set the auto_minor_version_upgrade field on the resulting resource block. When null, the auto_minor_version_upgrade field will be omitted from the resulting object.
• availability_zone (string): Set the availability_zone field on the resulting resource block. When null, the availability_zone field will be omitted from the resulting object.
• cluster_identifier (string): Set the cluster_identifier field on the resulting resource block.
• engine (string): Set the engine field on the resulting resource block. When null, the engine field will be omitted from the resulting object.
• engine_version (string): Set the engine_version field on the resulting resource block. When null, the engine_version field will be omitted from the resulting object.
• identifier (string): Set the identifier field on the resulting resource block. When null, the identifier field will be omitted from the resulting object.
• identifier_prefix (string): Set the identifier_prefix field on the resulting resource block. When null, the identifier_prefix field will be omitted from the resulting object.
• instance_class (string): Set the instance_class field on the resulting resource block.
• neptune_parameter_group_name (string): Set the neptune_parameter_group_name field on the resulting resource block. When null, the neptune_parameter_group_name field will be omitted from the resulting object.
• neptune_subnet_group_name (string): Set the neptune_subnet_group_name field on the resulting resource block. When null, the neptune_subnet_group_name field will be omitted from the resulting object.
• port (number): Set the port field on the resulting resource block. When null, the port field will be omitted from the resulting object.
• preferred_backup_window (string): Set the preferred_backup_window field on the resulting resource block. When null, the preferred_backup_window field will be omitted from the resulting object.
• preferred_maintenance_window (string): Set the preferred_maintenance_window field on the resulting resource block. When null, the preferred_maintenance_window field will be omitted from the resulting object.
• promotion_tier (number): Set the promotion_tier field on the resulting resource block. When null, the promotion_tier field will be omitted from the resulting object.
• publicly_accessible (bool): Set the publicly_accessible field on the resulting resource block. When null, the publicly_accessible field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting resource block. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting resource block. When null, the tags_all field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting resource block. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.neptune_cluster_instance.timeouts.new constructor.

Returns:

• A mixin object that injects the new resource into the root Terraform configuration.

fn newAttrs

newAttrs()

aws.neptune_cluster_instance.newAttrs constructs a new object with attributes and blocks configured for the neptune_cluster_instance Terraform resource.

Unlike aws.neptune_cluster_instance.new, this function will not inject the resource block into the root Terraform document. Instead, this must be passed in as the attrs argument for the tf.withResource function to build a complete block.

This is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to injecting into a complete block.

Args:

• apply_immediately (bool): Set the apply_immediately field on the resulting object. When null, the apply_immediately field will be omitted from the resulting object.
• auto_minor_version_upgrade (bool): Set the auto_minor_version_upgrade field on the resulting object. When null, the auto_minor_version_upgrade field will be omitted from the resulting object.
• availability_zone (string): Set the availability_zone field on the resulting object. When null, the availability_zone field will be omitted from the resulting object.
• cluster_identifier (string): Set the cluster_identifier field on the resulting object.
• engine (string): Set the engine field on the resulting object. When null, the engine field will be omitted from the resulting object.
• engine_version (string): Set the engine_version field on the resulting object. When null, the engine_version field will be omitted from the resulting object.
• identifier (string): Set the identifier field on the resulting object. When null, the identifier field will be omitted from the resulting object.
• identifier_prefix (string): Set the identifier_prefix field on the resulting object. When null, the identifier_prefix field will be omitted from the resulting object.
• instance_class (string): Set the instance_class field on the resulting object.
• neptune_parameter_group_name (string): Set the neptune_parameter_group_name field on the resulting object. When null, the neptune_parameter_group_name field will be omitted from the resulting object.
• neptune_subnet_group_name (string): Set the neptune_subnet_group_name field on the resulting object. When null, the neptune_subnet_group_name field will be omitted from the resulting object.
• port (number): Set the port field on the resulting object. When null, the port field will be omitted from the resulting object.
• preferred_backup_window (string): Set the preferred_backup_window field on the resulting object. When null, the preferred_backup_window field will be omitted from the resulting object.
• preferred_maintenance_window (string): Set the preferred_maintenance_window field on the resulting object. When null, the preferred_maintenance_window field will be omitted from the resulting object.
• promotion_tier (number): Set the promotion_tier field on the resulting object. When null, the promotion_tier field will be omitted from the resulting object.
• publicly_accessible (bool): Set the publicly_accessible field on the resulting object. When null, the publicly_accessible field will be omitted from the resulting object.
• tags (obj): Set the tags field on the resulting object. When null, the tags field will be omitted from the resulting object.
• tags_all (obj): Set the tags_all field on the resulting object. When null, the tags_all field will be omitted from the resulting object.
• timeouts (obj): Set the timeouts field on the resulting object. When null, the timeouts sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the aws.neptune_cluster_instance.timeouts.new constructor.

Returns:

• An attribute object that can be used with tf.withResource to construct a new neptune_cluster_instance resource into the root Terraform configuration.

fn withApplyImmediately

withApplyImmediately()

aws.bool.withApplyImmediately constructs a mixin object that can be merged into the bool Terraform resource block to set or update the apply_immediately field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the apply_immediately field.

fn withAutoMinorVersionUpgrade

withAutoMinorVersionUpgrade()

aws.bool.withAutoMinorVersionUpgrade constructs a mixin object that can be merged into the bool Terraform resource block to set or update the auto_minor_version_upgrade field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the auto_minor_version_upgrade field.

fn withAvailabilityZone

withAvailabilityZone()

aws.string.withAvailabilityZone constructs a mixin object that can be merged into the string Terraform resource block to set or update the availability_zone field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the availability_zone field.

fn withClusterIdentifier

withClusterIdentifier()

aws.string.withClusterIdentifier constructs a mixin object that can be merged into the string Terraform resource block to set or update the cluster_identifier field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the cluster_identifier field.

fn withEngine

withEngine()

aws.string.withEngine constructs a mixin object that can be merged into the string Terraform resource block to set or update the engine field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the engine field.

fn withEngineVersion

withEngineVersion()

aws.string.withEngineVersion constructs a mixin object that can be merged into the string Terraform resource block to set or update the engine_version field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the engine_version field.

fn withIdentifier

withIdentifier()

aws.string.withIdentifier constructs a mixin object that can be merged into the string Terraform resource block to set or update the identifier field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the identifier field.

fn withIdentifierPrefix

withIdentifierPrefix()

aws.string.withIdentifierPrefix constructs a mixin object that can be merged into the string Terraform resource block to set or update the identifier_prefix field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the identifier_prefix field.

fn withInstanceClass

withInstanceClass()

aws.string.withInstanceClass constructs a mixin object that can be merged into the string Terraform resource block to set or update the instance_class field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the instance_class field.

fn withNeptuneParameterGroupName

withNeptuneParameterGroupName()

aws.string.withNeptuneParameterGroupName constructs a mixin object that can be merged into the string Terraform resource block to set or update the neptune_parameter_group_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the neptune_parameter_group_name field.

fn withNeptuneSubnetGroupName

withNeptuneSubnetGroupName()

aws.string.withNeptuneSubnetGroupName constructs a mixin object that can be merged into the string Terraform resource block to set or update the neptune_subnet_group_name field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the neptune_subnet_group_name field.

fn withPort

withPort()

aws.number.withPort constructs a mixin object that can be merged into the number Terraform resource block to set or update the port field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the port field.

fn withPreferredBackupWindow

withPreferredBackupWindow()

aws.string.withPreferredBackupWindow constructs a mixin object that can be merged into the string Terraform resource block to set or update the preferred_backup_window field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the preferred_backup_window field.

fn withPreferredMaintenanceWindow

withPreferredMaintenanceWindow()

aws.string.withPreferredMaintenanceWindow constructs a mixin object that can be merged into the string Terraform resource block to set or update the preferred_maintenance_window field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (string): The value to set for the preferred_maintenance_window field.

fn withPromotionTier

withPromotionTier()

aws.number.withPromotionTier constructs a mixin object that can be merged into the number Terraform resource block to set or update the promotion_tier field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (number): The value to set for the promotion_tier field.

fn withPubliclyAccessible

withPubliclyAccessible()

aws.bool.withPubliclyAccessible constructs a mixin object that can be merged into the bool Terraform resource block to set or update the publicly_accessible field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (bool): The value to set for the publicly_accessible field.

fn withTags

withTags()

aws.obj.withTags constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags field.

fn withTagsAll

withTagsAll()

aws.obj.withTagsAll constructs a mixin object that can be merged into the obj Terraform resource block to set or update the tags_all field.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the tags_all field.

fn withTimeouts

withTimeouts()

aws.obj.withTimeouts constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will replace the map with the passed in value. If you wish to instead merge the passed in value to the existing map, use the aws.obj.withTimeoutsMixin function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

fn withTimeoutsMixin

withTimeoutsMixin()

aws.obj.withTimeoutsMixin constructs a mixin object that can be merged into the obj Terraform resource block to set or update the timeouts field.

This function will merge the passed in value to the existing map. If you wish to instead replace the entire map with the passed in value, use the aws.obj.withTimeouts function.

Args:

• resourceLabel (string): The name label of the block to update.
• value (obj): The value to set for the timeouts field.

obj timeouts

fn timeouts.new

new()

aws.neptune_cluster_instance.timeouts.new constructs a new object with attributes and blocks configured for the timeouts Terraform sub block.

Args:

• create (string): Set the create field on the resulting object. When null, the create field will be omitted from the resulting object.
• delete (string): Set the delete field on the resulting object. When null, the delete field will be omitted from the resulting object.
• update (string): Set the update field on the resulting object. When null, the update field will be omitted from the resulting object.

Returns:

• An attribute object that represents the timeouts sub block.