terraform-aws-secretsmanager

Terraform module to provision and manage AWS Secrets Manager.

Usage

module "label" {
  source  = "cloudposse/label/null"
  version = "0.25.0"

  name      = "alpha"
  namespace = "so"
  stage     = "staging"
}

module "ssh_key_pair" {
  source  = "cloudposse/key-pair/aws"
  version = "0.18.1"

  ssh_public_key_path = "keys/"
  generate_ssh_key    = "true"

  context = module.label.context
}

module "secrets" {
  source  = "SweetOps/secretsmanager/aws"
  version = "0.1.0"

  secret_version = {
    secret_string = jsonencode(
      {
        ssh_public_key  = base64encode(module.ssh_key_pair.public_key)
        ssh_private_key = base64encode(module.ssh_key_pair.private_key)
      }
    )
  }

  context = module.label.context
}

Requirements

Name	Version
terraform	>= 1.3
aws	>= 4.16

Providers

Name	Version
aws	>= 4.16

Modules

Name	Source	Version
kms_key	cloudposse/kms-key/aws	0.12.1
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_secretsmanager_secret.default	resource
aws_secretsmanager_secret_rotation.default	resource
aws_secretsmanager_secret_version.default	resource
aws_secretsmanager_secret_version.ignore_changes	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
description	Description of the secret.	string	"Managed by Terraform"	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br> format = string<br> labels = list(string)<br>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
force_overwrite_replica_secret	Whether to overwrite a secret with the same name in the destination Region.	bool	true	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
kms_key	enabled: Whether to create KSM key. description: The description of the key as viewed in AWS console. alias: The display name of the alias. The name must start with the word alias followed by a forward slash. If not specified, the alias name will be auto-generated. deletion_window_in_days: Duration in days after which the key is deleted after destruction of the resource enable_key_rotation: Specifies whether key rotation is enabled.	object({ enabled = optional(bool, true) description = optional(string, "Managed by Terraform") alias = optional(string) deletion_window_in_days = optional(number, 30) enable_key_rotation = optional(bool, true) })	{}	no
kms_key_id	ARN or Id of the AWS KMS customer master key (CMK) to be used to encrypt the secret values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager).	string	null	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
policy	Valid JSON document representing a resource policy.	string	null	no
recovery_window_in_days	Valid JSON document representing a resource policy.	number	30	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
replicas	kms_key_id: ARN, Key ID, or Alias of the AWS KMS key within the region secret is replicated to. region: Region for replicating the secret.	list( object( { kms_key_id = string region = string } ) )	[]	no
rotation	enabled: Whether to create secret rotation rule. Default value: false lambda_arn: Specifies the ARN of the Lambda function that can rotate the secret. automatically_after_days: Specifies the number of days between automatic scheduled rotations of the secret. duration: The length of the rotation window in hours. For example, 3h for a three hour window. schedule_expression: A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.	object({ enabled = optional(bool, false) lambda_arn = string automatically_after_days = optional(number, null) duration = optional(string, null) schedule_expression = optional(string, null) })	{ "lambda_arn": "" }	no
secret_version	ignore_changes_enabled: Whether to ignore changes in secret_string and secret_binary. Default value: false secret_string: Specifies text data that you want to encrypt and store in this version of the secret. This is required if secret_binary is not set. secret_binary: Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secret_string is not set. Needs to be encoded to base64.	object({ secret_string = optional(string, "{}") secret_binary = optional(string) ignore_changes_enabled = optional(bool, false) })	{}	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
arn	ARN of the secret
id	ID of the secret
kms_key_alias_arn	KMS key alias ARN
kms_key_alias_name	KMS key alias name
kms_key_arn	KMS key ARN
kms_key_id	KMS key ID
name	Name of the secret
version_id	The unique identifier of the version of the secret.

License

The Apache-2.0 license