Class RateLimitedApiKeyProps
RateLimitedApiKey properties.
Inheritance
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class RateLimitedApiKeyProps : Object, IRateLimitedApiKeyProps, IApiKeyProps, IApiKeyOptions, IResourceOptions
Syntax (vb)
Public Class RateLimitedApiKeyProps
Inherits Object
Implements IRateLimitedApiKeyProps, IApiKeyProps, IApiKeyOptions, IResourceOptions
Remarks
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
RateLimitedApiKeyProps() |
Properties
ApiKeyName | A name for the API key. |
ApiStages | API Stages to be associated with the RateLimitedApiKey. |
CustomerId | An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. |
DefaultCorsPreflightOptions | Adds a CORS preflight OPTIONS method to this resource and all child resources. |
DefaultIntegration | An integration to use as a default for all methods created within this API unless an integration is specified. |
DefaultMethodOptions | Method options to use as a default for all methods created within this API unless custom options are specified. |
Description | A description of the purpose of the API key. |
Enabled | Indicates whether the API key can be used by clients. |
GenerateDistinctId | Specifies whether the key identifier is distinct from the created API key value. |
Quota | Number of requests clients can make in a given time period. |
Resources | (deprecated) A list of resources this api key is associated with. |
Stages | A list of Stages this api key is associated with. |
Throttle | Overall throttle settings for the API. |
Value | The value of the API key. |
Constructors
RateLimitedApiKeyProps()
public RateLimitedApiKeyProps()
Properties
ApiKeyName
A name for the API key.
public string ApiKeyName { get; set; }
Property Value
System.String
Remarks
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
Default: automically generated name
ApiStages
API Stages to be associated with the RateLimitedApiKey.
public IUsagePlanPerApiStage[] ApiStages { get; set; }
Property Value
Remarks
Default: none
CustomerId
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
public string CustomerId { get; set; }
Property Value
System.String
Remarks
DefaultCorsPreflightOptions
Adds a CORS preflight OPTIONS method to this resource and all child resources.
public ICorsOptions DefaultCorsPreflightOptions { get; set; }
Property Value
Remarks
You can add CORS at the resource-level using addCorsPreflight
.
Default: - CORS is disabled
DefaultIntegration
An integration to use as a default for all methods created within this API unless an integration is specified.
public Integration DefaultIntegration { get; set; }
Property Value
Remarks
Default: - Inherited from parent.
DefaultMethodOptions
Method options to use as a default for all methods created within this API unless custom options are specified.
public IMethodOptions DefaultMethodOptions { get; set; }
Property Value
Remarks
Default: - Inherited from parent.
Description
A description of the purpose of the API key.
public string Description { get; set; }
Property Value
System.String
Remarks
Enabled
Indicates whether the API key can be used by clients.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
GenerateDistinctId
Specifies whether the key identifier is distinct from the created API key value.
public Nullable<bool> GenerateDistinctId { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Quota
Number of requests clients can make in a given time period.
public IQuotaSettings Quota { get; set; }
Property Value
Remarks
Default: none
Resources
(deprecated) A list of resources this api key is associated with.
public IRestApi[] Resources { get; set; }
Property Value
IRestApi[]
Remarks
Default: none
Stability: Deprecated
Stages
A list of Stages this api key is associated with.
public IStage[] Stages { get; set; }
Property Value
IStage[]
Remarks
Default: - the api key is not associated with any stages
Throttle
Overall throttle settings for the API.
public IThrottleSettings Throttle { get; set; }
Property Value
Remarks
Default: none
Value
The value of the API key.
public string Value { get; set; }
Property Value
System.String
Remarks
Must be at least 20 characters long.
Default: none