InstanceArgs class

The set of arguments for Instance. The set of arguments for Instance.

Constructors

InstanceArgs({Input<String>? alternativeLocationId, Input<bool>? authEnabled, Input<String>? authorizedNetwork, Input<List<String>>? availableMaintenanceVersions, Input<InstanceConnectMode>? connectMode, Input<String>? customerManagedKey, Input<String>? displayName, required Input<String> instanceId, Input<Map<String, String>>? labels, Input<String>? location, Input<MaintenancePolicy>? maintenancePolicy, Input<String>? maintenanceVersion, required Input<int> memorySizeGb, Input<String>? name, Input<PersistenceConfig>? persistenceConfig, Input<String>? project, Input<InstanceReadReplicasMode>? readReplicasMode, Input<Map<String, String>>? redisConfigs, Input<String>? redisVersion, Input<int>? replicaCount, Input<String>? reservedIpRange, Input<String>? secondaryIpRange, Input<List<InstanceSuspensionReasonsItem>>? suspensionReasons, required Input<InstanceTier> tier, Input<InstanceTransitEncryptionMode>? transitEncryptionMode})
Creates a new InstanceArgs. alternativeLocationId Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in location_id. Additional nodes beyond the first 2 will be placed in zones selected by the service. authEnabled Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. authorizedNetwork Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used. availableMaintenanceVersions Optional. The available maintenance versions that an instance could update to. connectMode Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. customerManagedKey Optional. The KMS key reference that the customer provides when trying to create the instance. displayName An arbitrary and optional user-provided name for the instance. instanceId Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location labels Resource labels to represent user provided metadata location Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. maintenancePolicy Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time. maintenanceVersion Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". memorySizeGb Redis memory size in GiB. name Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. persistenceConfig Optional. Persistence configuration parameters project Optional. readReplicasMode Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. redisConfigs Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries redisVersion Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility replicaCount Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is 1-5 and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. reservedIpRange Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. secondaryIpRange Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". suspensionReasons Optional. reasons that causes instance in "SUSPENDED" state. tier The service tier of the instance. transitEncryptionMode Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
const
InstanceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

alternativeLocationId → Input<String>?
Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in location_id. Additional nodes beyond the first 2 will be placed in zones selected by the service.
final
authEnabled → Input<bool>?
Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.
final
authorizedNetwork → Input<String>?
Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
final
availableMaintenanceVersions → Input<List<String>>?
Optional. The available maintenance versions that an instance could update to.
final
connectMode → Input<InstanceConnectMode>?
Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
final
customerManagedKey → Input<String>?
Optional. The KMS key reference that the customer provides when trying to create the instance.
final
displayName → Input<String>?
An arbitrary and optional user-provided name for the instance.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceId → Input<String>
Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-40 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
final
labels → Input<Map<String, String>>?
Resource labels to represent user provided metadata
final
location → Input<String>?
Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.
final
maintenancePolicy → Input<MaintenancePolicy>?
Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
final
maintenanceVersion → Input<String>?
Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
final
memorySizeGb → Input<int>
Redis memory size in GiB.
final
name → Input<String>?
Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.
final
persistenceConfig → Input<PersistenceConfig>?
Optional. Persistence configuration parameters
final
project → Input<String>?
final
readReplicasMode → Input<InstanceReadReplicasMode>?
Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
final
redisConfigs → Input<Map<String, String>>?
Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
final
redisVersion → Input<String>?
Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * REDIS_3_2 for Redis 3.2 compatibility * REDIS_4_0 for Redis 4.0 compatibility (default) * REDIS_5_0 for Redis 5.0 compatibility * REDIS_6_X for Redis 6.x compatibility
final
replicaCount → Input<int>?
Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is 1-5 and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.
final
reservedIpRange → Input<String>?
Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryIpRange → Input<String>?
Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".
final
suspensionReasons → Input<List<InstanceSuspensionReasonsItem>>?
Optional. reasons that causes instance in "SUSPENDED" state.
final
tier → Input<InstanceTier>
The service tier of the instance.
final
transitEncryptionMode → Input<InstanceTransitEncryptionMode>?
Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
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