aws-redis-cluster.yml

# Copyright 2020 Pivotal Software, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http:#www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
---
version: 1
name: csb-aws-redis
id: e9c11b1b-0caa-45c9-b9b2-592939c9a5a6
description: Amazon ElastiCache for Redis - multinode with automatic failover
display_name: Amazon ElastiCache for Redis
image_url: https://www.edrawsoft.com/symbols/awsdatabase/elasticacheredis.png
documentation_url: https://aws.amazon.com/elasticache/redis/resources/?nc=sn&loc=5
support_url: https://aws.amazon.com/redis/
tags: [aws, redis, preview]
plan_updateable: true
plans:
- name: small
  id: ad963fcd-19f7-4b79-8e6d-645756e84f7a
  description: 'Redis 6.0 with 1GB cache and 1 node.'
  display_name: "Small"
  properties:
    cache_size: 1   
    redis_version: "6.0"  
    node_count: 1
- name: medium
  id: df41095a-43e8-4be4-b4d6-ae2d8a35068d
  description: 'Redis 6.0 with at least 4GB cache and 1 node.'
  display_name: "Medium HA"
  properties:
    cache_size: 4
    redis_version: "6.0"
    node_count: 1
- name: large
  id: da4dc49c-a64f-4d2a-8490-5e456cbb0577
  description: 'Redis 6.0 with at least 16 GB cache and 1 node.'
  display_name: "Large HA"
  properties:
    cache_size: 16
    redis_version: "6.0"
    node_count: 1
- name: small-ha
  id: 70544df7-0ac4-4580-ba51-c1fbdd6fdfd0
  description: 'Redis 6.0 with 1GB cache and 2 nodes.'
  display_name: "Small HA"
  properties:
    cache_size: 1   
    redis_version: "6.0"
- name: medium-ha
  id: a4235008-80f4-4053-924b-defcce17cb63
  description: 'Redis 6.0 with at least 4GB cache and 2 nodes.'
  display_name: "Medium HA"
  properties:
    cache_size: 4
    redis_version: "6.0"
- name: large-ha
  id: f26cda6f-d4b4-473a-966c-32d238f723ef
  description: 'Redis 6.0 with at least 16 GB cache and 2 nodes.'
  display_name: "Large HA"
  properties:
    cache_size: 16
    redis_version: "6.0"
provision:
  plan_inputs:
  - field_name: cache_size
    required: true
    type: integer
    details: Cache size in GB
    constraints:
      maximum: 256
      minimum: 1
      multipleOf: 2    
  - field_name: redis_version
    required: true
    type: string
    details: The version for the redis instance.
    enum: 
      3.2: Redis 3.2
      4.0: Redis 4.0
      5.0: Redis 5.0
      6.0: Redis 6.x
  user_inputs:
  - field_name: instance_name
    type: string
    details: Name for your mysql instance
    default: csb${request.instance_id}
    constraints:
      maxLength: 40
      minLength: 6
      pattern: ^[a-z][a-z0-9-]+$
    prohibit_update: true  
  - field_name: region
    type: string
    details: The region of the mysql instance.
    default: us-west-2
    enum: 
      us-east-2 : us-east-2
      us-east-1 : us-east-1
      us-west-1 : us-west-1
      us-west-2 : us-west-2
      ap-east-1 : ap-east-1
      ap-south-1 : ap-south-1
      ap-northeast-3 : ap-northeast-3
      ap-northeast-2 : ap-northeast-2
      ap-southeast-1 : ap-southeast-1
      ap-southeast-2 : ap-southeast-2
      ap-northeast-1 : ap-northeast-1
      ca-central-1 : ca-central-1
      cn-north-1 : cn-north-1
      cn-northwest-1 : cn-northwest-1
      eu-central-1 : eu-central-1
      eu-west-1 : eu-west-1
      eu-west-2 : eu-west-2
      eu-west-3 : eu-west-3
      eu-north-1 : eu-north-1
      me-south-1 : me-south-1
      sa-east-1 : sa-east-1
  - field_name: node_count
    type: integer
    details: Number of nodes (primary and replicas) in cluster
    default: 2
  - field_name: aws_access_key_id
    type: string
    details: AWS access key
    default: ${config("aws.access_key_id")}
  - field_name: aws_secret_access_key
    type: string
    details: AWS secret key
    default: ${config("aws.secret_access_key")}
  - field_name: aws_vpc_id
    details: VPC ID for instance
    type: string
    default: ""
  - field_name: node_type
    type: string
    details: AWS Elasticache node type (see https://aws.amazon.com/elasticache/pricing) Will be computed from cache_size if empty.
    default: ""
  - field_name: elasticache_subnet_group
    type: string
    details: AWS Elasticache subnet group already in existence to use
    default: ""
  - field_name: elasticache_vpc_security_group_ids
    type: string
    details: Comma delimited list of security group ID's for instance
    default: ""  
  computed_inputs:
  - name: labels
    default: ${json.marshal(request.default_labels)}
    overwrite: true
    type: object
  template_refs:
    outputs: terraform/redis/cluster/provision/outputs.tf
    provider: terraform/redis/cluster/provision/provider.tf
    variables: terraform/redis/cluster/provision/variables.tf
    main: terraform/redis/cluster/provision/main.tf
    data: terraform/redis/cluster/provision/data.tf
  outputs:
  - field_name: name
    type: string
    details: The name of the redis.
  - field_name: host
    type: string
    details: Hostname or IP address of the exposed redis endpoint used by clients to connect to the service.
  - field_name: tls_port
    type: integer
    details: The TLS port number of the exposed redis instance.
  - field_name: password
    type: string
    details: The password to authenticate to the redis instance.    
bind:
  plan_inputs: []
  user_inputs: []
  computed_inputs: []
  template: ''
  outputs: []
examples:
- name: redis-cache-small
  description: Small redis cache
  plan_id: ad963fcd-19f7-4b79-8e6d-645756e84f7a
  provision_params: {}
  bind_params: {}
- name: redis-cache-medium
  description: Medium redis cache
  plan_id: df41095a-43e8-4be4-b4d6-ae2d8a35068d
  provision_params: {}
  bind_params: {}
- name: redis-cache-large
  description: Large redis cache
  plan_id: da4dc49c-a64f-4d2a-8490-5e456cbb0577
  provision_params: {}
  bind_params: {}
- name: redis-cache-small-ha
  description: Small redis cache
  plan_id: 70544df7-0ac4-4580-ba51-c1fbdd6fdfd0
  provision_params: {}
  bind_params: {}
- name: redis-cache-medium-ha
  description: Medium redis cache in us-east-1 region
  plan_id: a4235008-80f4-4053-924b-defcce17cb63
  provision_params: { "region": "us-east-1" }
  bind_params: {}
- name: redis-cache-large-ha
  description: Large redis cache
  plan_id: f26cda6f-d4b4-473a-966c-32d238f723ef
  provision_params: {}
  bind_params: {}
- name: redis-cache-tiny-ha
  description: Tiny redis cache
  plan_id: 70544df7-0ac4-4580-ba51-c1fbdd6fdfd0
  provision_params: { "node_type":"cache.t2.micro"}
  bind_params: {}
- name: redis-cache-three-nodes
  description: Tiny redis cache
  plan_id: 70544df7-0ac4-4580-ba51-c1fbdd6fdfd0
  provision_params: { "node_count": 3 }
  bind_params: {}