@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
448 lines (447 loc) • 23.1 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface NeptuneClusterConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#allow_major_version_upgrade NeptuneCluster#allow_major_version_upgrade}
*/
readonly allowMajorVersionUpgrade?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#apply_immediately NeptuneCluster#apply_immediately}
*/
readonly applyImmediately?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#availability_zones NeptuneCluster#availability_zones}
*/
readonly availabilityZones?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#backup_retention_period NeptuneCluster#backup_retention_period}
*/
readonly backupRetentionPeriod?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#cluster_identifier NeptuneCluster#cluster_identifier}
*/
readonly clusterIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#cluster_identifier_prefix NeptuneCluster#cluster_identifier_prefix}
*/
readonly clusterIdentifierPrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#copy_tags_to_snapshot NeptuneCluster#copy_tags_to_snapshot}
*/
readonly copyTagsToSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#deletion_protection NeptuneCluster#deletion_protection}
*/
readonly deletionProtection?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#enable_cloudwatch_logs_exports NeptuneCluster#enable_cloudwatch_logs_exports}
*/
readonly enableCloudwatchLogsExports?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#engine NeptuneCluster#engine}
*/
readonly engine?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#engine_version NeptuneCluster#engine_version}
*/
readonly engineVersion?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#final_snapshot_identifier NeptuneCluster#final_snapshot_identifier}
*/
readonly finalSnapshotIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#global_cluster_identifier NeptuneCluster#global_cluster_identifier}
*/
readonly globalClusterIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#iam_database_authentication_enabled NeptuneCluster#iam_database_authentication_enabled}
*/
readonly iamDatabaseAuthenticationEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#iam_roles NeptuneCluster#iam_roles}
*/
readonly iamRoles?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/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.
*/
readonly id?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#kms_key_arn NeptuneCluster#kms_key_arn}
*/
readonly kmsKeyArn?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#neptune_cluster_parameter_group_name NeptuneCluster#neptune_cluster_parameter_group_name}
*/
readonly neptuneClusterParameterGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#neptune_instance_parameter_group_name NeptuneCluster#neptune_instance_parameter_group_name}
*/
readonly neptuneInstanceParameterGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#neptune_subnet_group_name NeptuneCluster#neptune_subnet_group_name}
*/
readonly neptuneSubnetGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#port NeptuneCluster#port}
*/
readonly port?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#preferred_backup_window NeptuneCluster#preferred_backup_window}
*/
readonly preferredBackupWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#preferred_maintenance_window NeptuneCluster#preferred_maintenance_window}
*/
readonly preferredMaintenanceWindow?: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#region NeptuneCluster#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#replication_source_identifier NeptuneCluster#replication_source_identifier}
*/
readonly replicationSourceIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#skip_final_snapshot NeptuneCluster#skip_final_snapshot}
*/
readonly skipFinalSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#snapshot_identifier NeptuneCluster#snapshot_identifier}
*/
readonly snapshotIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#storage_encrypted NeptuneCluster#storage_encrypted}
*/
readonly storageEncrypted?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#storage_type NeptuneCluster#storage_type}
*/
readonly storageType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#tags NeptuneCluster#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#tags_all NeptuneCluster#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#vpc_security_group_ids NeptuneCluster#vpc_security_group_ids}
*/
readonly vpcSecurityGroupIds?: string[];
/**
* serverless_v2_scaling_configuration block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#serverless_v2_scaling_configuration NeptuneCluster#serverless_v2_scaling_configuration}
*/
readonly serverlessV2ScalingConfiguration?: NeptuneClusterServerlessV2ScalingConfiguration;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#timeouts NeptuneCluster#timeouts}
*/
readonly timeouts?: NeptuneClusterTimeouts;
}
export interface NeptuneClusterServerlessV2ScalingConfiguration {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#max_capacity NeptuneCluster#max_capacity}
*/
readonly maxCapacity?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#min_capacity NeptuneCluster#min_capacity}
*/
readonly minCapacity?: number;
}
export declare function neptuneClusterServerlessV2ScalingConfigurationToTerraform(struct?: NeptuneClusterServerlessV2ScalingConfigurationOutputReference | NeptuneClusterServerlessV2ScalingConfiguration): any;
export declare function neptuneClusterServerlessV2ScalingConfigurationToHclTerraform(struct?: NeptuneClusterServerlessV2ScalingConfigurationOutputReference | NeptuneClusterServerlessV2ScalingConfiguration): any;
export declare class NeptuneClusterServerlessV2ScalingConfigurationOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): NeptuneClusterServerlessV2ScalingConfiguration | undefined;
set internalValue(value: NeptuneClusterServerlessV2ScalingConfiguration | undefined);
private _maxCapacity?;
get maxCapacity(): number;
set maxCapacity(value: number);
resetMaxCapacity(): void;
get maxCapacityInput(): number | undefined;
private _minCapacity?;
get minCapacity(): number;
set minCapacity(value: number);
resetMinCapacity(): void;
get minCapacityInput(): number | undefined;
}
export interface NeptuneClusterTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#create NeptuneCluster#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#delete NeptuneCluster#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#update NeptuneCluster#update}
*/
readonly update?: string;
}
export declare function neptuneClusterTimeoutsToTerraform(struct?: NeptuneClusterTimeouts | cdktf.IResolvable): any;
export declare function neptuneClusterTimeoutsToHclTerraform(struct?: NeptuneClusterTimeouts | cdktf.IResolvable): any;
export declare class NeptuneClusterTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): NeptuneClusterTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: NeptuneClusterTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster aws_neptune_cluster}
*/
export declare class NeptuneCluster extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_neptune_cluster";
/**
* Generates CDKTF code for importing a NeptuneCluster resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the NeptuneCluster to import
* @param importFromId The id of the existing NeptuneCluster that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the NeptuneCluster to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/neptune_cluster aws_neptune_cluster} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options NeptuneClusterConfig = {}
*/
constructor(scope: Construct, id: string, config?: NeptuneClusterConfig);
private _allowMajorVersionUpgrade?;
get allowMajorVersionUpgrade(): boolean | cdktf.IResolvable;
set allowMajorVersionUpgrade(value: boolean | cdktf.IResolvable);
resetAllowMajorVersionUpgrade(): void;
get allowMajorVersionUpgradeInput(): boolean | cdktf.IResolvable | undefined;
private _applyImmediately?;
get applyImmediately(): boolean | cdktf.IResolvable;
set applyImmediately(value: boolean | cdktf.IResolvable);
resetApplyImmediately(): void;
get applyImmediatelyInput(): boolean | cdktf.IResolvable | undefined;
get arn(): string;
private _availabilityZones?;
get availabilityZones(): string[];
set availabilityZones(value: string[]);
resetAvailabilityZones(): void;
get availabilityZonesInput(): string[] | undefined;
private _backupRetentionPeriod?;
get backupRetentionPeriod(): number;
set backupRetentionPeriod(value: number);
resetBackupRetentionPeriod(): void;
get backupRetentionPeriodInput(): number | undefined;
private _clusterIdentifier?;
get clusterIdentifier(): string;
set clusterIdentifier(value: string);
resetClusterIdentifier(): void;
get clusterIdentifierInput(): string | undefined;
private _clusterIdentifierPrefix?;
get clusterIdentifierPrefix(): string;
set clusterIdentifierPrefix(value: string);
resetClusterIdentifierPrefix(): void;
get clusterIdentifierPrefixInput(): string | undefined;
get clusterMembers(): string[];
get clusterResourceId(): string;
private _copyTagsToSnapshot?;
get copyTagsToSnapshot(): boolean | cdktf.IResolvable;
set copyTagsToSnapshot(value: boolean | cdktf.IResolvable);
resetCopyTagsToSnapshot(): void;
get copyTagsToSnapshotInput(): boolean | cdktf.IResolvable | undefined;
private _deletionProtection?;
get deletionProtection(): boolean | cdktf.IResolvable;
set deletionProtection(value: boolean | cdktf.IResolvable);
resetDeletionProtection(): void;
get deletionProtectionInput(): boolean | cdktf.IResolvable | undefined;
private _enableCloudwatchLogsExports?;
get enableCloudwatchLogsExports(): string[];
set enableCloudwatchLogsExports(value: string[]);
resetEnableCloudwatchLogsExports(): void;
get enableCloudwatchLogsExportsInput(): string[] | undefined;
get endpoint(): string;
private _engine?;
get engine(): string;
set engine(value: string);
resetEngine(): void;
get engineInput(): string | undefined;
private _engineVersion?;
get engineVersion(): string;
set engineVersion(value: string);
resetEngineVersion(): void;
get engineVersionInput(): string | undefined;
private _finalSnapshotIdentifier?;
get finalSnapshotIdentifier(): string;
set finalSnapshotIdentifier(value: string);
resetFinalSnapshotIdentifier(): void;
get finalSnapshotIdentifierInput(): string | undefined;
private _globalClusterIdentifier?;
get globalClusterIdentifier(): string;
set globalClusterIdentifier(value: string);
resetGlobalClusterIdentifier(): void;
get globalClusterIdentifierInput(): string | undefined;
get hostedZoneId(): string;
private _iamDatabaseAuthenticationEnabled?;
get iamDatabaseAuthenticationEnabled(): boolean | cdktf.IResolvable;
set iamDatabaseAuthenticationEnabled(value: boolean | cdktf.IResolvable);
resetIamDatabaseAuthenticationEnabled(): void;
get iamDatabaseAuthenticationEnabledInput(): boolean | cdktf.IResolvable | undefined;
private _iamRoles?;
get iamRoles(): string[];
set iamRoles(value: string[]);
resetIamRoles(): void;
get iamRolesInput(): string[] | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _kmsKeyArn?;
get kmsKeyArn(): string;
set kmsKeyArn(value: string);
resetKmsKeyArn(): void;
get kmsKeyArnInput(): string | undefined;
private _neptuneClusterParameterGroupName?;
get neptuneClusterParameterGroupName(): string;
set neptuneClusterParameterGroupName(value: string);
resetNeptuneClusterParameterGroupName(): void;
get neptuneClusterParameterGroupNameInput(): string | undefined;
private _neptuneInstanceParameterGroupName?;
get neptuneInstanceParameterGroupName(): string;
set neptuneInstanceParameterGroupName(value: string);
resetNeptuneInstanceParameterGroupName(): void;
get neptuneInstanceParameterGroupNameInput(): string | undefined;
private _neptuneSubnetGroupName?;
get neptuneSubnetGroupName(): string;
set neptuneSubnetGroupName(value: string);
resetNeptuneSubnetGroupName(): void;
get neptuneSubnetGroupNameInput(): string | undefined;
private _port?;
get port(): number;
set port(value: number);
resetPort(): void;
get portInput(): number | undefined;
private _preferredBackupWindow?;
get preferredBackupWindow(): string;
set preferredBackupWindow(value: string);
resetPreferredBackupWindow(): void;
get preferredBackupWindowInput(): string | undefined;
private _preferredMaintenanceWindow?;
get preferredMaintenanceWindow(): string;
set preferredMaintenanceWindow(value: string);
resetPreferredMaintenanceWindow(): void;
get preferredMaintenanceWindowInput(): string | undefined;
get readerEndpoint(): string;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _replicationSourceIdentifier?;
get replicationSourceIdentifier(): string;
set replicationSourceIdentifier(value: string);
resetReplicationSourceIdentifier(): void;
get replicationSourceIdentifierInput(): string | undefined;
private _skipFinalSnapshot?;
get skipFinalSnapshot(): boolean | cdktf.IResolvable;
set skipFinalSnapshot(value: boolean | cdktf.IResolvable);
resetSkipFinalSnapshot(): void;
get skipFinalSnapshotInput(): boolean | cdktf.IResolvable | undefined;
private _snapshotIdentifier?;
get snapshotIdentifier(): string;
set snapshotIdentifier(value: string);
resetSnapshotIdentifier(): void;
get snapshotIdentifierInput(): string | undefined;
private _storageEncrypted?;
get storageEncrypted(): boolean | cdktf.IResolvable;
set storageEncrypted(value: boolean | cdktf.IResolvable);
resetStorageEncrypted(): void;
get storageEncryptedInput(): boolean | cdktf.IResolvable | undefined;
private _storageType?;
get storageType(): string;
set storageType(value: string);
resetStorageType(): void;
get storageTypeInput(): string | undefined;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll?;
get tagsAll(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
private _vpcSecurityGroupIds?;
get vpcSecurityGroupIds(): string[];
set vpcSecurityGroupIds(value: string[]);
resetVpcSecurityGroupIds(): void;
get vpcSecurityGroupIdsInput(): string[] | undefined;
private _serverlessV2ScalingConfiguration;
get serverlessV2ScalingConfiguration(): NeptuneClusterServerlessV2ScalingConfigurationOutputReference;
putServerlessV2ScalingConfiguration(value: NeptuneClusterServerlessV2ScalingConfiguration): void;
resetServerlessV2ScalingConfiguration(): void;
get serverlessV2ScalingConfigurationInput(): NeptuneClusterServerlessV2ScalingConfiguration | undefined;
private _timeouts;
get timeouts(): NeptuneClusterTimeoutsOutputReference;
putTimeouts(value: NeptuneClusterTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | NeptuneClusterTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}