elasticache

Documentation

Index

• Constants
• func CacheClusterNeedsUpdate(kube *v1alpha2.ReplicationGroup, cc elasticache.CacheCluster) bool
• func IsAlreadyExists(err error) bool
• func IsNotFound(err error) bool
• func NewCreateReplicationGroupInput(g *v1alpha2.ReplicationGroup, authToken string) *elasticache.CreateReplicationGroupInput
• func NewDeleteReplicationGroupInput(g *v1alpha2.ReplicationGroup) *elasticache.DeleteReplicationGroupInput
• func NewDescribeCacheClustersInput(cluster string) *elasticache.DescribeCacheClustersInput
• func NewDescribeReplicationGroupsInput(g *v1alpha2.ReplicationGroup) *elasticache.DescribeReplicationGroupsInput
• func NewModifyReplicationGroupInput(g *v1alpha2.ReplicationGroup) *elasticache.ModifyReplicationGroupInput
• func NewReplicationGroupDescription(g *v1alpha2.ReplicationGroup) string
• func NewReplicationGroupID(o metav1.Object) string
• func ReplicationGroupNeedsUpdate(kube *v1alpha2.ReplicationGroup, rg elasticache.ReplicationGroup) bool
• type Client
  • func NewClient(credentials []byte, region string) (Client, error)
• type Endpoint
  • func ConnectionEndpoint(rg elasticache.ReplicationGroup) Endpoint

Constants

const NamePrefix = "ec"

NamePrefix is the prefix for all created ElastiCache replication groups.

Functions

func CacheClusterNeedsUpdate

func CacheClusterNeedsUpdate(kube *v1alpha2.ReplicationGroup, cc elasticache.CacheCluster) bool

CacheClusterNeedsUpdate returns true if the supplied Kubernetes resource differs from the supplied AWS resource. It considers only fields that can be modified in place without deleting and recreating the group, and only fields that are first class properties of the AWS replication group.

func IsAlreadyExists

func IsAlreadyExists(err error) bool

IsAlreadyExists returns true if the supplied error indicates a Replication Group already exists.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the supplied error indicates a Replication Group was not found.

func NewCreateReplicationGroupInput

func NewCreateReplicationGroupInput(g *v1alpha2.ReplicationGroup, authToken string) *elasticache.CreateReplicationGroupInput

NewCreateReplicationGroupInput returns ElastiCache replication group creation input suitable for use with the AWS API.

func NewDeleteReplicationGroupInput

func NewDeleteReplicationGroupInput(g *v1alpha2.ReplicationGroup) *elasticache.DeleteReplicationGroupInput

NewDeleteReplicationGroupInput returns ElastiCache replication group deletion input suitable for use with the AWS API.

func NewDescribeCacheClustersInput

func NewDescribeCacheClustersInput(cluster string) *elasticache.DescribeCacheClustersInput

NewDescribeCacheClustersInput returns ElastiCache cache cluster describe input suitable for use with the AWS API.

func NewDescribeReplicationGroupsInput

func NewDescribeReplicationGroupsInput(g *v1alpha2.ReplicationGroup) *elasticache.DescribeReplicationGroupsInput

NewDescribeReplicationGroupsInput returns ElastiCache replication group describe input suitable for use with the AWS API.

func NewModifyReplicationGroupInput

func NewModifyReplicationGroupInput(g *v1alpha2.ReplicationGroup) *elasticache.ModifyReplicationGroupInput

NewModifyReplicationGroupInput returns ElastiCache replication group modification input suitable for use with the AWS API.

func NewReplicationGroupDescription

func NewReplicationGroupDescription(g *v1alpha2.ReplicationGroup) string

NewReplicationGroupDescription returns a description suitable for use with the AWS API.

func NewReplicationGroupID

func NewReplicationGroupID(o metav1.Object) string

NewReplicationGroupID returns an identifier used to identify a Replication Group in the AWS API.

func ReplicationGroupNeedsUpdate

func ReplicationGroupNeedsUpdate(kube *v1alpha2.ReplicationGroup, rg elasticache.ReplicationGroup) bool

ReplicationGroupNeedsUpdate returns true if the supplied Kubernetes resource differs from the supplied AWS resource. It considers only fields that can be modified in place without deleting and recreating the group, and only fields that are first class properties of the AWS replication group.

Types

type Client

type Client elasticacheiface.ElastiCacheAPI

A Client handles CRUD operations for ElastiCache resources. This interface is compatible with the upstream AWS redis client.

func NewClient

func NewClient(credentials []byte, region string) (Client, error)

NewClient returns a new ElastiCache client. Credentials must be passed as JSON encoded data.

type Endpoint

type Endpoint struct {
	Address string
	Port    int
}

Endpoint represents the address and port used to connect to an ElastiCache Replication Group.

func ConnectionEndpoint

func ConnectionEndpoint(rg elasticache.ReplicationGroup) Endpoint

ConnectionEndpoint returns the connection endpoint for a Replication Group. https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Endpoints.html