Package 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(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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApiKey.StageKeyProperty.Builder	builder()
default String	getRestApiId()	The string identifier of the associated RestApi.
default String	getStageName()	The stage name associated with the stage key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRestApiId

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

The string identifier of the associated RestApi.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid

getStageName

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

The stage name associated with the stage key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename

builder

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

Returns:

a CfnApiKey.StageKeyProperty.Builder of CfnApiKey.StageKeyProperty