GrantOnPrincipalOptions

class aws_cdk.aws_iam.GrantOnPrincipalOptions(*, actions, grantee, resource_arns, scope=None)

Bases: aws_cdk.aws_iam.CommonGrantOptions

Options for a grant operation that only applies to principals.

Parameters
  • actions (Sequence[str]) – The actions to grant.

  • grantee (IGrantable) – The principal to grant to. Default: if principal is undefined, no work is done.

  • resource_arns (Sequence[str]) – The resource ARNs to grant to.

  • scope (Optional[IConstruct]) – Construct to report warnings on in case grant could not be registered. Default: - the construct in which this construct is defined

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iam as iam
import aws_cdk.core as cdk

# construct: cdk.Construct
# grantable: iam.IGrantable

grant_on_principal_options = iam.GrantOnPrincipalOptions(
    actions=["actions"],
    grantee=grantable,
    resource_arns=["resourceArns"],

    # the properties below are optional
    scope=construct
)

Attributes

actions

The actions to grant.

Return type

List[str]

grantee

The principal to grant to.

Default

if principal is undefined, no work is done.

Return type

IGrantable

resource_arns

The resource ARNs to grant to.

Return type

List[str]

scope

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

Default
  • the construct in which this construct is defined

Return type

Optional[IConstruct]