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.29.0 (build 41df200)",
           date="2021-06-02T09:54:56.818Z")
 @Stability(value=Stable)
public class CfnApiKey
extends CfnResource
implements IInspectable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApiKey.Builder A fluent builder for CfnApiKey.
static interface	CfnApiKey.StageKeyProperty

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()
protected Map<String,Object>	getCfnProperties()
String	getCustomerId() `AWS::ApiGateway::ApiKey.CustomerId`.
String	getDescription() `AWS::ApiGateway::ApiKey.Description`.
Object	getEnabled() `AWS::ApiGateway::ApiKey.Enabled`.
Object	getGenerateDistinctId() `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
String	getName() `AWS::ApiGateway::ApiKey.Name`.
Object	getStageKeys() `AWS::ApiGateway::ApiKey.StageKeys`.
TagManager	getTags() `AWS::ApiGateway::ApiKey.Tags`.
String	getValue() `AWS::ApiGateway::ApiKey.Value`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomerId(String value) `AWS::ApiGateway::ApiKey.CustomerId`.
void	setDescription(String value) `AWS::ApiGateway::ApiKey.Description`.
void	setEnabled(Boolean value) `AWS::ApiGateway::ApiKey.Enabled`.
void	setEnabled(IResolvable value) `AWS::ApiGateway::ApiKey.Enabled`.
void	setGenerateDistinctId(Boolean value) `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
void	setGenerateDistinctId(IResolvable value) `AWS::ApiGateway::ApiKey.GenerateDistinctId`.
void	setName(String value) `AWS::ApiGateway::ApiKey.Name`.
void	setStageKeys(IResolvable value) `AWS::ApiGateway::ApiKey.StageKeys`.
void	setStageKeys(List<Object> value) `AWS::ApiGateway::ApiKey.StageKeys`.
void	setValue(String value) `AWS::ApiGateway::ApiKey.Value`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, 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()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

getCustomerId

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

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

setCustomerId

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

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

getDescription

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

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

setDescription

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

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

getEnabled

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

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

setEnabled

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

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

setEnabled

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

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

getGenerateDistinctId

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

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

setGenerateDistinctId

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

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

setGenerateDistinctId

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

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

getName

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

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

setName

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

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

getStageKeys

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

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

setStageKeys

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

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

setStageKeys

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

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

getValue

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

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

setValue

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

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