redis

Documentation

Index

• Constants
• func GenerateAuthToken() string
• func GenerateReplicationGroupName(instanceID string) string
• func GetPrimaryAndReplicaCacheClusterIds(replicationGroup *elasticache.ReplicationGroup) (primary string, replica string, err error)
• func RandomAlphaNum(length int) string
• type RedisProvider
  • func NewProvider(elastiCache providers.ElastiCache, secretsManager providers.SecretsManager, ...) *RedisProvider
  • func (p *RedisProvider) CreateAuthTokenSecret(ctx context.Context, instanceID string, authToken string) error
  • func (p *RedisProvider) DeleteAuthTokenSecret(ctx context.Context, instanceID string, recoveryWindowInDays int) error
  • func (p *RedisProvider) DeleteCacheParameterGroup(ctx context.Context, instanceID string) error
  • func (p *RedisProvider) Deprovision(ctx context.Context, instanceID string, params providers.DeprovisionParameters) error
  • func (p *RedisProvider) FindSnapshots(ctx context.Context, instanceID string) ([]providers.SnapshotInfo, error)
  • func (p *RedisProvider) GenerateCredentials(ctx context.Context, instanceID, bindingID string) (*providers.Credentials, error)
  • func (p *RedisProvider) GetInstanceParameters(ctx context.Context, instanceID string) (providers.InstanceParameters, error)
  • func (p *RedisProvider) GetInstanceTags(ctx context.Context, instanceID string) (map[string]string, error)
  • func (p *RedisProvider) ProgressState(ctx context.Context, instanceID string, operation string, ...) (providers.ServiceState, string, error)
  • func (p *RedisProvider) Provision(ctx context.Context, instanceID string, params providers.ProvisionParameters) error
  • func (p *RedisProvider) RevokeCredentials(ctx context.Context, instanceID, bindingID string) error
  • func (p *RedisProvider) StartFailoverTest(ctx context.Context, instanceID string) (string, error)
  • func (p *RedisProvider) UpdateParamGroupParameters(ctx context.Context, instanceID string, ...) error
  • func (p *RedisProvider) UpdateReplicationGroup(ctx context.Context, instanceID string, ...) error

Constants

const PasswordLength = 32

Functions

func GenerateAuthToken

func GenerateAuthToken() string

GenerateAuthToken generates an alphanumeric cryptographically-secure password

func GenerateReplicationGroupName

func GenerateReplicationGroupName(instanceID string) string

GenerateReplicationGroupName generates a valid ElastiCache replication group name A valid name must contain between 1 and 20 alphanumeric characters or hyphens, should start with a letter, and cannot end with a hyphen or contain two consecutive hyphens.

func GetPrimaryAndReplicaCacheClusterIds

func GetPrimaryAndReplicaCacheClusterIds(replicationGroup *elasticache.ReplicationGroup) (primary string, replica string, err error)

func RandomAlphaNum

func RandomAlphaNum(length int) string

Types

type RedisProvider

type RedisProvider struct {
	// contains filtered or unexported fields
}

RedisProvider is the Redis broker provider

func NewProvider

func NewProvider(
	elastiCache providers.ElastiCache,
	secretsManager providers.SecretsManager,
	awsAccountID, awsPartition,
	awsRegion string,
	logger lager.Logger,
	kmsKeyID string,
	secretsManagerPath string,
) *RedisProvider

NewProvider creates a new Redis provider

func (*RedisProvider) CreateAuthTokenSecret

func (p *RedisProvider) CreateAuthTokenSecret(ctx context.Context, instanceID string, authToken string) error

func (*RedisProvider) DeleteAuthTokenSecret

func (p *RedisProvider) DeleteAuthTokenSecret(ctx context.Context, instanceID string, recoveryWindowInDays int) error

func (*RedisProvider) DeleteCacheParameterGroup

func (p *RedisProvider) DeleteCacheParameterGroup(ctx context.Context, instanceID string) error

func (*RedisProvider) Deprovision

func (p *RedisProvider) Deprovision(ctx context.Context, instanceID string, params providers.DeprovisionParameters) error

Deprovision deletes the replication group

func (*RedisProvider) FindSnapshots

func (p *RedisProvider) FindSnapshots(ctx context.Context, instanceID string) ([]providers.SnapshotInfo, error)

FindSnapshots returns the list of snapshots found for a given instance ID

func (*RedisProvider) GenerateCredentials

func (p *RedisProvider) GenerateCredentials(ctx context.Context, instanceID, bindingID string) (*providers.Credentials, error)

GenerateCredentials generates the client credentials for a Redis instance and an app

func (*RedisProvider) GetInstanceParameters

func (p *RedisProvider) GetInstanceParameters(ctx context.Context, instanceID string) (providers.InstanceParameters, error)

func (*RedisProvider) GetInstanceTags

func (p *RedisProvider) GetInstanceTags(ctx context.Context, instanceID string) (map[string]string, error)

func (*RedisProvider) ProgressState

func (p *RedisProvider) ProgressState(
	ctx context.Context,
	instanceID string,
	operation string,
	oldPrimaryNode string,
) (providers.ServiceState, string, error)

ProgressState returns with the state of an existing cluster and progresses any change in progress If the cluster doesn't exist we return with the providers.NonExisting state

func (*RedisProvider) Provision

func (p *RedisProvider) Provision(ctx context.Context, instanceID string, params providers.ProvisionParameters) error

Provision creates a replication group and a cache parameter group

func (*RedisProvider) RevokeCredentials

func (p *RedisProvider) RevokeCredentials(ctx context.Context, instanceID, bindingID string) error

RevokeCredentials revokes the credentials between an app and a Redis instance

The method does nothing because we can't revoke the credentials as there is one common password for a Redis service instance

func (*RedisProvider) StartFailoverTest

func (p *RedisProvider) StartFailoverTest(ctx context.Context, instanceID string) (string, error)

func (*RedisProvider) UpdateParamGroupParameters

func (p *RedisProvider) UpdateParamGroupParameters(ctx context.Context, instanceID string, params providers.UpdateParamGroupParameters) error

func (*RedisProvider) UpdateReplicationGroup

func (p *RedisProvider) UpdateReplicationGroup(ctx context.Context, instanceID string, params providers.UpdateReplicationGroupParameters) error