software.amazon.awscdk.services.apigateway

Interface CfnApiKey.StageKeyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiKey.StageKeyProperty.Jsii$Proxy

Enclosing class:

CfnApiKey

@Stability(value=Stable)
public static interface CfnApiKey.StageKeyProperty
extends software.amazon.jsii.JsiiSerializable

`StageKey` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApiKey.StageKeyProperty.Builder	builder()
default String	getRestApiId() The ID of a `RestApi` resource that includes the stage with which you want to associate the API key.
default String	getStageName() The name of the stage with which to associate the API key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

@Stability(value=Stable)
 @Nullable
default String getRestApiId()

The ID of a `RestApi` resource that includes the stage with which you want to associate the API key.

getStageName

@Stability(value=Stable)
 @Nullable
default String getStageName()

The name of the stage with which to associate the API key.

The stage must be included in the RestApi resource that you specified in the RestApiId property.

builder

@Stability(value=Stable)
static CfnApiKey.StageKeyProperty.Builder builder()

Returns:

a CfnApiKey.StageKeyProperty.Builder of CfnApiKey.StageKeyProperty