Skip to content

Commit

Permalink
style: improve clarity on aws changes (#3623)
Browse files Browse the repository at this point in the history
Signed-off-by: Samantha Coyle <sam@diagrid.io>
  • Loading branch information
sicoyle authored Dec 4, 2024
1 parent 72c92fb commit 6200ea8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions .build-tools/builtin-authentication-profiles.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion pubsub/kafka/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6200ea8

Please sign in to comment.