ClusterInstanceState class
Input properties used for looking up and filtering ClusterInstance resources.
Constructors
-
ClusterInstanceState({Input<
String?> ? address, Input<bool?> ? applyImmediately, Input<String?> ? arn, Input<bool?> ? autoMinorVersionUpgrade, Input<String?> ? availabilityZone, Input<String?> ? clusterIdentifier, Input<String?> ? dbiResourceId, Input<String?> ? endpoint, Input<String?> ? engine, Input<String?> ? engineVersion, Input<String?> ? identifier, Input<String?> ? identifierPrefix, Input<String?> ? instanceClass, Input<String?> ? kmsKeyArn, Input<String?> ? neptuneParameterGroupName, Input<String?> ? neptuneSubnetGroupName, Input<int?> ? port, Input<String?> ? preferredBackupWindow, Input<String?> ? preferredMaintenanceWindow, Input<int?> ? promotionTier, Input<bool?> ? publiclyAccessible, Input<String?> ? region, Input<bool?> ? skipFinalSnapshot, Input<bool?> ? storageEncrypted, Input<String?> ? storageType, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>bool?> ? writer}) -
Creates a new ClusterInstanceState.
addressThe hostname of the instance. See alsoendpointandport.applyImmediatelySpecifies whether any instance modificationsarnARN of neptune instanceautoMinorVersionUpgradeIndicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default istrue.availabilityZoneThe EC2 Availability Zone that the neptune instance is created in.clusterIdentifierThe identifier of theaws.neptune.Clusterin which to launch this instance.dbiResourceIdThe region-unique, immutable identifier for the neptune instance.endpointThe connection endpoint inaddress:portformat.engineThe name of the database engine to be used for the neptune instance. Defaults toneptune. Valid Values:neptune.engineVersionThe neptune engine version. Currently configuring this argumnet has no effect.identifierThe identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.identifierPrefixCreates a unique identifier beginning with the specified prefix. Conflicts withidentifier.instanceClassThe instance class to use.kmsKeyArnThe ARN for the KMS encryption key if one is set to the neptune cluster.neptuneParameterGroupNameThe name of the neptune parameter group to associate with this instance.neptuneSubnetGroupNameA subnet group to associate with this neptune instance. NOTE: This must match theneptuneSubnetGroupNameof the attachedaws.neptune.Cluster.portThe port on which the DB accepts connections. Defaults to8182.preferredBackupWindowThe daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"preferredMaintenanceWindowThe window to perform maintenance in.promotionTierDefault 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.publiclyAccessibleBool to control if instance is publicly accessible. Default isfalse.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.skipFinalSnapshotDetermines whether a final DB snapshot is created before the DB instance is deleted.storageEncryptedSpecifies whether the neptune cluster is encrypted.storageTypeStorage type associated with the clusterstandard/iopt1.tagsA map of tags to assign to the instance. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.writerBoolean indicating if this instance is writable.Falseindicates this instance is a read replica.const -
ClusterInstanceState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
address
→ Input<
String?> ? -
The hostname of the instance. See also
endpointandport.final -
applyImmediately
→ Input<
bool?> ? -
Specifies whether any instance modifications
are applied immediately, or during the next maintenance window. Default is
false.final -
arn
→ Input<
String?> ? -
ARN of neptune instance
final
-
autoMinorVersionUpgrade
→ Input<
bool?> ? -
Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is
true.final -
availabilityZone
→ Input<
String?> ? -
The EC2 Availability Zone that the neptune instance is created in.
final
-
clusterIdentifier
→ Input<
String?> ? -
The identifier of the
aws.neptune.Clusterin which to launch this instance.final -
dbiResourceId
→ Input<
String?> ? -
The region-unique, immutable identifier for the neptune instance.
final
-
endpoint
→ Input<
String?> ? -
The connection endpoint in
address:portformat.final -
engine
→ Input<
String?> ? -
The name of the database engine to be used for the neptune instance. Defaults to
neptune. Valid Values:neptune.final -
engineVersion
→ Input<
String?> ? -
The neptune engine version. Currently configuring this argumnet has no effect.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ Input<
String?> ? -
The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier.
final
-
identifierPrefix
→ Input<
String?> ? -
Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.final -
instanceClass
→ Input<
String?> ? -
The instance class to use.
final
-
kmsKeyArn
→ Input<
String?> ? -
The ARN for the KMS encryption key if one is set to the neptune cluster.
final
-
neptuneParameterGroupName
→ Input<
String?> ? -
The name of the neptune parameter group to associate with this instance.
final
-
neptuneSubnetGroupName
→ Input<
String?> ? -
A subnet group to associate with this neptune instance. NOTE: This must match the
neptuneSubnetGroupNameof the attachedaws.neptune.Cluster.final -
port
→ Input<
int?> ? -
The port on which the DB accepts connections. Defaults to
8182.final -
preferredBackupWindow
→ Input<
String?> ? -
The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00"
final
-
preferredMaintenanceWindow
→ Input<
String?> ? -
The window to perform maintenance in.
Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
final
-
promotionTier
→ Input<
int?> ? -
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
final
-
publiclyAccessible
→ Input<
bool?> ? -
Bool to control if instance is publicly accessible. Default is
false.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
skipFinalSnapshot
→ Input<
bool?> ? -
Determines whether a final DB snapshot is created before the DB instance is deleted.
final
-
storageEncrypted
→ Input<
bool?> ? -
Specifies whether the neptune cluster is encrypted.
final
-
storageType
→ Input<
String?> ? -
Storage type associated with the cluster
standard/iopt1.final -
A map of tags to assign to the instance. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
writer
→ Input<
bool?> ? -
Boolean indicating if this instance is writable.
Falseindicates this instance is a read replica.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