Package software.amazon.awscdk.services.iam

Interface GrantOnPrincipalOptions

All Superinterfaces:

CommonGrantOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrantOnPrincipalOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:57.309Z")
@Stability(Stable)
public interface GrantOnPrincipalOptions
extends software.amazon.jsii.JsiiSerializable, CommonGrantOptions

Options for a grant operation that only applies to principals.

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.*;
 import software.amazon.awscdk.core.*;
 Construct construct;
 IGrantable grantable;
 GrantOnPrincipalOptions grantOnPrincipalOptions = GrantOnPrincipalOptions.builder()
         .actions(List.of("actions"))
         .grantee(grantable)
         .resourceArns(List.of("resourceArns"))
         // the properties below are optional
         .scope(construct)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GrantOnPrincipalOptions.Builder	builder()
default IConstruct	getScope()	Construct to report warnings on in case grant could not be registered.

Methods inherited from interface software.amazon.awscdk.services.iam.CommonGrantOptions

getActions, getGrantee, getResourceArns

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScope

@Stability(Stable)
@Nullable
default IConstruct getScope()

Construct to report warnings on in case grant could not be registered.

Default: - the construct in which this construct is defined

builder

@Stability(Stable)
static GrantOnPrincipalOptions.Builder builder()

Returns:

a GrantOnPrincipalOptions.Builder of GrantOnPrincipalOptions