Skip to content

Latest commit

 

History

History
2399 lines (1504 loc) · 103 KB

neptuneCluster.md

File metadata and controls

2399 lines (1504 loc) · 103 KB

neptuneCluster Submodule

Constructs

NeptuneCluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster aws_neptune_cluster}.

Initializers 

import { neptuneCluster } from '@cdktf/aws-cdk'

new neptuneCluster.NeptuneCluster(scope: Construct, id: string, config?: NeptuneClusterConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config NeptuneClusterConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configOptional

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetApplyImmediately No description.
resetAvailabilityZones No description.
resetBackupRetentionPeriod No description.
resetClusterIdentifier No description.
resetClusterIdentifierPrefix No description.
resetCopyTagsToSnapshot No description.
resetDeletionProtection No description.
resetEnableCloudwatchLogsExports No description.
resetEngine No description.
resetEngineVersion No description.
resetFinalSnapshotIdentifier No description.
resetIamDatabaseAuthenticationEnabled No description.
resetIamRoles No description.
resetId No description.
resetKmsKeyArn No description.
resetNeptuneClusterParameterGroupName No description.
resetNeptuneSubnetGroupName No description.
resetPort No description.
resetPreferredBackupWindow No description.
resetPreferredMaintenanceWindow No description.
resetReplicationSourceIdentifier No description.
resetSkipFinalSnapshot No description.
resetSnapshotIdentifier No description.
resetStorageEncrypted No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.
resetVpcSecurityGroupIds No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putTimeouts 
public putTimeouts(value: NeptuneClusterTimeouts): void
valueRequired
resetApplyImmediately 
public resetApplyImmediately(): void
resetAvailabilityZones 
public resetAvailabilityZones(): void
resetBackupRetentionPeriod 
public resetBackupRetentionPeriod(): void
resetClusterIdentifier 
public resetClusterIdentifier(): void
resetClusterIdentifierPrefix 
public resetClusterIdentifierPrefix(): void
resetCopyTagsToSnapshot 
public resetCopyTagsToSnapshot(): void
resetDeletionProtection 
public resetDeletionProtection(): void
resetEnableCloudwatchLogsExports 
public resetEnableCloudwatchLogsExports(): void
resetEngine 
public resetEngine(): void
resetEngineVersion 
public resetEngineVersion(): void
resetFinalSnapshotIdentifier 
public resetFinalSnapshotIdentifier(): void
resetIamDatabaseAuthenticationEnabled 
public resetIamDatabaseAuthenticationEnabled(): void
resetIamRoles 
public resetIamRoles(): void
resetId 
public resetId(): void
resetKmsKeyArn 
public resetKmsKeyArn(): void
resetNeptuneClusterParameterGroupName 
public resetNeptuneClusterParameterGroupName(): void
resetNeptuneSubnetGroupName 
public resetNeptuneSubnetGroupName(): void
resetPort 
public resetPort(): void
resetPreferredBackupWindow 
public resetPreferredBackupWindow(): void
resetPreferredMaintenanceWindow 
public resetPreferredMaintenanceWindow(): void
resetReplicationSourceIdentifier 
public resetReplicationSourceIdentifier(): void
resetSkipFinalSnapshot 
public resetSkipFinalSnapshot(): void
resetSnapshotIdentifier 
public resetSnapshotIdentifier(): void
resetStorageEncrypted 
public resetStorageEncrypted(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTimeouts 
public resetTimeouts(): void
resetVpcSecurityGroupIds 
public resetVpcSecurityGroupIds(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a NeptuneCluster resource upon running "cdktf plan ".
isConstruct 
import { neptuneCluster } from '@cdktf/aws-cdk'

neptuneCluster.NeptuneCluster.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { neptuneCluster } from '@cdktf/aws-cdk'

neptuneCluster.NeptuneCluster.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { neptuneCluster } from '@cdktf/aws-cdk'

neptuneCluster.NeptuneCluster.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { neptuneCluster } from '@cdktf/aws-cdk'

neptuneCluster.NeptuneCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a NeptuneCluster resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the NeptuneCluster to import.

importFromIdRequired
  • Type: string

The id of the existing NeptuneCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the NeptuneCluster to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
arn string No description.
clusterMembers string[] No description.
clusterResourceId string No description.
endpoint string No description.
hostedZoneId string No description.
readerEndpoint string No description.
timeouts NeptuneClusterTimeoutsOutputReference No description.
applyImmediatelyInput boolean | cdktf.IResolvable No description.
availabilityZonesInput string[] No description.
backupRetentionPeriodInput number No description.
clusterIdentifierInput string No description.
clusterIdentifierPrefixInput string No description.
copyTagsToSnapshotInput boolean | cdktf.IResolvable No description.
deletionProtectionInput boolean | cdktf.IResolvable No description.
enableCloudwatchLogsExportsInput string[] No description.
engineInput string No description.
engineVersionInput string No description.
finalSnapshotIdentifierInput string No description.
iamDatabaseAuthenticationEnabledInput boolean | cdktf.IResolvable No description.
iamRolesInput string[] No description.
idInput string No description.
kmsKeyArnInput string No description.
neptuneClusterParameterGroupNameInput string No description.
neptuneSubnetGroupNameInput string No description.
portInput number No description.
preferredBackupWindowInput string No description.
preferredMaintenanceWindowInput string No description.
replicationSourceIdentifierInput string No description.
skipFinalSnapshotInput boolean | cdktf.IResolvable No description.
snapshotIdentifierInput string No description.
storageEncryptedInput boolean | cdktf.IResolvable No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | NeptuneClusterTimeouts No description.
vpcSecurityGroupIdsInput string[] No description.
applyImmediately boolean | cdktf.IResolvable No description.
availabilityZones string[] No description.
backupRetentionPeriod number No description.
clusterIdentifier string No description.
clusterIdentifierPrefix string No description.
copyTagsToSnapshot boolean | cdktf.IResolvable No description.
deletionProtection boolean | cdktf.IResolvable No description.
enableCloudwatchLogsExports string[] No description.
engine string No description.
engineVersion string No description.
finalSnapshotIdentifier string No description.
iamDatabaseAuthenticationEnabled boolean | cdktf.IResolvable No description.
iamRoles string[] No description.
id string No description.
kmsKeyArn string No description.
neptuneClusterParameterGroupName string No description.
neptuneSubnetGroupName string No description.
port number No description.
preferredBackupWindow string No description.
preferredMaintenanceWindow string No description.
replicationSourceIdentifier string No description.
skipFinalSnapshot boolean | cdktf.IResolvable No description.
snapshotIdentifier string No description.
storageEncrypted boolean | cdktf.IResolvable No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
vpcSecurityGroupIds string[] No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
clusterMembersRequired 
public readonly clusterMembers: string[];
  • Type: string[]
clusterResourceIdRequired 
public readonly clusterResourceId: string;
  • Type: string
endpointRequired 
public readonly endpoint: string;
  • Type: string
hostedZoneIdRequired 
public readonly hostedZoneId: string;
  • Type: string
readerEndpointRequired 
public readonly readerEndpoint: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: NeptuneClusterTimeoutsOutputReference;
applyImmediatelyInputOptional 
public readonly applyImmediatelyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
availabilityZonesInputOptional 
public readonly availabilityZonesInput: string[];
  • Type: string[]
backupRetentionPeriodInputOptional 
public readonly backupRetentionPeriodInput: number;
  • Type: number
clusterIdentifierInputOptional 
public readonly clusterIdentifierInput: string;
  • Type: string
clusterIdentifierPrefixInputOptional 
public readonly clusterIdentifierPrefixInput: string;
  • Type: string
copyTagsToSnapshotInputOptional 
public readonly copyTagsToSnapshotInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
deletionProtectionInputOptional 
public readonly deletionProtectionInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableCloudwatchLogsExportsInputOptional 
public readonly enableCloudwatchLogsExportsInput: string[];
  • Type: string[]
engineInputOptional 
public readonly engineInput: string;
  • Type: string
engineVersionInputOptional 
public readonly engineVersionInput: string;
  • Type: string
finalSnapshotIdentifierInputOptional 
public readonly finalSnapshotIdentifierInput: string;
  • Type: string
iamDatabaseAuthenticationEnabledInputOptional 
public readonly iamDatabaseAuthenticationEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
iamRolesInputOptional 
public readonly iamRolesInput: string[];
  • Type: string[]
idInputOptional 
public readonly idInput: string;
  • Type: string
kmsKeyArnInputOptional 
public readonly kmsKeyArnInput: string;
  • Type: string
neptuneClusterParameterGroupNameInputOptional 
public readonly neptuneClusterParameterGroupNameInput: string;
  • Type: string
neptuneSubnetGroupNameInputOptional 
public readonly neptuneSubnetGroupNameInput: string;
  • Type: string
portInputOptional 
public readonly portInput: number;
  • Type: number
preferredBackupWindowInputOptional 
public readonly preferredBackupWindowInput: string;
  • Type: string
preferredMaintenanceWindowInputOptional 
public readonly preferredMaintenanceWindowInput: string;
  • Type: string
replicationSourceIdentifierInputOptional 
public readonly replicationSourceIdentifierInput: string;
  • Type: string
skipFinalSnapshotInputOptional 
public readonly skipFinalSnapshotInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
snapshotIdentifierInputOptional 
public readonly snapshotIdentifierInput: string;
  • Type: string
storageEncryptedInputOptional 
public readonly storageEncryptedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | NeptuneClusterTimeouts;
vpcSecurityGroupIdsInputOptional 
public readonly vpcSecurityGroupIdsInput: string[];
  • Type: string[]
applyImmediatelyRequired 
public readonly applyImmediately: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
availabilityZonesRequired 
public readonly availabilityZones: string[];
  • Type: string[]
backupRetentionPeriodRequired 
public readonly backupRetentionPeriod: number;
  • Type: number
clusterIdentifierRequired 
public readonly clusterIdentifier: string;
  • Type: string
clusterIdentifierPrefixRequired 
public readonly clusterIdentifierPrefix: string;
  • Type: string
copyTagsToSnapshotRequired 
public readonly copyTagsToSnapshot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
deletionProtectionRequired 
public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
enableCloudwatchLogsExportsRequired 
public readonly enableCloudwatchLogsExports: string[];
  • Type: string[]
engineRequired 
public readonly engine: string;
  • Type: string
engineVersionRequired 
public readonly engineVersion: string;
  • Type: string
finalSnapshotIdentifierRequired 
public readonly finalSnapshotIdentifier: string;
  • Type: string
iamDatabaseAuthenticationEnabledRequired 
public readonly iamDatabaseAuthenticationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
iamRolesRequired 
public readonly iamRoles: string[];
  • Type: string[]
idRequired 
public readonly id: string;
  • Type: string
kmsKeyArnRequired 
public readonly kmsKeyArn: string;
  • Type: string
neptuneClusterParameterGroupNameRequired 
public readonly neptuneClusterParameterGroupName: string;
  • Type: string
neptuneSubnetGroupNameRequired 
public readonly neptuneSubnetGroupName: string;
  • Type: string
portRequired 
public readonly port: number;
  • Type: number
preferredBackupWindowRequired 
public readonly preferredBackupWindow: string;
  • Type: string
preferredMaintenanceWindowRequired 
public readonly preferredMaintenanceWindow: string;
  • Type: string
replicationSourceIdentifierRequired 
public readonly replicationSourceIdentifier: string;
  • Type: string
skipFinalSnapshotRequired 
public readonly skipFinalSnapshot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
snapshotIdentifierRequired 
public readonly snapshotIdentifier: string;
  • Type: string
storageEncryptedRequired 
public readonly storageEncrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vpcSecurityGroupIdsRequired 
public readonly vpcSecurityGroupIds: string[];
  • Type: string[]

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

NeptuneClusterConfig

Initializer 

import { neptuneCluster } from '@cdktf/aws-cdk'

const neptuneClusterConfig: neptuneCluster.NeptuneClusterConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
applyImmediately boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#apply_immediately NeptuneCluster#apply_immediately}.
availabilityZones string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#availability_zones NeptuneCluster#availability_zones}.
backupRetentionPeriod number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#backup_retention_period NeptuneCluster#backup_retention_period}.
clusterIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#cluster_identifier NeptuneCluster#cluster_identifier}.
clusterIdentifierPrefix string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#cluster_identifier_prefix NeptuneCluster#cluster_identifier_prefix}.
copyTagsToSnapshot boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#copy_tags_to_snapshot NeptuneCluster#copy_tags_to_snapshot}.
deletionProtection boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#deletion_protection NeptuneCluster#deletion_protection}.
enableCloudwatchLogsExports string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#enable_cloudwatch_logs_exports NeptuneCluster#enable_cloudwatch_logs_exports}.
engine string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#engine NeptuneCluster#engine}.
engineVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#engine_version NeptuneCluster#engine_version}.
finalSnapshotIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#final_snapshot_identifier NeptuneCluster#final_snapshot_identifier}.
iamDatabaseAuthenticationEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#iam_database_authentication_enabled NeptuneCluster#iam_database_authentication_enabled}.
iamRoles string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#iam_roles NeptuneCluster#iam_roles}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#id NeptuneCluster#id}.
kmsKeyArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#kms_key_arn NeptuneCluster#kms_key_arn}.
neptuneClusterParameterGroupName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#neptune_cluster_parameter_group_name NeptuneCluster#neptune_cluster_parameter_group_name}.
neptuneSubnetGroupName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#neptune_subnet_group_name NeptuneCluster#neptune_subnet_group_name}.
port number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#port NeptuneCluster#port}.
preferredBackupWindow string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#preferred_backup_window NeptuneCluster#preferred_backup_window}.
preferredMaintenanceWindow string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#preferred_maintenance_window NeptuneCluster#preferred_maintenance_window}.
replicationSourceIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#replication_source_identifier NeptuneCluster#replication_source_identifier}.
skipFinalSnapshot boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#skip_final_snapshot NeptuneCluster#skip_final_snapshot}.
snapshotIdentifier string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#snapshot_identifier NeptuneCluster#snapshot_identifier}.
storageEncrypted boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#storage_encrypted NeptuneCluster#storage_encrypted}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#tags NeptuneCluster#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#tags_all NeptuneCluster#tags_all}.
timeouts NeptuneClusterTimeouts timeouts block.
vpcSecurityGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#vpc_security_group_ids NeptuneCluster#vpc_security_group_ids}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
applyImmediatelyOptional 
public readonly applyImmediately: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#apply_immediately NeptuneCluster#apply_immediately}.

availabilityZonesOptional 
public readonly availabilityZones: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#availability_zones NeptuneCluster#availability_zones}.

backupRetentionPeriodOptional 
public readonly backupRetentionPeriod: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#backup_retention_period NeptuneCluster#backup_retention_period}.

clusterIdentifierOptional 
public readonly clusterIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#cluster_identifier NeptuneCluster#cluster_identifier}.

clusterIdentifierPrefixOptional 
public readonly clusterIdentifierPrefix: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#cluster_identifier_prefix NeptuneCluster#cluster_identifier_prefix}.

copyTagsToSnapshotOptional 
public readonly copyTagsToSnapshot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#copy_tags_to_snapshot NeptuneCluster#copy_tags_to_snapshot}.

deletionProtectionOptional 
public readonly deletionProtection: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#deletion_protection NeptuneCluster#deletion_protection}.

enableCloudwatchLogsExportsOptional 
public readonly enableCloudwatchLogsExports: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#enable_cloudwatch_logs_exports NeptuneCluster#enable_cloudwatch_logs_exports}.

engineOptional 
public readonly engine: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#engine NeptuneCluster#engine}.

engineVersionOptional 
public readonly engineVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#engine_version NeptuneCluster#engine_version}.

finalSnapshotIdentifierOptional 
public readonly finalSnapshotIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#final_snapshot_identifier NeptuneCluster#final_snapshot_identifier}.

iamDatabaseAuthenticationEnabledOptional 
public readonly iamDatabaseAuthenticationEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#iam_database_authentication_enabled NeptuneCluster#iam_database_authentication_enabled}.

iamRolesOptional 
public readonly iamRoles: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#iam_roles NeptuneCluster#iam_roles}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#id NeptuneCluster#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

kmsKeyArnOptional 
public readonly kmsKeyArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#kms_key_arn NeptuneCluster#kms_key_arn}.

neptuneClusterParameterGroupNameOptional 
public readonly neptuneClusterParameterGroupName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#neptune_cluster_parameter_group_name NeptuneCluster#neptune_cluster_parameter_group_name}.

neptuneSubnetGroupNameOptional 
public readonly neptuneSubnetGroupName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#neptune_subnet_group_name NeptuneCluster#neptune_subnet_group_name}.

portOptional 
public readonly port: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#port NeptuneCluster#port}.

preferredBackupWindowOptional 
public readonly preferredBackupWindow: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#preferred_backup_window NeptuneCluster#preferred_backup_window}.

preferredMaintenanceWindowOptional 
public readonly preferredMaintenanceWindow: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#preferred_maintenance_window NeptuneCluster#preferred_maintenance_window}.

replicationSourceIdentifierOptional 
public readonly replicationSourceIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#replication_source_identifier NeptuneCluster#replication_source_identifier}.

skipFinalSnapshotOptional 
public readonly skipFinalSnapshot: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#skip_final_snapshot NeptuneCluster#skip_final_snapshot}.

snapshotIdentifierOptional 
public readonly snapshotIdentifier: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#snapshot_identifier NeptuneCluster#snapshot_identifier}.

storageEncryptedOptional 
public readonly storageEncrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#storage_encrypted NeptuneCluster#storage_encrypted}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#tags NeptuneCluster#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#tags_all NeptuneCluster#tags_all}.

timeoutsOptional 
public readonly timeouts: NeptuneClusterTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#timeouts NeptuneCluster#timeouts}

vpcSecurityGroupIdsOptional 
public readonly vpcSecurityGroupIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#vpc_security_group_ids NeptuneCluster#vpc_security_group_ids}.

NeptuneClusterTimeouts

Initializer 

import { neptuneCluster } from '@cdktf/aws-cdk'

const neptuneClusterTimeouts: neptuneCluster.NeptuneClusterTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#create NeptuneCluster#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#delete NeptuneCluster#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#update NeptuneCluster#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#create NeptuneCluster#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#delete NeptuneCluster#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/neptune_cluster#update NeptuneCluster#update}.

Classes

NeptuneClusterTimeoutsOutputReference

Initializers 

import { neptuneCluster } from '@cdktf/aws-cdk'

new neptuneCluster.NeptuneClusterTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public resetCreate(): void
resetDelete 
public resetDelete(): void
resetUpdate 
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | NeptuneClusterTimeouts No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | NeptuneClusterTimeouts;