Class AddApiKeyOptions

Options to the UsagePlan.addApiKey() method.

Inheritance

object

AddApiKeyOptions

Implements

IAddApiKeyOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AddApiKeyOptions : IAddApiKeyOptions

Syntax (vb)

Public Class AddApiKeyOptions Implements IAddApiKeyOptions

Remarks

ExampleMetadata: infused

Examples

UsagePlan usagePlan;
            ApiKey apiKey;


            usagePlan.AddApiKey(apiKey, new AddApiKeyOptions {
                OverrideLogicalId = "MyCustomLogicalId"
            });

Synopsis

Constructors

AddApiKeyOptions()

Options to the UsagePlan.addApiKey() method.

Properties

OverrideLogicalId

Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

Constructors

AddApiKeyOptions()

Options to the UsagePlan.addApiKey() method.

public AddApiKeyOptions()

Remarks

ExampleMetadata: infused

Examples

UsagePlan usagePlan;
            ApiKey apiKey;


            usagePlan.AddApiKey(apiKey, new AddApiKeyOptions {
                OverrideLogicalId = "MyCustomLogicalId"
            });

Properties

OverrideLogicalId

Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource.

public string? OverrideLogicalId { get; set; }

Property Value

string

Remarks

Default: - autogenerated by the CDK

Implements

IAddApiKeyOptions