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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.091Z")
 @Stability(value=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();
 

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() An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
default String	getDescription() A description of the purpose of the API key.
default Object	getEnabled() Indicates whether the API key can be used by clients.
default Object	getGenerateDistinctId() Specifies whether the key identifier is distinct from the created API key value.
default String	getName() A name for the API key.
default Object	getStageKeys() A list of stages to associate with this API key.
default List<CfnTag>	getTags() An array of arbitrary tags (key-value pairs) to associate with the API key.
default String	getValue() The value of the API key.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomerId

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

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

getDescription

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

A description of the purpose of the API key.

getEnabled

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

Indicates whether the API key can be used by clients.

getGenerateDistinctId

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

Specifies whether the key identifier is distinct from the created API key value.

This parameter is deprecated and should not be used.

getName

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

A name for the API key.

If you don't specify a name, AWS 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.

getStageKeys

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

A list of stages to associate with this API key.

getTags

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

An array of arbitrary tags (key-value pairs) to associate with the API key.

getValue

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

The value of the API key.

Must be at least 20 characters long.

builder

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

Returns:

a CfnApiKeyProps.Builder of CfnApiKeyProps