RedisProps

@cosmos-building-blocks/service › Globals › RedisProps

Redis Cluster props. for the optional props not provided, following defaults will be used: Refer https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html for more details on each prop

default replicationGroupDescription: 'Redis cluster', // Mandatory Description atRestEncryptionEnabled: true, // Enable encryption at rest cacheNodeType: 'cache.t3.micro', // Instance type numCacheClusters: 1, // The number of clusters this replication group initially has transitEncryptionEnabled: true, // Enable transit encryption automaticFailoverEnabled: false, // Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

Hierarchy

• object

  ↳ RedisProps

Index

Properties

• connectionsAllowedFrom
• highAvailabilityMode
• securityGroups
• subnets
• vpc

Properties

Optional Readonly connectionsAllowedFrom

• connectionsAllowedFrom? : string | IConnectable

Defined in packages/@cosmos-building-blocks/service/src/redis.ts:71

Allowed ingress connections to Redis SecurityGroup

default - Allowed from anywhere.

---

Optional Readonly highAvailabilityMode

• highAvailabilityMode? : undefined | false | true

Defined in packages/@cosmos-building-blocks/service/src/redis.ts:77

Enable sensible defaults for basic high availability

default - false.

---

Optional Readonly securityGroups

• securityGroups? : ISecurityGroup[]

Defined in packages/@cosmos-building-blocks/service/src/redis.ts:65

AWS::ElastiCache::ReplicationGroup.SecurityGroupIds.

default - Create a new Security Group for redis.

---

Readonly subnets

• subnets: SubnetSelection[]

Defined in packages/@cosmos-building-blocks/service/src/redis.ts:59

List of Subnets to launch Redis cluster in

---

Readonly vpc

• vpc: IVpc

Defined in packages/@cosmos-building-blocks/service/src/redis.ts:55

VPC to launch Redis cluster in