ClusterState class

Input properties used for looking up and filtering Cluster resources.

Constructors

ClusterState({Input<bool?>? allowMajorVersionUpgrade, Input<bool?>? applyImmediately, Input<String?>? arn, Input<List<String>?>? availabilityZones, Input<int?>? backupRetentionPeriod, Input<String?>? clusterIdentifier, Input<String?>? clusterIdentifierPrefix, Input<List<String>?>? clusterMembers, Input<String?>? clusterResourceId, Input<bool?>? copyTagsToSnapshot, Input<bool?>? deletionProtection, Input<List<String>?>? enableCloudwatchLogsExports, Input<String?>? endpoint, Input<String?>? engine, Input<String?>? engineVersion, Input<String?>? finalSnapshotIdentifier, Input<String?>? globalClusterIdentifier, Input<String?>? hostedZoneId, Input<bool?>? iamDatabaseAuthenticationEnabled, Input<List<String>?>? iamRoles, 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<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<List<String>?>? vpcSecurityGroupIds})
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
const
ClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

allowMajorVersionUpgrade → Input<bool?>?
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.
final
applyImmediately → Input<bool?>?
Whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
final
arn → Input<String?>?
Neptune Cluster ARN
final
availabilityZones → Input<List<String>?>?
List of EC2 Availability Zones that instances in the Neptune cluster can be created in.
final
backupRetentionPeriod → Input<int?>?
Days to retain backups for. Default 1
final
clusterIdentifier → Input<String?>?
Cluster identifier. If omitted, Terraform will assign a random, unique identifier.
final
clusterIdentifierPrefix → Input<String?>?
Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifier.
final
clusterMembers → Input<List<String>?>?
List of Neptune Instances that are a part of this cluster
final
clusterResourceId → Input<String?>?
Neptune Cluster Resource ID
final
copyTagsToSnapshot → Input<bool?>?
If set to true, tags are copied to any snapshot of the DB cluster that is created.
final
deletionProtection → Input<bool?>?
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.
final
enableCloudwatchLogsExports → Input<List<String>?>?
List of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports audit and slowquery.
final
endpoint → Input<String?>?
DNS address of the Neptune instance
final
engine → Input<String?>?
Name of the database engine to be used for this Neptune cluster. Defaults to neptune.
final
engineVersion → Input<String?>?
Database engine version.
final
finalSnapshotIdentifier → Input<String?>?
Name of your final Neptune snapshot when this Neptune cluster is deleted. If omitted, no final snapshot will be made.
final
globalClusterIdentifier → Input<String?>?
Global cluster identifier specified on aws.neptune.GlobalCluster.
final
hashCode → int
The hash code for this object.
no setterinherited
hostedZoneId → Input<String?>?
Route53 Hosted Zone ID of the endpoint
final
iamDatabaseAuthenticationEnabled → Input<bool?>?
Whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
final
iamRoles → Input<List<String>?>?
List of ARNs for the IAM roles to associate to the Neptune Cluster.
final
kmsKeyArn → Input<String?>?
ARN for the KMS encryption key. When specifying kmsKeyArn, storageEncrypted needs to be set to true.
final
neptuneClusterParameterGroupName → Input<String?>?
Cluster parameter group to associate with the cluster.
final
neptuneInstanceParameterGroupName → Input<String?>?
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.
final
neptuneSubnetGroupName → Input<String?>?
Neptune subnet group to associate with this Neptune instance.
final
port → Input<int?>?
Port on which the Neptune accepts connections. Default is 8182.
final
preferredBackupWindow → Input<String?>?
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
final
preferredMaintenanceWindow → Input<String?>?
Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
final
readerEndpoint → Input<String?>?
Read-only endpoint for the Neptune cluster, automatically load-balanced across replicas
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
replicationSourceIdentifier → Input<String?>?
ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverlessV2ScalingConfiguration → Input<ClusterServerlessV2ScalingConfiguration?>?
If set, create the Neptune cluster as a serverless one. See Serverless for example block attributes.
final
skipFinalSnapshot → Input<bool?>?
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.
final
snapshotIdentifier → Input<String?>?
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.
final
storageEncrypted → Input<bool?>?
Whether the Neptune cluster is encrypted. The default is false if not specified.
final
storageType → Input<String?>?
Storage type associated with the cluster standard/iopt1. Default: standard.
final
tags → Input<Map<String, String>?>?
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.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security groups to associate with the Cluster
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited