InstanceArgs

data class InstanceArgs(val alternativeLocationId: Output<String>? = null, val authEnabled: Output<Boolean>? = null, val authorizedNetwork: Output<String>? = null, val availableMaintenanceVersions: Output<List<String>>? = null, val connectMode: Output<InstanceConnectMode>? = null, val customerManagedKey: Output<String>? = null, val displayName: Output<String>? = null, val instanceId: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val maintenancePolicy: Output<MaintenancePolicyArgs>? = null, val maintenanceVersion: Output<String>? = null, val memorySizeGb: Output<Int>? = null, val name: Output<String>? = null, val persistenceConfig: Output<PersistenceConfigArgs>? = null, val project: Output<String>? = null, val readReplicasMode: Output<InstanceReadReplicasMode>? = null, val redisConfigs: Output<Map<String, String>>? = null, val redisVersion: Output<String>? = null, val replicaCount: Output<Int>? = null, val reservedIpRange: Output<String>? = null, val secondaryIpRange: Output<String>? = null, val suspensionReasons: Output<List<InstanceSuspensionReasonsItem>>? = null, val tier: Output<InstanceTier>? = null, val transitEncryptionMode: Output<InstanceTransitEncryptionMode>? = null) : ConvertibleToJava<InstanceArgs>

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Constructors

Link copied to clipboard
fun InstanceArgs(alternativeLocationId: Output<String>? = null, authEnabled: Output<Boolean>? = null, authorizedNetwork: Output<String>? = null, availableMaintenanceVersions: Output<List<String>>? = null, connectMode: Output<InstanceConnectMode>? = null, customerManagedKey: Output<String>? = null, displayName: Output<String>? = null, instanceId: Output<String>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, maintenancePolicy: Output<MaintenancePolicyArgs>? = null, maintenanceVersion: Output<String>? = null, memorySizeGb: Output<Int>? = null, name: Output<String>? = null, persistenceConfig: Output<PersistenceConfigArgs>? = null, project: Output<String>? = null, readReplicasMode: Output<InstanceReadReplicasMode>? = null, redisConfigs: Output<Map<String, String>>? = null, redisVersion: Output<String>? = null, replicaCount: Output<Int>? = null, reservedIpRange: Output<String>? = null, secondaryIpRange: Output<String>? = null, suspensionReasons: Output<List<InstanceSuspensionReasonsItem>>? = null, tier: Output<InstanceTier>? = null, transitEncryptionMode: Output<InstanceTransitEncryptionMode>? = null)

Functions

Link copied to clipboard
open override fun toJava(): InstanceArgs

Properties

Link copied to clipboard
val alternativeLocationId: Output<String>? = null

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.

Link copied to clipboard
val authEnabled: Output<Boolean>? = null

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.

Link copied to clipboard
val authorizedNetwork: Output<String>? = null

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.

Link copied to clipboard

Optional. The available maintenance versions that an instance could update to.

Link copied to clipboard
val connectMode: Output<InstanceConnectMode>? = null

Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.

Link copied to clipboard
val customerManagedKey: Output<String>? = null

Optional. The KMS key reference that the customer provides when trying to create the instance.

Link copied to clipboard
val displayName: Output<String>? = null

An arbitrary and optional user-provided name for the instance.

Link copied to clipboard
val instanceId: Output<String>? = null

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

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

Resource labels to represent user provided metadata

Link copied to clipboard
val location: Output<String>? = null

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.

Link copied to clipboard

Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.

Link copied to clipboard
val maintenanceVersion: Output<String>? = null

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

Link copied to clipboard
val memorySizeGb: Output<Int>? = null

Redis memory size in GiB.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard

Optional. Persistence configuration parameters

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard

Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.

Link copied to clipboard
val redisConfigs: Output<Map<String, String>>? = null

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

Link copied to clipboard
val redisVersion: Output<String>? = null

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

Link copied to clipboard
val replicaCount: Output<Int>? = null

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.

Link copied to clipboard
val reservedIpRange: Output<String>? = null

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.

Link copied to clipboard
val secondaryIpRange: Output<String>? = null

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".

Link copied to clipboard

Optional. reasons that causes instance in "SUSPENDED" state.

Link copied to clipboard
val tier: Output<InstanceTier>? = null

The service tier of the instance.

Link copied to clipboard

Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.