software.amazon.awscdk.services.apigateway

Interface CfnApiKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:02.300Z")
 @Stability(value=Stable)
public interface CfnApiKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ApiGateway::ApiKey`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnApiKeyProps.Builder	builder()
default String	getCustomerId() `AWS::ApiGateway::ApiKey.CustomerId`.
default String	getDescription() `AWS::ApiGateway::ApiKey.Description`.
default Object	getEnabled() `AWS::ApiGateway::ApiKey.Enabled`.
default Object	getGenerateDistinctId() `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
default String	getName() `AWS::ApiGateway::ApiKey.Name`.
default Object	getStageKeys() `AWS::ApiGateway::ApiKey.StageKeys`.
default List<CfnTag>	getTags() `AWS::ApiGateway::ApiKey.Tags`.
default String	getValue() `AWS::ApiGateway::ApiKey.Value`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomerId

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

`AWS::ApiGateway::ApiKey.CustomerId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid

getDescription

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

`AWS::ApiGateway::ApiKey.Description`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description

getEnabled

@Stability(value=Stable)
 @Nullable
default Object getEnabled()

`AWS::ApiGateway::ApiKey.Enabled`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled

getGenerateDistinctId

@Stability(value=Stable)
 @Nullable
default Object getGenerateDistinctId()

`AWS::ApiGateway::ApiKey.GenerateDistinctId`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid

getName

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

`AWS::ApiGateway::ApiKey.Name`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name

getStageKeys

@Stability(value=Stable)
 @Nullable
default Object getStageKeys()

`AWS::ApiGateway::ApiKey.StageKeys`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::ApiGateway::ApiKey.Tags`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags

getValue

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

`AWS::ApiGateway::ApiKey.Value`.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value

builder

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

Returns:

a CfnApiKeyProps.Builder of CfnApiKeyProps