Skip to content

chore(docs): mention sign_and_include in javadoc for keyid supplier #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -756,19 +756,22 @@ resource DynamoDbKeyBranchKeyIdSupplier{
@reference(resource: DynamoDbKeyBranchKeyIdSupplier)
structure DynamoDbKeyBranchKeyIdSupplierReference {}

@javadoc("Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written.")
@javadoc("Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.")
operation GetBranchKeyIdFromDdbKey {
input: GetBranchKeyIdFromDdbKeyInput,
output: GetBranchKeyIdFromDdbKeyOutput
}

//= specification/dynamodb-encryption-client/ddb-encryption-branch-key-id-supplier.md#dynamodbkeybranchkeyidsupplier
//= type=implication
//# This operation MUST take in a DDB `Key` structure (and attribute map containing the partition and sort attributes) as input.
//# This operation MUST take in a DDB `Key` structure
//# (an attribute map containing the partition and sort attributes,
//# along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT)
//# as input.
@javadoc("Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.")
structure GetBranchKeyIdFromDdbKeyInput {
@required
@javadoc("The partition and sort (if it exists) attributes on the item being read or written.")
@javadoc("The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.")
ddbKey: Key
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public software.amazon.cryptography.dbencryptionsdk.dynamodb.internaldafny.types
}

/**
* Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written.
* Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*
* @param input Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
* @return Outputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

public interface IDynamoDbKeyBranchKeyIdSupplier {
/**
* Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written.
* Get the Branch Key that should be used for wrapping and unwrapping data keys based on the primary key of the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*
* @param input Inputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
* @return Outputs for getting the Branch Key that should be used for wrapping and unwrapping data keys.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
public class GetBranchKeyIdFromDdbKeyInput {

/**
* The partition and sort (if it exists) attributes on the item being read or written.
* The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*/
private final Map<String, AttributeValue> ddbKey;

Expand All @@ -22,7 +22,7 @@ protected GetBranchKeyIdFromDdbKeyInput(BuilderImpl builder) {
}

/**
* @return The partition and sort (if it exists) attributes on the item being read or written.
* @return The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*/
public Map<String, AttributeValue> ddbKey() {
return this.ddbKey;
Expand All @@ -38,12 +38,12 @@ public static Builder builder() {

public interface Builder {
/**
* @param ddbKey The partition and sort (if it exists) attributes on the item being read or written.
* @param ddbKey The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*/
Builder ddbKey(Map<String, AttributeValue> ddbKey);

/**
* @return The partition and sort (if it exists) attributes on the item being read or written.
* @return The partition and sort (if it exists) attributes on the item being read or written, along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT.
*/
Map<String, AttributeValue> ddbKey();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,8 @@ and create a Key with these values, using names with the "aws-crypto-attr." remo
## DynamoDbKeyBranchKeyIdSupplier

The DynamoDb Key Branch Key Id Supplier is an interface containing the `GetBranchKeyIdFromDdbKey` operation.
This operation MUST take in a DDB `Key` structure (and attribute map containing the partition and sort attributes) as input.
This operation MUST take in a DDB `Key` structure
(an attribute map containing the partition and sort attributes,
along with the values of any attributes configured as SIGN_AND_INCLUDE_IN_ENCRYPTION_CONTEXT)
as input.
This operation MUST return a branch key id (string) as output.
Loading