---
title: "PartialRedisCe"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93/schemas/PartialRedisCe"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93.md

# PartialRedisCe

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Konnect Control Planes Configuration
  version: 3.14.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    PartialRedisCe:
      type: object
      properties:
        config:
          type: object
          properties:
            cloud_authentication:
              description: Cloud auth related configs for connecting to a Cloud Provider's
                Redis instance.
              type: object
              properties:
                auth_provider:
                  description: Auth providers to be used to authenticate to a Cloud Provider's
                    Redis instance.
                  type: string
                  enum:
                    - aws
                    - azure
                    - gcp
                  x-referenceable: true
                aws_access_key_id:
                  description: AWS Access Key ID to be used for authentication when
                    `auth_provider` is set to `aws`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                aws_assume_role_arn:
                  description: The ARN of the IAM role to assume for generating ElastiCache IAM
                    authentication tokens.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                aws_cache_name:
                  description: The name of the AWS Elasticache cluster when `auth_provider` is set
                    to `aws`.
                  type: string
                  x-referenceable: true
                aws_is_serverless:
                  description: This flag specifies whether the cluster is serverless when
                    auth_provider is set to `aws`.
                  type: boolean
                  default: true
                aws_region:
                  description: The region of the AWS ElastiCache cluster when `auth_provider` is
                    set to `aws`.
                  type: string
                  x-referenceable: true
                aws_role_session_name:
                  description: The session name for the temporary credentials when assuming the
                    IAM role.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                aws_secret_access_key:
                  description: AWS Secret Access Key to be used for authentication when
                    `auth_provider` is set to `aws`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                azure_client_id:
                  description: Azure Client ID to be used for authentication when `auth_provider`
                    is set to `azure`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                azure_client_secret:
                  description: Azure Client Secret to be used for authentication when
                    `auth_provider` is set to `azure`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                azure_tenant_id:
                  description: Azure Tenant ID to be used for authentication when `auth_provider`
                    is set to `azure`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
                gcp_service_account_json:
                  description: GCP Service Account JSON to be used for authentication when
                    `auth_provider` is set to `gcp`.
                  type: string
                  x-encrypted: true
                  x-referenceable: true
            database:
              description: Database to use for the Redis connection when using the `redis`
                strategy
              type: integer
              default: 0
            host:
              description: A string representing a host name, such as example.com.
              type: string
              x-referenceable: true
            password:
              description: Password to use for Redis connections. If undefined, no AUTH
                commands are sent to Redis.
              type: string
              x-encrypted: true
              x-referenceable: true
            port:
              description: An integer representing a port number between 0 and 65535,
                inclusive.
              type: integer
              default: 6379
              maximum: 65535
              minimum: 0
              x-referenceable: true
            server_name:
              description: A string representing an SNI (server name indication) value for
                TLS.
              type: string
              x-referenceable: true
            ssl:
              description: If set to true, uses SSL to connect to Redis.
              type: boolean
              default: false
            ssl_verify:
              description: If set to true, verifies the validity of the server SSL
                certificate. If setting this parameter, also configure
                `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA
                (or server) certificate used by your Redis server. You may also
                need to configure `lua_ssl_verify_depth` accordingly.
              type: boolean
              default: true
            timeout:
              description: An integer representing a timeout in milliseconds. Must be between
                0 and 2^31-2.
              type: integer
              default: 2000
              maximum: 2147483646
              minimum: 0
            username:
              description: Username to use for Redis connections. If undefined, ACL
                authentication won't be performed. This requires Redis v6.0.0+.
                To be compatible with Redis v5.x.y, you can set it to `default`.
              type: string
              x-referenceable: true
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          nullable: true
        id:
          description: A string representing a UUID (universally unique identifier).
          type: string
          nullable: true
        name:
          description: A unique string representing a UTF-8 encoded name.
          type: string
          nullable: true
        tags:
          description: A set of strings representing tags.
          type: array
          items:
            description: A string representing a tag.
            type: string
          nullable: true
        type:
          type: string
          enum:
            - redis-ce
          x-terraform-transform-const: true
        updated_at:
          description: Unix epoch when the resource was last updated.
          type: integer
          nullable: true
      example:
        config:
          database: 0
          host: localhost
          password: password
          port: 6379
          server_name: redis
          ssl: false
          ssl_verify: false
          timeout: 2000
          username: username
        type: redis-ce
      additionalProperties: false
      required:
        - type
        - config
```
