From 6200ea81debb993c4700ecc5b5f6e435b218a1c8 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 4 Dec 2024 14:45:34 -0600 Subject: [PATCH] style: improve clarity on aws changes (#3623) Signed-off-by: Samantha Coyle --- .build-tools/builtin-authentication-profiles.yaml | 7 ++++--- pubsub/kafka/metadata.yaml | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.build-tools/builtin-authentication-profiles.yaml b/.build-tools/builtin-authentication-profiles.yaml index 56f0621017..d1a65f2f61 100644 --- a/.build-tools/builtin-authentication-profiles.yaml +++ b/.build-tools/builtin-authentication-profiles.yaml @@ -11,12 +11,12 @@ aws: example: '"us-east-1"' - name: accessKey description: AWS access key associated with an IAM account - required: true + required: false sensitive: true example: '"AKIAIOSFODNN7EXAMPLE"' - name: secretKey description: The secret key associated with the access key - required: true + required: false sensitive: true example: '"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"' - name: sessionToken @@ -41,6 +41,7 @@ aws: description: | IAM role that has access to AWS resource. This is another option to authenticate with MSK and RDS Aurora aside from the AWS Credentials. + This will be marked required in Dapr 1.17. example: '"arn:aws:iam::123456789:role/mskRole"' - name: sessionName type: string @@ -51,7 +52,7 @@ aws: - title: "AWS: Credentials from Environment Variables" description: Use AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY from the environment - title: "AWS: IAM Roles Anywhere" - description: Use X.509 certificates to establish trust between AWS and your AWS account and the Dapr cluster using AWS IAM Roles Anywhere. + description: Use X.509 certificates to establish trust between your AWS account and the Dapr cluster using AWS IAM Roles Anywhere. metadata: - name: trustAnchorArn description: | diff --git a/pubsub/kafka/metadata.yaml b/pubsub/kafka/metadata.yaml index e240faa5d3..0d83b25028 100644 --- a/pubsub/kafka/metadata.yaml +++ b/pubsub/kafka/metadata.yaml @@ -45,7 +45,7 @@ builtinAuthenticationProfiles: required: false sensitive: true description: | - This maintains backwards compatibility with existing fields. + This maintains backwards compatibility with existing fields. It will be deprecated as of Dapr 1.17. Use 'secretKey' instead. If both fields are set, then 'secretKey' value will be used. The secret key associated with the access key.