Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-secretsmanager-secret.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SecretsManager::Secret. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-secretsmanager.git

Properties

Description string | Aws_CF_FunctionString

(Optional) Specifies a user-provided description of the secret.

KmsKeyId string | Aws_CF_FunctionString

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString.

SecretString string | Aws_CF_FunctionString

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

GenerateSecretString object
10 nested properties
ExcludeUppercase boolean

Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters.

RequireEachIncludedType boolean

Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type.

IncludeSpace boolean

Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space

ExcludeCharacters string | Aws_CF_FunctionString

A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters.

GenerateStringKey string | Aws_CF_FunctionString

The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate.

PasswordLength integer

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

ExcludePunctuation boolean

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

ExcludeLowercase boolean

Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters.

SecretStringTemplate string | Aws_CF_FunctionString

A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey.

ExcludeNumbers boolean

Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits.

ReplicaRegions ReplicaRegion[]

(Optional) A list of ReplicaRegion objects. The ReplicaRegion type consists of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.

Tags Tag[]

The list of user-defined tags associated with the secret. Use tags to manage your AWS resources. For additional information about tags, see TagResource.

Name string | Aws_CF_FunctionString

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.

Definitions

GenerateSecretString object
ExcludeUppercase boolean

Specifies that the generated password should not include uppercase letters. The default behavior is False, and the generated password can include uppercase letters.

RequireEachIncludedType boolean

Specifies whether the generated password must include at least one of every allowed character type. By default, Secrets Manager enables this parameter, and the generated password includes at least one of every character type.

IncludeSpace boolean

Specifies that the generated password can include the space character. By default, Secrets Manager disables this parameter, and the generated password doesn't include space

ExcludeCharacters string | Aws_CF_FunctionString

A string that excludes characters in the generated password. By default, all characters from the included sets can be used. The string can be a minimum length of 0 characters and a maximum length of 7168 characters.

GenerateStringKey string | Aws_CF_FunctionString

The JSON key name used to add the generated password to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate.

PasswordLength integer

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

ExcludePunctuation boolean

Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

ExcludeLowercase boolean

Specifies the generated password should not include lowercase letters. By default, ecrets Manager disables this parameter, and the generated password can include lowercase False, and the generated password can include lowercase letters.

SecretStringTemplate string | Aws_CF_FunctionString

A properly structured JSON string that the generated password can be added to. If you specify this parameter, then you must also specify GenerateStringKey.

ExcludeNumbers boolean

Specifies that the generated password should exclude digits. By default, Secrets Manager does not enable the parameter, False, and the generated password can include digits.

ReplicaRegion object

A custom type that specifies a Region and the KmsKeyId for a replica secret.

Region string | Aws_CF_FunctionString required

(Optional) A string that represents a Region, for example "us-east-1".

KmsKeyId string | Aws_CF_FunctionString

The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.

Tag object

A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string.

Value string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with aws.

Key string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that's 1 to 256 characters in length.