Interface CommonGrantOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
GrantOnPrincipalAndResourceOptions, GrantOnPrincipalOptions, GrantWithResourceOptions
All Known Implementing Classes:
CommonGrantOptions.Jsii$Proxy, GrantOnPrincipalAndResourceOptions.Jsii$Proxy, GrantOnPrincipalOptions.Jsii$Proxy, GrantWithResourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.952Z") @Stability(Stable) public interface CommonGrantOptions extends software.amazon.jsii.JsiiSerializable
Basic options for a grant operation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object conditions;
 IGrantable grantable;
 CommonGrantOptions commonGrantOptions = CommonGrantOptions.builder()
         .actions(List.of("actions"))
         .grantee(grantable)
         .resourceArns(List.of("resourceArns"))
         // the properties below are optional
         .conditions(Map.of(
                 "conditionsKey", Map.of(
                         "conditionsKey", conditions)))
         .build();
 
  • Method Details

    • getActions

      @Stability(Stable) @NotNull List<String> getActions()
      The actions to grant.
    • getGrantee

      @Stability(Stable) @NotNull IGrantable getGrantee()
      The principal to grant to.

      Default: if principal is undefined, no work is done.

    • getResourceArns

      @Stability(Stable) @NotNull List<String> getResourceArns()
      The resource ARNs to grant to.
    • getConditions

      @Stability(Stable) @Nullable default Map<String,Map<String,Object>> getConditions()
      Any conditions to attach to the grant.

      Default: - No conditions

    • builder

      @Stability(Stable) static CommonGrantOptions.Builder builder()
      Returns:
      a CommonGrantOptions.Builder of CommonGrantOptions