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<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<bool?>? writer})
Creates a new ClusterInstanceState. address The hostname of the instance. See also endpoint and port. applyImmediately Specifies whether any instance modifications arn ARN of neptune instance autoMinorVersionUpgrade Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is true. availabilityZone The EC2 Availability Zone that the neptune instance is created in. clusterIdentifier The identifier of the aws.neptune.Cluster in which to launch this instance. dbiResourceId The region-unique, immutable identifier for the neptune instance. endpoint The connection endpoint in address:port format. engine The name of the database engine to be used for the neptune instance. Defaults to neptune. Valid Values: neptune. engineVersion The neptune engine version. Currently configuring this argumnet has no effect. identifier The identifier for the neptune instance, if omitted, this provider will assign a random, unique identifier. identifierPrefix Creates a unique identifier beginning with the specified prefix. Conflicts with identifier. instanceClass The instance class to use. kmsKeyArn The ARN for the KMS encryption key if one is set to the neptune cluster. neptuneParameterGroupName The name of the neptune parameter group to associate with this instance. neptuneSubnetGroupName A subnet group to associate with this neptune instance. NOTE: This must match the neptuneSubnetGroupName of the attached aws.neptune.Cluster. port The port on which the DB accepts connections. Defaults to 8182. preferredBackupWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00" preferredMaintenanceWindow The window to perform maintenance in. promotionTier Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer. publiclyAccessible Bool to control if instance is publicly accessible. Default is false. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. skipFinalSnapshot Determines whether a final DB snapshot is created before the DB instance is deleted. storageEncrypted Specifies whether the neptune cluster is encrypted. storageType Storage type associated with the cluster standard/iopt1. tags A map of tags to assign to the instance. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. writer Boolean indicating if this instance is writable. False indicates 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 endpoint and port.
final
applyImmediately → Input<bool?>?
Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default isfalse.
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.Cluster in 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:port format.
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 neptuneSubnetGroupName of the attached aws.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
tags → Input<Map<String, String>?>?
A map of tags to assign to the instance. 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>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
writer → Input<bool?>?
Boolean indicating if this instance is writable. False indicates 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