DomainGrants

class aws_cdk.aws_elasticsearch.DomainGrants(*args: Any, **kwargs)

Bases: object

Collection of grant methods for a IDomainRef.

ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticsearch as elasticsearch
from aws_cdk.interfaces import aws_elasticsearch as interfaces_elasticsearch

# domain_ref: interfaces_elasticsearch.IDomainRef

domain_grants = elasticsearch.DomainGrants.from_domain(domain_ref)

Methods

actions(grantee, actions, *, resource_arns=None)

Grant the given identity custom permissions.

Parameters:

grantee (IGrantable)
actions (Sequence[str])
resource_arns (Optional[Sequence[str]]) – The ARNs of the resources to grant permissions on. Default: - The ARN of the resource associated with the grant is used.

Return type:

Grant

read(grantee)

Grant read permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: grantee (IGrantable)
Return type:: Grant

read_write(grantee)

Grant read/write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: grantee (IGrantable)
Return type:: Grant

write(grantee)

Grant write permissions for this domain and its contents to an IAM principal (Role/Group/User).

Parameters:: grantee (IGrantable)
Return type:: Grant

Static Methods

classmethod from_domain(resource)

Creates grants for DomainGrants.

Parameters:: resource (IDomainRef)
Return type:: DomainGrants