Interface CfnApiKey.StageKeyProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiKey.StageKeyProperty.Jsii$Proxy
- Enclosing class:
CfnApiKey
@Stability(Stable)
public static interface CfnApiKey.StageKeyProperty
extends software.amazon.jsii.JsiiSerializable
StageKey
is a property of the AWS::ApiGateway::ApiKey resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.
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.*; StageKeyProperty stageKeyProperty = StageKeyProperty.builder() .restApiId("restApiId") .stageName("stageName") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiKey.StageKeyProperty
static final class
An implementation forCfnApiKey.StageKeyProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getRestApiId
The string identifier of the associated RestApi.- See Also:
-
getStageName
The stage name associated with the stage key.- See Also:
-
builder
- Returns:
- a
CfnApiKey.StageKeyProperty.Builder
ofCfnApiKey.StageKeyProperty
-