AwsSecretsManagerParameterProvider Parameter Provider
类型全限定名:cn.org.acal.lynxus.parameter.aws.AwsSecretsManagerParameterProvider
所属 Bundle:cn.org.acal.lynxus:lynxus-aws-nar:2.11.8
描述
从 AWS SecretsManager 获取参数。 每个秘密都成为一个参数组,它可以映射到参数上下文,秘密中的键/值对映射到组中的参数。
标签
awssecretsmanagersecretsmanager
属性
下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。
| 名称 | 默认值 | 可选值 | 描述 |
| 密钥列表策略 | PATTERN | - Enumerate Secret Names — 需要一组要获取的秘密名称。所需的 AWS 操作:DescribeSecret 和 GetSecretValue。
- Match Pattern — 需要正则表达式模式来匹配秘密名称。 所需的 AWS 操作:ListSecrets 和 GetSecretValue。
| 用于列出秘密的策略。 |
| 密钥名称模式 | .* | | 匹配密钥名称的正则表达式,用于标识应获取其参数的密钥。名称不匹配此模式的任何密钥将不会被获取。 |
| 密钥名称 | | | 要获取的以逗号分隔的秘密名称列表。 |
| 区域 | us-west-2 | - AWS European Sovereign Cloud (Germany) — AWS Region Code : eusc-de-east-1
- AWS GovCloud (US-East) — AWS Region Code : us-gov-east-1
- AWS GovCloud (US-West) — AWS Region Code : us-gov-west-1
- Africa (Cape Town) — AWS Region Code : af-south-1
- Asia Pacific (Hong Kong) — AWS Region Code : ap-east-1
- Asia Pacific (Hyderabad) — AWS Region Code : ap-south-2
- Asia Pacific (Jakarta) — AWS Region Code : ap-southeast-3
- Asia Pacific (Malaysia) — AWS Region Code : ap-southeast-5
- Asia Pacific (Melbourne) — AWS Region Code : ap-southeast-4
- Asia Pacific (Mumbai) — AWS Region Code : ap-south-1
- Asia Pacific (New Zealand) — AWS Region Code : ap-southeast-6
- Asia Pacific (Osaka) — AWS Region Code : ap-northeast-3
- Asia Pacific (Seoul) — AWS Region Code : ap-northeast-2
- Asia Pacific (Singapore) — AWS Region Code : ap-southeast-1
- Asia Pacific (Sydney) — AWS Region Code : ap-southeast-2
- Asia Pacific (Taipei) — AWS Region Code : ap-east-2
- Asia Pacific (Thailand) — AWS Region Code : ap-southeast-7
- Asia Pacific (Tokyo) — AWS Region Code : ap-northeast-1
- Canada (Central) — AWS Region Code : ca-central-1
- Canada West (Calgary) — AWS Region Code : ca-west-1
- China (Beijing) — AWS Region Code : cn-north-1
- China (Ningxia) — AWS Region Code : cn-northwest-1
- EU ISOE West — AWS Region Code : eu-isoe-west-1
- Europe (Frankfurt) — AWS Region Code : eu-central-1
- Europe (Ireland) — AWS Region Code : eu-west-1
- Europe (London) — AWS Region Code : eu-west-2
- Europe (Milan) — AWS Region Code : eu-south-1
- Europe (Paris) — AWS Region Code : eu-west-3
- Europe (Spain) — AWS Region Code : eu-south-2
- Europe (Stockholm) — AWS Region Code : eu-north-1
- Europe (Zurich) — AWS Region Code : eu-central-2
- Israel (Tel Aviv) — AWS Region Code : il-central-1
- Mexico (Central) — AWS Region Code : mx-central-1
- Middle East (Bahrain) — AWS Region Code : me-south-1
- Middle East (UAE) — AWS Region Code : me-central-1
- South America (Sao Paulo) — AWS Region Code : sa-east-1
- US East (N. Virginia) — AWS Region Code : us-east-1
- US East (Ohio) — AWS Region Code : us-east-2
- US ISO East — AWS Region Code : us-iso-east-1
- US ISO WEST — AWS Region Code : us-iso-west-1
- US ISOB East (Ohio) — AWS Region Code : us-isob-east-1
- US ISOB West — AWS Region Code : us-isob-west-1
- US ISOF EAST — AWS Region Code : us-isof-east-1
- US ISOF SOUTH — AWS Region Code : us-isof-south-1
- US West (N. California) — AWS Region Code : us-west-1
- US West (Oregon) — AWS Region Code : us-west-2
- aws global region — AWS Region Code : aws-global
- aws-cn global region — AWS Region Code : aws-cn-global
- aws-iso global region — AWS Region Code : aws-iso-global
- aws-iso-b global region — AWS Region Code : aws-iso-b-global
- aws-iso-e global region — AWS Region Code : aws-iso-e-global
- aws-iso-f global region — AWS Region Code : aws-iso-f-global
- aws-us-gov global region — AWS Region Code : aws-us-gov-global
| |
| AWS 凭证提供者服务 | | 控制器服务 API:
AwsCredentialsProviderService cn.org.acal.lynxus-lynxus-aws-service-api-nar-2.11.8 | 用于获取 Amazon Web Services 凭证提供商的服务 |
| 通信超时 | 30 secs | | |
| SSL 上下文服务 | | 控制器服务 API:
SSLContextProvider cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8 | 指定可选的 SSL 上下文服务,如果提供,将用于创建连接 |
详细说明
AWSSecretsManagerParameterProvider
把 AWS Secrets 映射为参数上下文
AwsSecretsManagerParameterProvider 把一个 Secret 映射为一个参数上下文
(Parameter Context),Secret 中的键/值对映射为参数。从 AWS 控制台创建
兼容的 secret:
- 在 Secrets Manager 服务中,点击 "Store a new Secret" 按钮
- 选择 "Other type of secret"
- 在 "Key/value" 下输入参数,参数名作为键、参数值作为值。点击 Next。
- 输入 Secret 名称。它决定哪个参数上下文接收这些参数。完成向导的
其余步骤,最后点击 "Store" 按钮。
或者在命令行执行类似如下的命令:
aws secretsmanager create-secret --name "[Context]" --secret-string '{ "[Param]": "[secretValue]", "[Param2]": "
[secretValue2]" }'
本例中,[Context] 应为参数上下文的预期名称,[Param] 和 [Param2]
应为参数名,[secretValue] 和 [secretValue2] 应为对应参数的值。
纯文本 Secrets
也支持未存储为 JSON 键/值对的 secret。当 secret 值不是 JSON 对象时
(例如 PEM 编码的私钥或任何其他纯文本字符串),它被视为单个参数:
参数名为 secret 名称,参数值为整个 secret 字符串。Secret 名称同时
用作参数上下文的名称。
例如,把 PEM 密钥存为 secret:
aws secretsmanager create-secret --name "my-private-key" --secret-string file://path/to/key.pem
这会产生一个名为 "my-private-key" 的参数上下文,其中包含一个同样名为
"my-private-key" 的参数,值为 PEM 文件的内容。
同一个 Secret Name Pattern 中可以混合使用 JSON 和纯文本 secret。每个
secret 会被自动检测并按其格式处理。
配置 Parameter Provider
必须在 "Secret Name Pattern" 属性中显式匹配 AWS Secrets,它们才会被
获取。这可以防止把预期之外的 Secrets 拉入 Lynxus。