software.amazon.awscdk.services.apigateway

Interface CfnUsagePlanKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlanKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.142Z")
 @Stability(value=Stable)
public interface CfnUsagePlanKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnUsagePlanKey`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnUsagePlanKeyProps cfnUsagePlanKeyProps = CfnUsagePlanKeyProps.builder()
         .keyId("keyId")
         .keyType("keyType")
         .usagePlanId("usagePlanId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUsagePlanKeyProps.Builder A builder for CfnUsagePlanKeyProps
static class	CfnUsagePlanKeyProps.Jsii$Proxy An implementation for CfnUsagePlanKeyProps

Method Summary

Modifier and Type	Method and Description
static CfnUsagePlanKeyProps.Builder	builder()
String	getKeyId() The ID of the usage plan key.
String	getKeyType() The type of usage plan key.
String	getUsagePlanId() The ID of the usage plan.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKeyId

@Stability(value=Stable)
 @NotNull
String getKeyId()

The ID of the usage plan key.

getKeyType

@Stability(value=Stable)
 @NotNull
String getKeyType()

The type of usage plan key.

Currently, the only valid key type is API_KEY .

getUsagePlanId

@Stability(value=Stable)
 @NotNull
String getUsagePlanId()

The ID of the usage plan.

builder

@Stability(value=Stable)
static CfnUsagePlanKeyProps.Builder builder()

Returns:

a CfnUsagePlanKeyProps.Builder of CfnUsagePlanKeyProps