Package 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.120.0 (build 192dc88)",
           date="2025-12-12T17:54:04.590Z")
@Stability(Stable)
public interface CfnApiKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApiKey.

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.*;
 CfnApiKeyProps cfnApiKeyProps = CfnApiKeyProps.builder()
         .customerId("customerId")
         .description("description")
         .enabled(false)
         .generateDistinctId(false)
         .name("name")
         .stageKeys(List.of(StageKeyProperty.builder()
                 .restApiId("restApiId")
                 .stageName("stageName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .value("value")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApiKeyProps.Builder	builder()
default String	getCustomerId()	An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
default String	getDescription()	The description of the ApiKey.
default Object	getEnabled()	Specifies whether the ApiKey can be used by callers.
default Object	getGenerateDistinctId()	Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.
default String	getName()	A name for the API key.
default Object	getStageKeys()	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
default List<CfnTag>	getTags()	The key-value map of strings.
default String	getValue()	Specifies a value of the API key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomerId

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

An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.

See Also:

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

getDescription

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

The description of the ApiKey.

See Also:

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

getEnabled

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

Specifies whether the ApiKey can be used by callers.

Returns union: either Boolean or IResolvable

Default: - false

See Also:

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

getGenerateDistinctId

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

Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.

This parameter is deprecated and should not be used.

Returns union: either Boolean or IResolvable

See Also:

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

getName

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

A name for the API key.

If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

See Also:

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

getStageKeys

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

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApiKey.StageKeyProperty>

See Also:

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

getTags

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

The key-value map of strings.

The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

See Also:

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

getValue

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

Specifies a value of the API key.

See Also:

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

builder

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

Returns:

a CfnApiKeyProps.Builder of CfnApiKeyProps