Interface KmsGrantConfiguration.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<KmsGrantConfiguration.Builder,KmsGrantConfiguration>,SdkBuilder<KmsGrantConfiguration.Builder,KmsGrantConfiguration>,SdkPojo
- Enclosing class:
- KmsGrantConfiguration
public static interface KmsGrantConfiguration.Builder extends SdkPojo, CopyableBuilder<KmsGrantConfiguration.Builder,KmsGrantConfiguration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default KmsGrantConfiguration.Builderconstraints(Consumer<KmsGrantConstraints.Builder> constraints)Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.KmsGrantConfiguration.Builderconstraints(KmsGrantConstraints constraints)Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.KmsGrantConfiguration.BuildergranteePrincipal(String granteePrincipal)The principal that is given permission to perform the operations that the grant permits.KmsGrantConfiguration.BuilderissuingAccount(String issuingAccount)The Amazon Web Services account under which the grant was issued.KmsGrantConfiguration.Builderoperations(Collection<KmsGrantOperation> operations)A list of operations that the grant permits.KmsGrantConfiguration.Builderoperations(KmsGrantOperation... operations)A list of operations that the grant permits.KmsGrantConfiguration.BuilderoperationsWithStrings(String... operations)A list of operations that the grant permits.KmsGrantConfiguration.BuilderoperationsWithStrings(Collection<String> operations)A list of operations that the grant permits.KmsGrantConfiguration.BuilderretiringPrincipal(String retiringPrincipal)The principal that is given permission to retire the grant by using RetireGrant operation.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
operationsWithStrings
KmsGrantConfiguration.Builder operationsWithStrings(Collection<String> operations)
A list of operations that the grant permits.
- Parameters:
operations- A list of operations that the grant permits.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationsWithStrings
KmsGrantConfiguration.Builder operationsWithStrings(String... operations)
A list of operations that the grant permits.
- Parameters:
operations- A list of operations that the grant permits.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operations
KmsGrantConfiguration.Builder operations(Collection<KmsGrantOperation> operations)
A list of operations that the grant permits.
- Parameters:
operations- A list of operations that the grant permits.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operations
KmsGrantConfiguration.Builder operations(KmsGrantOperation... operations)
A list of operations that the grant permits.
- Parameters:
operations- A list of operations that the grant permits.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
granteePrincipal
KmsGrantConfiguration.Builder granteePrincipal(String granteePrincipal)
The principal that is given permission to perform the operations that the grant permits.
- Parameters:
granteePrincipal- The principal that is given permission to perform the operations that the grant permits.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retiringPrincipal
KmsGrantConfiguration.Builder retiringPrincipal(String retiringPrincipal)
The principal that is given permission to retire the grant by using RetireGrant operation.
- Parameters:
retiringPrincipal- The principal that is given permission to retire the grant by using RetireGrant operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
constraints
KmsGrantConfiguration.Builder constraints(KmsGrantConstraints constraints)
Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.
- Parameters:
constraints- Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
constraints
default KmsGrantConfiguration.Builder constraints(Consumer<KmsGrantConstraints.Builder> constraints)
Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.
This is a convenience method that creates an instance of theKmsGrantConstraints.Builderavoiding the need to create one manually viaKmsGrantConstraints.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconstraints(KmsGrantConstraints).- Parameters:
constraints- a consumer that will call methods onKmsGrantConstraints.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
constraints(KmsGrantConstraints)
-
issuingAccount
KmsGrantConfiguration.Builder issuingAccount(String issuingAccount)
The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.
- Parameters:
issuingAccount- The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-