Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: José Corella <[email protected]>
  • Loading branch information
texastony and josecorella authored Jan 22, 2025
1 parent 2b6d411 commit c7907ad
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
7 changes: 3 additions & 4 deletions changes/2025-01-17_key-store-admin/background.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ are also different between usage and administration activities.

As such, it makes sense to create a
new Branch Key Store Administration Client,
that cannot facilitate usage,
only administrative operations.
that only facilitates administrative operations.

## Alternatives to a new Client/Local Service?

Expand All @@ -42,7 +41,7 @@ and is therefore not recommended.
Creating a new Key Store Admin client
also passively encourages customers to
consider the different permissions needed
to administrate rather than use a Key Store.
to administer rather than use a Key Store.

### Static Methods on the MPL

Expand Down Expand Up @@ -89,7 +88,7 @@ on Storage Reference.

`Kms Symmetric Key Arn` is a Union.

The members of ``KmsSymmetricKeyArn` are a KMS ARN which identifies the KMS Key
The members of `KmsSymmetricKeyArn` are a KMS ARN which identifies the KMS Symmetric Key
that will be used for the operation.
This ARN MUST NOT be an Alias.
This ARN MUST be a valid
Expand Down
13 changes: 7 additions & 6 deletions framework/branch-key-store-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ See [Key Store Overview](../branch-key-store.md#definitions).

`Kms Symmetric Key Arn` is a Union.

The members of ``KmsSymmetricKeyArn` are a KMS ARN which identifies the KMS Key
The members of `KmsSymmetricKeyArn` are a KMS ARN which identifies the KMS Key
that will be used for the operation.
This ARN MUST NOT be an Alias.
This ARN MUST be a valid
Expand Down Expand Up @@ -78,9 +78,10 @@ during [Wrapped Branch Key Creation](../branch-key-store.md#wrapped-branch-key-c

`AwsKmsReEncrypt` is a structure that holds a [`AwsKms`](../branch-key-store.md#awskms),
which MAY contain the KMS Client
or Grant Tokens the Key Store,
or Grant Tokens,
if they are set,
will use when calling KMS.
the Key Store will use
when calling KMS.

`AwsKmsReEncrypt` is the default option if
`Key Management Strategy` is marked as optional
Expand All @@ -107,7 +108,7 @@ in this document are to be interpreted as described in [RFC 2119](https://tools.

## Initialization

The Key Store Admin requires the following arguments:
On initialization the caller MUST provide:

- [Storage](../branch-key-store.md#storage)
- [Logical Key Store Name](../branch-key-store.md##logical-keystore-name)
Expand Down Expand Up @@ -146,7 +147,7 @@ with the following caveats:

#### KMS Configuration

Where ever the Key Store Client's CreateKey method refers to the Key Store's KMS Configuration,
Wherever the Key Store Client's CreateKey method refers to the Key Store's KMS Configuration,
use the equivalent [`KmsSymmetricKeyArn`](#kmssymmetrickeyarn) expression.

#### [Branch Key and Beacon Key Creation](./branch-key-store.md#branch-key-and-beacon-key-creation)
Expand All @@ -172,7 +173,7 @@ with the following caveats:

#### KMS Configuration

Where ever the Key Store Client's CreateKey method refers to the Key Store Client's KMS Configuration,
Where ever the Key Store Client's VersionKey method refers to the Key Store Client's KMS Configuration,
use the equivalent [`KmsSymmetricKeyArn`](#kmssymmetrickeyarn) expression.

#### [Wrapped Branch Key Creation](./branch-key-store.md#wrapped-branch-key-creation)
Expand Down

0 comments on commit c7907ad

Please sign in to comment.