software.amazon.awscdk.services.apigateway

Class CfnApiKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnApiKey

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.089Z")
 @Stability(value=Stable)
public class CfnApiKey
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::ApiKey`.

The AWS::ApiGateway::ApiKey resource creates a unique key that you can distribute to clients who are executing API Gateway Method resources that require an API key. To specify which API key clients must use, map the API key with the RestApi and Stage resources that include the methods that require a key.

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.*;
 CfnApiKey cfnApiKey = CfnApiKey.Builder.create(this, "MyCfnApiKey")
         .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	Class and Description
static class	CfnApiKey.Builder A fluent builder for CfnApiKey.
static interface	CfnApiKey.StageKeyProperty `StageKey` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApiKey(software.constructs.Construct scope, String id) Create a new `AWS::ApiGateway::ApiKey`.
	CfnApiKey(software.constructs.Construct scope, String id, CfnApiKeyProps props) Create a new `AWS::ApiGateway::ApiKey`.
protected	CfnApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrApiKeyId() The ID for the API key.
protected Map<String,Object>	getCfnProperties()
String	getCustomerId() An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
String	getDescription() A description of the purpose of the API key.
Object	getEnabled() Indicates whether the API key can be used by clients.
Object	getGenerateDistinctId() Specifies whether the key identifier is distinct from the created API key value.
String	getName() A name for the API key.
Object	getStageKeys() A list of stages to associate with this API key.
TagManager	getTags() An array of arbitrary tags (key-value pairs) to associate with the API key.
String	getValue() The value of the API key.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerId(String value) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
void	setDescription(String value) A description of the purpose of the API key.
void	setEnabled(Boolean value) Indicates whether the API key can be used by clients.
void	setEnabled(IResolvable value) Indicates whether the API key can be used by clients.
void	setGenerateDistinctId(Boolean value) Specifies whether the key identifier is distinct from the created API key value.
void	setGenerateDistinctId(IResolvable value) Specifies whether the key identifier is distinct from the created API key value.
void	setName(String value) A name for the API key.
void	setStageKeys(IResolvable value) A list of stages to associate with this API key.
void	setStageKeys(List<Object> value) A list of stages to associate with this API key.
void	setValue(String value) The value of the API key.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApiKey

protected CfnApiKey(software.amazon.jsii.JsiiObjectRef objRef)

CfnApiKey

protected CfnApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApiKey

@Stability(value=Stable)
public CfnApiKey(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnApiKeyProps props)

Create a new `AWS::ApiGateway::ApiKey`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnApiKey

@Stability(value=Stable)
public CfnApiKey(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Create a new `AWS::ApiGateway::ApiKey`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiKeyId

@Stability(value=Stable)
 @NotNull
public String getAttrApiKeyId()

The ID for the API key.

For example: abc123 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getCustomerId

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

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

setCustomerId

@Stability(value=Stable)
public void setCustomerId(@Nullable
                                                   String value)

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

getDescription

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

A description of the purpose of the API key.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the purpose of the API key.

getEnabled

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

Indicates whether the API key can be used by clients.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Indicates whether the API key can be used by clients.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Indicates whether the API key can be used by clients.

getGenerateDistinctId

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

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

This parameter is deprecated and should not be used.

setGenerateDistinctId

@Stability(value=Stable)
public void setGenerateDistinctId(@Nullable
                                                           Boolean value)

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

This parameter is deprecated and should not be used.

setGenerateDistinctId

@Stability(value=Stable)
public void setGenerateDistinctId(@Nullable
                                                           IResolvable value)

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
public 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.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

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
public Object getStageKeys()

A list of stages to associate with this API key.

setStageKeys

@Stability(value=Stable)
public void setStageKeys(@Nullable
                                                  IResolvable value)

A list of stages to associate with this API key.

setStageKeys

@Stability(value=Stable)
public void setStageKeys(@Nullable
                                                  List<Object> value)

A list of stages to associate with this API key.

getValue

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

The value of the API key.

Must be at least 20 characters long.

setValue

@Stability(value=Stable)
public void setValue(@Nullable
                                              String value)

The value of the API key.

Must be at least 20 characters long.