You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
5808
+
type: object
5809
+
properties:
5810
+
auth_provider:
5811
+
description: Auth providers to be used to authenticate to a Cloud Provider's Redis instance.
5812
+
type: string
5813
+
enum:
5814
+
- aws
5815
+
- azure
5816
+
- gcp
5817
+
x-referenceable: true
5818
+
aws_access_key_id:
5819
+
description: AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`.
5820
+
type: string
5821
+
x-encrypted: true
5822
+
x-referenceable: true
5823
+
aws_assume_role_arn:
5824
+
description: The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
5825
+
type: string
5826
+
x-encrypted: true
5827
+
x-referenceable: true
5828
+
aws_cache_name:
5829
+
description: The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`.
5830
+
type: string
5831
+
x-referenceable: true
5832
+
aws_is_serverless:
5833
+
description: This flag specifies whether the cluster is serverless when auth_provider is set to `aws`.
5834
+
type: boolean
5835
+
default: true
5836
+
aws_region:
5837
+
description: The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`.
5838
+
type: string
5839
+
x-referenceable: true
5840
+
aws_role_session_name:
5841
+
description: The session name for the temporary credentials when assuming the IAM role.
5842
+
type: string
5843
+
x-encrypted: true
5844
+
x-referenceable: true
5845
+
aws_secret_access_key:
5846
+
description: AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`.
5847
+
type: string
5848
+
x-encrypted: true
5849
+
x-referenceable: true
5850
+
azure_client_id:
5851
+
description: Azure Client ID to be used for authentication when `auth_provider` is set to `azure`.
5852
+
type: string
5853
+
x-encrypted: true
5854
+
x-referenceable: true
5855
+
azure_client_secret:
5856
+
description: Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`.
5857
+
type: string
5858
+
x-encrypted: true
5859
+
x-referenceable: true
5860
+
azure_tenant_id:
5861
+
description: Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`.
5862
+
type: string
5863
+
x-encrypted: true
5864
+
x-referenceable: true
5865
+
gcp_service_account_json:
5866
+
description: GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`.
5867
+
type: string
5868
+
x-encrypted: true
5869
+
x-referenceable: true
5804
5870
database:
5805
5871
description: Database to use for the Redis connection when using the `redis` strategy
5806
5872
type: integer
@@ -5890,6 +5956,70 @@ components:
5890
5956
config:
5891
5957
type: object
5892
5958
properties:
5959
+
cloud_authentication:
5960
+
description: Cloud auth related configs for connecting to a Cloud Provider's Redis instance.
5961
+
type: object
5962
+
properties:
5963
+
auth_provider:
5964
+
description: Auth providers to be used to authenticate to a Cloud Provider's Redis instance.
5965
+
type: string
5966
+
enum:
5967
+
- aws
5968
+
- azure
5969
+
- gcp
5970
+
x-referenceable: true
5971
+
aws_access_key_id:
5972
+
description: AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`.
5973
+
type: string
5974
+
x-encrypted: true
5975
+
x-referenceable: true
5976
+
aws_assume_role_arn:
5977
+
description: The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.
5978
+
type: string
5979
+
x-encrypted: true
5980
+
x-referenceable: true
5981
+
aws_cache_name:
5982
+
description: The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`.
5983
+
type: string
5984
+
x-referenceable: true
5985
+
aws_is_serverless:
5986
+
description: This flag specifies whether the cluster is serverless when auth_provider is set to `aws`.
5987
+
type: boolean
5988
+
default: true
5989
+
aws_region:
5990
+
description: The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`.
5991
+
type: string
5992
+
x-referenceable: true
5993
+
aws_role_session_name:
5994
+
description: The session name for the temporary credentials when assuming the IAM role.
5995
+
type: string
5996
+
x-encrypted: true
5997
+
x-referenceable: true
5998
+
aws_secret_access_key:
5999
+
description: AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`.
6000
+
type: string
6001
+
x-encrypted: true
6002
+
x-referenceable: true
6003
+
azure_client_id:
6004
+
description: Azure Client ID to be used for authentication when `auth_provider` is set to `azure`.
6005
+
type: string
6006
+
x-encrypted: true
6007
+
x-referenceable: true
6008
+
azure_client_secret:
6009
+
description: Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`.
6010
+
type: string
6011
+
x-encrypted: true
6012
+
x-referenceable: true
6013
+
azure_tenant_id:
6014
+
description: Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`.
6015
+
type: string
6016
+
x-encrypted: true
6017
+
x-referenceable: true
6018
+
gcp_service_account_json:
6019
+
description: GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`.
6020
+
type: string
6021
+
x-encrypted: true
6022
+
x-referenceable: true
5893
6023
cluster_max_redirections:
5894
6024
description: Maximum retry attempts for redirection.
5895
6025
type: integer
@@ -5929,6 +6059,7 @@ components:
5929
6059
description: 'A string representing a host name, such as example.com.'
5930
6060
type: string
5931
6061
default: 127.0.0.1
6062
+
x-referenceable: true
5932
6063
keepalive_backlog:
5933
6064
description: 'Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.'
5934
6065
type: integer
@@ -5951,6 +6082,7 @@ components:
5951
6082
default: 6379
5952
6083
maximum: 65535
5953
6084
minimum: 0
6085
+
x-referenceable: true
5954
6086
read_timeout:
5955
6087
description: An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
5956
6088
type: integer
@@ -6002,6 +6134,7 @@ components:
6002
6134
server_name:
6003
6135
description: A string representing an SNI (server name indication) value for TLS.
6004
6136
type: string
6137
+
x-referenceable: true
6005
6138
ssl:
6006
6139
description: 'If set to true, uses SSL to connect to Redis.'
0 commit comments