Class RateLimitedApiKey

An API Gateway ApiKey, for which a rate limiting configuration can be specified.

Inheritance

System.Object

Resource

RateLimitedApiKey

Implements

IApiKey

IResource

Constructs.IConstruct

Constructs.IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class RateLimitedApiKey : Resource, IApiKey, IResource

Syntax (vb)

Public Class RateLimitedApiKey
    Inherits Resource
    Implements IApiKey, IResource

Remarks

Resource: AWS::ApiGateway::ApiKey

ExampleMetadata: infused

Examples

RestApi api;


var key = new RateLimitedApiKey(this, "rate-limited-api-key", new RateLimitedApiKeyProps {
    CustomerId = "hello-customer",
    Stages = new [] { api.DeploymentStage },
    Quota = new QuotaSettings {
        Limit = 10000,
        Period = Period.MONTH
    }
});

Synopsis

Constructors

RateLimitedApiKey(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
RateLimitedApiKey(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
RateLimitedApiKey(Construct, String, IRateLimitedApiKeyProps)

Properties

KeyArn	The API key ARN.
KeyId	The API key ID.

Methods

GrantRead(IGrantable)	Permits the IAM principal all read operations through this key.
GrantReadWrite(IGrantable)	Permits the IAM principal all read and write operations through this key.
GrantWrite(IGrantable)	Permits the IAM principal all write operations through this key.

Constructors

RateLimitedApiKey(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected RateLimitedApiKey(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

RateLimitedApiKey(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected RateLimitedApiKey(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

RateLimitedApiKey(Construct, String, IRateLimitedApiKeyProps)

public RateLimitedApiKey(Construct scope, string id, IRateLimitedApiKeyProps props = null)

Parameters

scope Constructs.Construct

id System.String

props IRateLimitedApiKeyProps

Properties

KeyArn

The API key ARN.

public virtual string KeyArn { get; }

Property Value

System.String

KeyId

The API key ID.

public virtual string KeyId { get; }

Property Value

System.String

Methods

GrantRead(IGrantable)

Permits the IAM principal all read operations through this key.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

GrantReadWrite(IGrantable)

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

public virtual Grant GrantReadWrite(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

GrantWrite(IGrantable)

Permits the IAM principal all write operations through this key.

public virtual Grant GrantWrite(IGrantable grantee)

Parameters

grantee IGrantable

The principal to grant access to.

Returns

Grant

Implements

IApiKey

IResource

Constructs.IConstruct

Constructs.IDependable