AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateApiKey operation. Create an ApiKey resource.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.APIGateway.AmazonAPIGatewayRequest
      Amazon.APIGateway.Model.CreateApiKeyRequest

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public class CreateApiKeyRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The CreateApiKeyRequest type exposes the following members

Constructors

NameDescription
Public Method CreateApiKeyRequest()

Properties

NameTypeDescription
Public Property CustomerId System.String

Gets and sets the property CustomerId.

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

Public Property Description System.String

Gets and sets the property Description.

The description of the ApiKey.

Public Property Enabled System.Boolean

Gets and sets the property Enabled.

Specifies whether the ApiKey can be used by callers.

Public Property GenerateDistinctId System.Boolean

Gets and sets the property GenerateDistinctId.

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

Public Property Name System.String

Gets and sets the property Name.

The name of the ApiKey.

Public Property StageKeys System.Collections.Generic.List<Amazon.APIGateway.Model.StageKey>

Gets and sets the property StageKeys.

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Public Property Value System.String

Gets and sets the property Value.

Specifies a value of the API key.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5