Package com.hashicorp.cdktf.providers.google.redis_instance

Interface RedisInstanceConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    RedisInstanceConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:22.524Z")
@Stability(Stable)
public interface RedisInstanceConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getMemorySizeGb

        @Stability(Stable)
@NotNull
Number getMemorySizeGb()
        Redis memory size in GiB.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#memory_size_gb RedisInstance#memory_size_gb}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        The ID of the instance or a fully qualified identifier for the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#name RedisInstance#name}

      • getAlternativeLocationId

        @Stability(Stable)
@Nullable
default String getAlternativeLocationId()
        Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones.

        If provided, it must be a different zone from the one provided in [locationId]. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#alternative_location_id RedisInstance#alternative_location_id}

      • getAuthEnabled

        @Stability(Stable)
@Nullable
default Object getAuthEnabled()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#auth_enabled RedisInstance#auth_enabled}

      • getAuthorizedNetwork

        @Stability(Stable)
@Nullable
default String getAuthorizedNetwork()
        The full name of the Google Compute Engine network to which the instance is connected.

        If left unspecified, the default network will be used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#authorized_network RedisInstance#authorized_network}

      • getConnectMode

        @Stability(Stable)
@Nullable
default String getConnectMode()
        The connection mode of the Redis instance. Default value: "DIRECT_PEERING" Possible values: ["DIRECT_PEERING", "PRIVATE_SERVICE_ACCESS"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#connect_mode RedisInstance#connect_mode}

      • getCustomerManagedKey

        @Stability(Stable)
@Nullable
default String getCustomerManagedKey()
        Optional.

        The KMS key reference that you want to use to encrypt the data at rest for this Redis instance. If this is provided, CMEK is enabled. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#customer_managed_key RedisInstance#customer_managed_key}

      • getDisplayName

        @Stability(Stable)
@Nullable
default String getDisplayName()
        An arbitrary and optional user-provided name for the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#display_name RedisInstance#display_name}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#id RedisInstance#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        Resource labels to represent user provided metadata.

        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#labels RedisInstance#labels}

      • getLocationId

        @Stability(Stable)
@Nullable
default String getLocationId()
        The zone where the instance will be provisioned.

        If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId]. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#location_id RedisInstance#location_id}

      • getMaintenancePolicy

        @Stability(Stable)
@Nullable
default RedisInstanceMaintenancePolicy getMaintenancePolicy()
        maintenance_policy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#maintenance_policy RedisInstance#maintenance_policy}

      • getMaintenanceVersion

        @Stability(Stable)
@Nullable
default String getMaintenanceVersion()
        The self service update maintenance version.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#maintenance_version RedisInstance#maintenance_version}

      • getPersistenceConfig

        @Stability(Stable)
@Nullable
default RedisInstancePersistenceConfig getPersistenceConfig()
        persistence_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#persistence_config RedisInstance#persistence_config}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#project RedisInstance#project}.

      • getReadReplicasMode

        @Stability(Stable)
@Nullable
default String getReadReplicasMode()
        Optional.

        Read replica mode. Can only be specified when trying to create the instance. If not set, Memorystore Redis backend will default to READ_REPLICAS_DISABLED. * READ_REPLICAS_DISABLED: If disabled, read endpoint will not be provided and the instance cannot scale up or down the number of replicas. * READ_REPLICAS_ENABLED: If enabled, read endpoint will be provided and the instance can scale up and down the number of replicas. Possible values: ["READ_REPLICAS_DISABLED", "READ_REPLICAS_ENABLED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#read_replicas_mode RedisInstance#read_replicas_mode}

      • getRedisConfigs

        @Stability(Stable)
@Nullable
default Map<String,​String> getRedisConfigs()
        Redis configuration parameters, according to http://redis.io/topics/config. Please check Memorystore documentation for the list of supported parameters: https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Instance.FIELDS.redis_configs.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#redis_configs RedisInstance#redis_configs}

      • getRedisVersion

        @Stability(Stable)
@Nullable
default String getRedisVersion()
        The version of Redis software.

        If not provided, latest supported version will be used. Please check the API documentation linked at the top for the latest valid values. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#redis_version RedisInstance#redis_version}

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        The name of the Redis region of the instance.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#region RedisInstance#region}

      • getReplicaCount

        @Stability(Stable)
@Nullable
default Number getReplicaCount()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#replica_count RedisInstance#replica_count}

      • getReservedIpRange

        @Stability(Stable)
@Nullable
default String getReservedIpRange()
        The CIDR range of internal addresses that are reserved for this instance.

        If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#reserved_ip_range RedisInstance#reserved_ip_range}

      • getSecondaryIpRange

        @Stability(Stable)
@Nullable
default String getSecondaryIpRange()
        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". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#secondary_ip_range RedisInstance#secondary_ip_range}

      • getTier

        @Stability(Stable)
@Nullable
default String getTier()
        The service tier of the instance. Must be one of these values:.

        * BASIC: standalone instance * STANDARD_HA: highly available primary/replica instances Default value: "BASIC" Possible values: ["BASIC", "STANDARD_HA"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#tier RedisInstance#tier}

      • getTimeouts

        @Stability(Stable)
@Nullable
default RedisInstanceTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#timeouts RedisInstance#timeouts}

      • getTransitEncryptionMode

        @Stability(Stable)
@Nullable
default String getTransitEncryptionMode()
        The TLS mode of the Redis instance, If not provided, TLS is disabled for the instance.

        * SERVER_AUTHENTICATION: Client to Server traffic encryption enabled with server authentication Default value: "DISABLED" Possible values: ["SERVER_AUTHENTICATION", "DISABLED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/redis_instance#transit_encryption_mode RedisInstance#transit_encryption_mode}