bitovi/Deploy Amazon Redis DB cluster (ElastiCache)

Deploys an AWS Redis cluster database. (AWS ElastiCache Redis cluster)

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
bitops_code_onlyWill run only the generation phase of BitOps, where the Terraform and Ansible code is built.no
bitops_code_storeStore BitOps code as a GitHub artifactnofalse
aws_access_key_idAWS access key IDyes
aws_secret_access_keyAWS secret access keyyes
aws_session_tokenAWS session tokenno
aws_default_regionAWS default regionnous-east-1
aws_resource_identifierSet to override the AWS resource identifier for the deployment. Defaults to `${org}-{repo}-{branch}`. Use with destroy to destroy specific resources.no
aws_additional_tagsA JSON object of additional tags that will be included on created resources. Example: `{"key1": "value1", "key2": "value2"}`no
tf_stack_destroySet to "true" to Destroy the stack through Terraform.no
tf_state_file_nameChange this to be anything you want to. Carefull to be consistent here. A missing file could trigger recreation, or stepping over destruction of non-defined objects.no
tf_state_file_name_appendAppend a string to the tf-state-file. Setting this to `unique` will generate `tf-state-aws-unique`. Can co-exist with the tf_state_file_name variable. no
tf_state_bucketAWS S3 bucket to use for Terraform state. Defaults to `${org}-${repo}-{branch}-tf-state`no
tf_state_bucket_destroyForce purge and deletion of S3 bucket defined. Any file contained there will be destroyed. `tf_stack_destroy` must also be `true`no
aws_redis_enableEnables the creation of a Redis instancenotrue
aws_redis_userRedis username. Defaults to redisuserno
aws_redis_user_access_stringString expression for user access. Defaults to on ~* +@allno
aws_redis_user_group_nameUser group name. Defaults to aws_resource_identifier-redisno
aws_redis_security_group_nameRedis security group name. Defaults to SG for aws_resource_identifier - Redisno
aws_redis_ingress_allow_allAllow access from 0.0.0.0/0 in the same VPCno
aws_redis_allowed_security_groupsComma separated list of security groups to be added to the Redis SG.no
aws_redis_subnetsDefine a list of specific subnets where Redis will live. Defaults to all of the VPC ones. If not defined, default VPC.no
aws_redis_portRedis port. Defaults to 6379no
aws_redis_at_rest_encryptionEncryption at rest. Defaults to true.no
aws_redis_in_transit_encryptionIn-transit encryption. Defaults to true.no
aws_redis_replication_group_idName of the Redis replication group. Defaults to aws_resource_identifier-redisno
aws_redis_node_typeNode type of the Redis instance. Defaults to cache.t2.smallno
aws_redis_num_cache_clustersAmount of Redis nodes. Defaults to 1no
aws_redis_parameter_group_nameRedis parameters groups name. If cluster wanted, set it to something that includes .cluster.on. Defaults to default.redis7no
aws_redis_num_node_groupsNumber of node groups. Defaults to 0.no
aws_redis_replicas_per_node_groupNumber of replicas per node group. Defaults to 0no
aws_redis_multi_az_enabledEnables multi-availability-zone redis. Defaults to falseno
aws_redis_automatic_failoverAllows overriding the automatic configuration of this value, only needed when playing with resources in a non-conventional way.no
aws_redis_apply_immediatelySpecifies whether any modifications are applied immediately, or during the next maintenance window. Default is false.no
aws_redis_auto_minor_upgradeSpecifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true.no
aws_redis_maintenance_windowSpecifies the weekly time range for when maintenance on the cache cluster is performed. Example:sun:05:00-sun:06:00. Defaults to null.no
aws_redis_snapshot_windowDaily time range (in UTC) when to start taking a daily snapshot. Minimum is a 60 minute period. Example: 05:00-09:00. Defaults to null.no
aws_redis_final_snapshotChange name to define a final snapshot.no
aws_redis_snapshot_restore_nameSet name to restore a snapshot to the cluster. The default behaviour is to restore it each time this action runs.no
aws_redis_cloudwatch_enabledEnable or disables Cloudwatch logging.no
aws_redis_cloudwatch_lg_nameCloudwatch log group name. Defaults to /aws/redis/aws_resource_identifier. Will append log_type to it.no
aws_redis_cloudwatch_log_formatDefine log format between json (default) and text.no
aws_redis_cloudwatch_log_typeLog type. Older Redis engines need slow-log. Newer support engine-log (default)no
aws_redis_cloudwatch_retention_daysNumber of days to retain logs. 0 to never expire. Default '14'
aws_redis_single_line_url_secretCreates an AWS secret containing the connection string containing protocol://user@pass:endpoint:portno
aws_redis_additional_tagsAdditional tags to be added to every Redis related resourceno
aws_vpc_createDefine if a VPC should be createdno
aws_vpc_nameSet a specific name for the VPCno
aws_vpc_cidr_blockDefine Base CIDR block which is divided into subnet CIDR blocks. Defaults to 10.0.0.0/16.no
aws_vpc_public_subnetsComma separated list of public subnets. Defaults to 10.10.110.0/24no
aws_vpc_private_subnetsComma separated list of private subnets. If none, none will be created.no
aws_vpc_availability_zonesComma separated list of availability zones. Defaults to `aws_default_region.no
aws_vpc_idAWS VPC ID. Accepts `vpc-###` values.no
aws_vpc_subnet_idSpecify a Subnet to be used with the instance. If none provided, will pick one.no
aws_vpc_enable_nat_gatewayEnables NAT gatewayno
aws_vpc_single_nat_gatewayCreates only one NAT gatewayno
aws_vpc_external_nat_ip_idsComma separated list of IP IDS to reuse in the NAT gatewaysno
aws_vpc_additional_tagsA JSON object of additional tags that will be included on created resources. Example: `{"key1": "value1", "key2": "value2"}`no
namedescription
aws_vpc_idThe selected VPC ID used.
redis_endpointRedis Endpoint
redis_secret_nameRedis Secret name
redis_connection_string_secretRedis secret containing complete URL to connect directly. (e.g. rediss://user:pass@host:port)
redis_sg_idRedis SG ID