Interface CfnApiKeyProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnApiKeyProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.382Z")
@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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnApiKeyProps
static final class
An implementation forCfnApiKeyProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnApiKeyProps.Builder
builder()
default String
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.default String
The description of the ApiKey.default Object
Specifies whether the ApiKey can be used by callers.default Object
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
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.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
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.- See Also:
-
getDescription
The description of the ApiKey.- See Also:
-
getEnabled
Specifies whether the ApiKey can be used by callers.Default: - false
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
getStageKeys
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.- See Also:
-
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:
-
getValue
Specifies a value of the API key.- See Also:
-
builder
- Returns:
- a
CfnApiKeyProps.Builder
ofCfnApiKeyProps
-