Package software.amazon.awscdk.services.iam

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.103.1 (build bef2dea)",
           date="2024-10-05T03:43:44.408Z")
@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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CommonGrantOptions.Builder	A builder for CommonGrantOptions
static final class	CommonGrantOptions.Jsii$Proxy	An implementation for CommonGrantOptions

Method Summary

Modifier and Type	Method	Description
static CommonGrantOptions.Builder	builder()
List<String>	getActions()	The actions to grant.
default Map<String,Map<String,Object>>	getConditions()	Any conditions to attach to the grant.
IGrantable	getGrantee()	The principal to grant to.
List<String>	getResourceArns()	The resource ARNs to grant to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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