@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:36.200Z") @Stability(value=Stable) public class RateLimitedApiKey extends Resource implements IApiKey
Example:
RestApi api;
RateLimitedApiKey key = RateLimitedApiKey.Builder.create(this, "rate-limited-api-key")
.customerId("hello-customer")
.resources(List.of(api))
.quota(QuotaSettings.builder()
.limit(10000)
.period(Period.MONTH)
.build())
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
RateLimitedApiKey.Builder
A fluent builder for
RateLimitedApiKey. |
software.amazon.jsii.JsiiObject.InitializationModeIApiKey.Jsii$Default, IApiKey.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
|
RateLimitedApiKey(software.constructs.Construct scope,
String id) |
|
RateLimitedApiKey(software.constructs.Construct scope,
String id,
RateLimitedApiKeyProps props) |
protected |
RateLimitedApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
RateLimitedApiKey(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
String |
getKeyArn()
The API key ARN.
|
String |
getKeyId()
The API key ID.
|
Grant |
grantRead(IGrantable grantee)
Permits the IAM principal all read operations through this key.
|
Grant |
grantReadWrite(IGrantable grantee)
Permits the IAM principal all read and write operations through this key.
|
Grant |
grantWrite(IGrantable grantee)
Permits the IAM principal all write operations through this key.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResourcejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitapplyRemovalPolicy, getEnv, getStackprotected RateLimitedApiKey(software.amazon.jsii.JsiiObjectRef objRef)
protected RateLimitedApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public RateLimitedApiKey(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@Nullable
RateLimitedApiKeyProps props)
scope - This parameter is required.id - This parameter is required.props - @Stability(value=Stable)
public RateLimitedApiKey(@NotNull
software.constructs.Construct scope,
@NotNull
String id)
scope - This parameter is required.id - This parameter is required.@Stability(value=Stable) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
grantee - The principal to grant access to. This parameter is required.@Stability(value=Stable) @NotNull public Grant grantReadWrite(@NotNull IGrantable grantee)
grantee - The principal to grant access to. This parameter is required.@Stability(value=Stable) @NotNull public Grant grantWrite(@NotNull IGrantable grantee)
grantee - The principal to grant access to. This parameter is required.@Stability(value=Stable) @NotNull public String getKeyArn()
Copyright © 2022. All rights reserved.