ApiKeyGrants

class aws_cdk.aws_apigateway.ApiKeyGrants(*args: Any, **kwargs)

Bases: object

Collection of grant methods for a IApiKeyRef.

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_apigateway as apigateway
from aws_cdk.interfaces import aws_apigateway as interfaces_aws_apigateway

# api_key_ref: interfaces_aws_apigateway.IApiKeyRef

api_key_grants = apigateway.ApiKeyGrants.from_api_key(api_key_ref)

Methods

read(grantee)

Permits the IAM principal all read operations through this key.

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

read_write(grantee)

Permits the IAM principal all read and write operations through this key.

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

write(grantee)

Permits the IAM principal all write operations through this key.

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

Static Methods

classmethod from_api_key(resource)

Creates grants for ApiKeyGrants.

Parameters:: resource (IApiKeyRef)
Return type:: ApiKeyGrants