aws-redis.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: CSB Amazon ElastiCache for Redis
display_name: CSB Amazon ElastiCache for Redis
image_url: file://service-images/csb.png
documentation_url: https://docs.vmware.com/en/Cloud-Service-Broker-for-VMware-Tanzu/index.html
provider_display_name: VMware
support_url: https://aws.amazon.com/redis/
tags: [aws, redis]
plan_updateable: true
provision:
  plan_inputs:
  - field_name: cache_size
    type: integer
    details: Deprecated. Use `node_type` instead - Cache size in GB.
  user_inputs:
  - field_name: redis_version
    required: true
    type: string
    details: |
      The version for the redis instance.
      For more information about upgrading engine versions, see
      https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/VersionManagement.html.
      The downgrade of the version is not allowed as it involves the recreation of the instance.
  - field_name: instance_name
    type: string
    details: Name for your 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 AWS.
    default: us-west-2
    constraints:
      examples:
      - us-central1
      - asia-northeast1
      pattern: ^[a-z][a-z0-9-]+$
    prohibit_update: true
  - 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: ""
    prohibit_update: true
  - field_name: node_type
    type: string
    details: AWS Elasticache node type (see https://aws.amazon.com/elasticache/pricing)
    default: ""
    # `node_type` is required by the provider, but we can't specify it as such
    # in this manifest because we need to support passing `cache_size` without
    # any `node_type` for backward compatibility. If `node_type` isn't specified
    # in the plan nor at provisioning time, provisioning will throw this error:
    # "node_type" is required unless "global_replication_group_id"
  - field_name: elasticache_subnet_group
    type: string
    details: AWS Elasticache subnet group already in existence to use
    default: ""
    prohibit_update: true
  - field_name: elasticache_vpc_security_group_ids
    type: string
    details: Comma delimited list of security group ID's for instance
    default: ""
    prohibit_update: true
  - field_name: at_rest_encryption_enabled
    type: boolean
    details: Whether to enable encryption at rest.
    default: true
    prohibit_update: true
  - field_name: data_tiering_enabled
    type: boolean
    details: |
      Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
      This parameter must be set to true when using `r6gd` nodes.
      Not all versions of Redis support this feature. Check supported versions.
      For more information about Node Types and supported Redis versions see
      https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html
    default: false
    prohibit_update: true
  - field_name: multi_az_enabled
    type: boolean
    details: Whether to enable Multi-AZ Support for the replication group. Only applies when `node_count` is greater than 1.
    default: true
  - field_name: kms_key_id
    type: string
    details: The ARN of the key to use if encrypting at rest. Defaults to AWS managed key.
    default: ""
    prohibit_update: true
  - field_name: automatic_failover_enabled
    type: boolean
    details: Automatically promote replica to primary if the existing primary fails. Only applies when `node_count` is greater than 1.
    default: true
  - field_name: auto_minor_version_upgrade
    type: boolean
    details: | 
      Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances.
      Only supported for redis version is 6 or higher.
    default: false
  - <<: &nullable_string
      type: string
      default: null
      nullable: true
    field_name: maintenance_day
    details: The preferred maintenance day
    enum:
      Sun: Sunday
      Mon: Monday
      Tue: Tuesday
      Wed: Wednesday
      Thu: Thursday
      Fri: Friday
      Sat: Saturday
  - <<: *nullable_string
    field_name: maintenance_start_hour
    details: The preferred maintenance start hour
    enum: &hour_enum
      "00": 12 am
      "01": 1 am
      "02": 2 am
      "03": 3 am
      "04": 4 am
      "05": 5 am
      "06": 6 am
      "07": 7 am
      "08": 8 am
      "09": 9 am
      "10": 10 am
      "11": 11 am
      "12": 12 pm
      "13": 1 pm
      "14": 2 pm
      "15": 3 pm
      "16": 4 pm
      "17": 5 pm
      "18": 6 pm
      "19": 7 pm
      "20": 8 pm
      "21": 9 pm
      "22": 10 pm
      "23": 11 pm
  - <<: *nullable_string
    field_name: maintenance_start_min
    type: string
    details: The preferred maintenance start minute
    enum: &minute_enum
      "00": Top of the hour
      "15": 15 minutes
      "30": 30 minutes
      "45": 45 minutes
  - <<: *nullable_string
    field_name: maintenance_end_hour
    details: The preferred maintenance end hour
    enum: *hour_enum
  - <<: *nullable_string
    field_name: maintenance_end_min
    details: The preferred maintenance end minute
    enum: *minute_enum
  - <<: *nullable_string
    field_name: backup_start_hour
    details: The preferred backup start hour
    enum: *hour_enum
  - <<: *nullable_string
    field_name: backup_start_min
    type: string
    details: The preferred backup start minute
    enum: *minute_enum
  - <<: *nullable_string
    field_name: backup_end_hour
    details: The preferred backup end hour
    enum: *hour_enum
  - <<: *nullable_string
    field_name: backup_end_min
    details: The preferred backup end minute
    enum: *minute_enum
  - field_name: backup_retention_limit
    type: integer
    default: 1
    details: |
      Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.
      If set to zero (0), backups are turned off.
  - <<: *nullable_string
    field_name: final_backup_identifier
    details: |
      The name of the final node group (shard) snapshot.
      ElastiCache creates the snapshot from the primary node in the cluster.
      If omitted, no final snapshot will be made.
  - field_name: backup_name
    type: string
    prohibit_update: true
    default: ""
    details: The name of an existing snapshot to be restored into this new instance
  - field_name: parameter_group_name
    type: string
    default: ""
    # You can't unset this property by setting it to null or "" because the provider will look
    # for a parameter group called "". If you set it back to the default value (redis5.0 for example)
    # and then upgrade, it will be automatically updated to an appropriate value in AWS. We shouldn't rely
    # on this incidental behavior as it's not documented and the provider implementation may change.
    details: |
      Name of the custom parameter group to associate with this instance.
      If left unset, the default parameter group for the specified redis_version is used.
      Once the parameter had been set, make sure that it is updated to an appropriate value
      when updating the redis_version. To set to default, specify the name of the default
      parameter group for the Redis version, for example `default.redis6.x`.
      For more information about parameter groups, see
      https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Redis.html
  - field_name: preferred_azs
    type: array
    prohibit_update: true
    default: []
    details: |
      List of EC2 availability zones in which the nodes will be created.
      The first item in the list will be the primary node.
      Number of entries must equal to node_count.
      If this property is set, the node_count will become immutable.
  - field_name: logs_slow_log_enabled
    type: boolean
    default: false
    details: |
      Enable the streaming of Redis Slow Log to CloudWatch. Slow Log is supported for Redis replication groups using version 6.0 onward.
  - field_name: logs_slow_log_loggroup_retention_in_days
    type: number
    default: 0
    details: |
      Specifies the number of days you want to retain log events in the specified log group. 
      If 0 is specified, the events in the log group are always retained and never expire.
      When specifying `logs_slow_log_loggroup_retention_in_days`, `logs_slow_log_enabled` needs to be set to true.
      For more information, see
      https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html#API_PutRetentionPolicy_RequestSyntax
  - field_name: logs_slow_log_loggroup_kms_key_id
    type: string
    default: ""
    details: |
      The ARN for the KMS key to encrypt Slow logs CloudWatch logs.
      When specifying `logs_slow_log_loggroup_kms_key_id`, `logs_slow_log_enabled` needs to be set to true.
      If omitted, CloudWatch default encryption will apply.
      For information on CloudWatch log data encryption and how to configure a KMS key, see 
      https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html
  - field_name: logs_engine_log_enabled
    type: boolean
    default: false
    details: |
      Enable the streaming of Redis Engine logs to CloudWatch. Engine Log is supported for Redis replication groups using version 6.2 onward.
  - field_name: logs_engine_log_loggroup_retention_in_days
    type: number
    default: 0
    details: |
      Specifies the number of days you want to retain log events in the specified log group. 
      If 0 is specified, the events in the log group are always retained and never expire.
      When specifying `logs_engine_log_loggroup_retention_in_days`, `logs_engine_log_enabled` needs to be set to true.
      For more information, see
      https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html#API_PutRetentionPolicy_RequestSyntax
  - field_name: logs_engine_log_loggroup_kms_key_id
    type: string
    default: ""
    details: |
      The ARN for the KMS key to encrypt Engine Log CloudWatch logs.
      When specifying `logs_engine_log_loggroup_kms_key_id`, `logs_engine_log_enabled` needs to be set to true.
      If omitted, CloudWatch default encryption will apply.
      For information on CloudWatch log data encryption and how to configure a KMS key, see 
      https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html
  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
    versions: terraform/redis/cluster/provision/versions.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.
  - field_name: reader_endpoint
    type: string
    details: Address used by clients to read from the service. It splits incoming connections between all read replicas.
bind:
  plan_inputs: []
  user_inputs: []
  computed_inputs: []
  template_refs:
    noop: terraform/redis/cluster/binding/noop.tf
  outputs: []