/
CfnSecretProps.go
118 lines (115 loc) · 7.6 KB
/
CfnSecretProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
package awssecretsmanager
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
)
// Properties for defining a `CfnSecret`.
//
// Example:
// // The code below shows an example of how to instantiate this type.
// // The values are placeholders you should change.
// import "github.com/aws/aws-cdk-go/awscdk"
//
// cfnSecretProps := &CfnSecretProps{
// Description: jsii.String("description"),
// GenerateSecretString: &GenerateSecretStringProperty{
// ExcludeCharacters: jsii.String("excludeCharacters"),
// ExcludeLowercase: jsii.Boolean(false),
// ExcludeNumbers: jsii.Boolean(false),
// ExcludePunctuation: jsii.Boolean(false),
// ExcludeUppercase: jsii.Boolean(false),
// GenerateStringKey: jsii.String("generateStringKey"),
// IncludeSpace: jsii.Boolean(false),
// PasswordLength: jsii.Number(123),
// RequireEachIncludedType: jsii.Boolean(false),
// SecretStringTemplate: jsii.String("secretStringTemplate"),
// },
// KmsKeyId: jsii.String("kmsKeyId"),
// Name: jsii.String("name"),
// ReplicaRegions: []interface{}{
// &ReplicaRegionProperty{
// Region: jsii.String("region"),
//
// // the properties below are optional
// KmsKeyId: jsii.String("kmsKeyId"),
// },
// },
// SecretString: jsii.String("secretString"),
// Tags: []cfnTag{
// &cfnTag{
// Key: jsii.String("key"),
// Value: jsii.String("value"),
// },
// },
// }
//
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html
//
type CfnSecretProps struct {
// The description of the secret.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// A structure that specifies how to generate a password to encrypt and store in the secret.
//
// To include a specific string in the secret, use `SecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret. When you make a change to this property, a new secret version is created.
//
// We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-generatesecretstring
//
GenerateSecretString interface{} `field:"optional" json:"generateSecretString" yaml:"generateSecretString"`
// The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.
//
// An alias is always prefixed by `alias/` , for example `alias/aws/secretsmanager` . For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html) .
//
// To use a AWS KMS key in a different account, use the key ARN or the alias ARN.
//
// If you don't specify this value, then Secrets Manager uses the key `aws/secretsmanager` . If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
//
// If the secret is in a different AWS account from the credentials calling the API, then you can't use `aws/secretsmanager` to encrypt the secret, and you must create and use a customer managed AWS KMS key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// The name of the new secret.
//
// The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
//
// Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-replicaregions
//
ReplicaRegions interface{} `field:"optional" json:"replicaRegions" yaml:"replicaRegions"`
// The text to encrypt and store in the secret.
//
// We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use `GenerateSecretString` instead. If you omit both `GenerateSecretString` and `SecretString` , you create an empty secret. When you make a change to this property, a new secret version is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-secretstring
//
SecretString *string `field:"optional" json:"secretString" yaml:"secretString"`
// A list of tags to attach to the secret.
//
// Each tag is a key and value pair of strings in a JSON text string, for example:
//
// `[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]`
//
// Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
//
// Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
//
// If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an `Access Denied` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2) .
//
// For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json) . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
//
// The following restrictions apply to tags:
//
// - Maximum number of tags per secret: 50
// - Maximum key length: 127 Unicode characters in UTF-8
// - Maximum value length: 255 Unicode characters in UTF-8
// - Tag keys and values are case sensitive.
// - Do not use the `aws:` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
// - If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : /
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}