ClusterState constructor
- Input<
bool?> ? allowMajorVersionUpgrade, - Input<
bool?> ? applyImmediately, - Input<
String?> ? arn, - Input<
List< ? availabilityZones,String> ?> - Input<
int?> ? backupRetentionPeriod, - Input<
String?> ? clusterIdentifier, - Input<
String?> ? clusterIdentifierPrefix, - Input<
List< ? clusterMembers,String> ?> - Input<
String?> ? clusterResourceId, - Input<
bool?> ? copyTagsToSnapshot, - Input<
bool?> ? deletionProtection, - Input<
List< ? enableCloudwatchLogsExports,String> ?> - Input<
String?> ? endpoint, - Input<
String?> ? engine, - Input<
String?> ? engineVersion, - Input<
String?> ? finalSnapshotIdentifier, - Input<
String?> ? globalClusterIdentifier, - Input<
String?> ? hostedZoneId, - Input<
bool?> ? iamDatabaseAuthenticationEnabled, - Input<
List< ? iamRoles,String> ?> - Input<
String?> ? kmsKeyArn, - Input<
String?> ? neptuneClusterParameterGroupName, - Input<
String?> ? neptuneInstanceParameterGroupName, - Input<
String?> ? neptuneSubnetGroupName, - Input<
int?> ? port, - Input<
String?> ? preferredBackupWindow, - Input<
String?> ? preferredMaintenanceWindow, - Input<
String?> ? readerEndpoint, - Input<
String?> ? region, - Input<
String?> ? replicationSourceIdentifier, - Input<
ClusterServerlessV2ScalingConfiguration?> ? serverlessV2ScalingConfiguration, - Input<
bool?> ? skipFinalSnapshot, - Input<
String?> ? snapshotIdentifier, - Input<
bool?> ? storageEncrypted, - Input<
String?> ? storageType, - Input<
Map< ? tags,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
List< ? vpcSecurityGroupIds,String> ?>
Creates a new ClusterState.
allowMajorVersionUpgrade Whether upgrades between different major versions are allowed. You must set it to true when providing an engineVersion parameter that uses a different major version than the DB cluster's current version. Default is false.
applyImmediately Whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
arn Neptune Cluster ARN
availabilityZones List of EC2 Availability Zones that instances in the Neptune cluster can be created in.
backupRetentionPeriod Days to retain backups for. Default 1
clusterIdentifier Cluster identifier. If omitted, Terraform will assign a random, unique identifier.
clusterIdentifierPrefix Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier.
clusterMembers List of Neptune Instances that are a part of this cluster
clusterResourceId Neptune Cluster Resource ID
copyTagsToSnapshot If set to true, tags are copied to any snapshot of the DB cluster that is created.
deletionProtection Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
enableCloudwatchLogsExports List of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit and slowquery.
endpoint DNS address of the Neptune instance
engine Name of the database engine to be used for this Neptune cluster. Defaults to neptune.
engineVersion Database engine version.
finalSnapshotIdentifier Name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier Global cluster identifier specified on aws.neptune.GlobalCluster.
hostedZoneId Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled Whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
iamRoles List of ARNs for the IAM roles to associate to the Neptune Cluster.
kmsKeyArn ARN for the KMS encryption key. When specifying kmsKeyArn, storageEncrypted needs to be set to true.
neptuneClusterParameterGroupName Cluster parameter group to associate with the cluster.
neptuneInstanceParameterGroupName Name of DB parameter group to apply to all instances in the cluster. When upgrading, AWS does not return this value, so do not reference it in other arguments—either leave it unset, configure each instance directly, or ensure it matches the engineVersion.
neptuneSubnetGroupName Neptune subnet group to associate with this Neptune instance.
port Port on which the Neptune accepts connections. Default is 8182.
preferredBackupWindow 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint Read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
region Region where this resource will be managed. Defaults to the Region set in the provider configuration.
replicationSourceIdentifier ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
serverlessV2ScalingConfiguration If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
skipFinalSnapshot 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 finalSnapshotIdentifier. Default is false.
snapshotIdentifier 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. Automated snapshots should not be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced.
storageEncrypted Whether the Neptune cluster is encrypted. The default is false if not specified.
storageType Storage type associated with the cluster standard/iopt1. Default: standard.
tags Map of tags to assign to the Neptune cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
vpcSecurityGroupIds List of VPC security groups to associate with the Cluster
Implementation
const ClusterState({
this.allowMajorVersionUpgrade,
this.applyImmediately,
this.arn,
this.availabilityZones,
this.backupRetentionPeriod,
this.clusterIdentifier,
this.clusterIdentifierPrefix,
this.clusterMembers,
this.clusterResourceId,
this.copyTagsToSnapshot,
this.deletionProtection,
this.enableCloudwatchLogsExports,
this.endpoint,
this.engine,
this.engineVersion,
this.finalSnapshotIdentifier,
this.globalClusterIdentifier,
this.hostedZoneId,
this.iamDatabaseAuthenticationEnabled,
this.iamRoles,
this.kmsKeyArn,
this.neptuneClusterParameterGroupName,
this.neptuneInstanceParameterGroupName,
this.neptuneSubnetGroupName,
this.port,
this.preferredBackupWindow,
this.preferredMaintenanceWindow,
this.readerEndpoint,
this.region,
this.replicationSourceIdentifier,
this.serverlessV2ScalingConfiguration,
this.skipFinalSnapshot,
this.snapshotIdentifier,
this.storageEncrypted,
this.storageType,
this.tags,
this.tagsAll,
this.vpcSecurityGroupIds,
});