ApiGatewayV1ApiKey

The ApiGatewayV1ApiKey component is internally used by the ApiGatewayV1UsagePlan component to add API keys to Amazon API Gateway REST API.

Note

This component is not intended to be created directly.

You’ll find this component returned by the addApiKey method of the ApiGatewayV1UsagePlan component.

---

Constructor

new ApiGatewayV1ApiKey(name, args, opts?)

Parameters

• name string

• args ApiKeyArgs

• opts? ComponentResourceOptions

Properties

nodes

Type Object

• apiKey

The underlying resources this component creates.

nodes.apiKey

Type ApiKey

The API Gateway API Key.

value

Type Output<string>

The API key value.

SDK

Use the SDK in your runtime to interact with your infrastructure.

---

Links

This is accessible through the Resource object in the SDK.

• value string

  The API key value.

ApiKeyArgs

apiId

Type Input<string>

The API Gateway REST API to use for the API key.

usagePlanId

Type Input<string>

The API Gateway Usage Plan to use for the API key.

value?

Type Input<string>

The value of the API key. If not provided, it will be generated automatically.

{
  value: "d41d8cd98f00b204e9800998ecf8427e"
}