software.amazon.awscdk.services.apigateway

Class ApiKey

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.ApiKey

All Implemented Interfaces:

IConstruct, IDependable, IResource, IApiKey

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:41.842Z")
public class ApiKey
extends Resource
implements IApiKey

An API Gateway ApiKey.

An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.

Example:

 IApiKey importedKey = ApiKey.fromApiKeyId(this, "imported-key", "<api-key-id>");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiKey.Builder A fluent builder for ApiKey.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IApiKey

IApiKey.Jsii$Default, IApiKey.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiKey(software.amazon.jsii.JsiiObjectRef objRef)
	ApiKey(software.constructs.Construct scope, java.lang.String id)
	ApiKey(software.constructs.Construct scope, java.lang.String id, ApiKeyProps props)

Method Summary

Modifier and Type	Method and Description
static IApiKey	fromApiKeyId(software.constructs.Construct scope, java.lang.String id, java.lang.String apiKeyId) Import an ApiKey by its Id.
java.lang.String	getKeyArn() The API key ARN.
java.lang.String	getKeyId() The API key ID.
Grant	grantRead(IGrantable grantee) Permits the IAM principal all read operations through this key.
Grant	grantReadWrite(IGrantable grantee) Permits the IAM principal all read and write operations through this key.
Grant	grantWrite(IGrantable grantee) Permits the IAM principal all write operations through this key.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

ApiKey

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

ApiKey

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

ApiKey

public ApiKey(software.constructs.Construct scope,
              java.lang.String id,
              ApiKeyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ApiKey

public ApiKey(software.constructs.Construct scope,
              java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromApiKeyId

public static IApiKey fromApiKeyId(software.constructs.Construct scope,
                                   java.lang.String id,
                                   java.lang.String apiKeyId)

Import an ApiKey by its Id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

apiKeyId - This parameter is required.

grantRead

public Grant grantRead(IGrantable grantee)

Permits the IAM principal all read operations through this key.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantReadWrite

public Grant grantReadWrite(IGrantable grantee)

Permits the IAM principal all read and write operations through this key.

Parameters:

grantee - The principal to grant access to. This parameter is required.

grantWrite

public Grant grantWrite(IGrantable grantee)

Permits the IAM principal all write operations through this key.

Parameters:

grantee - The principal to grant access to. This parameter is required.

getKeyArn

public java.lang.String getKeyArn()

The API key ARN.

Specified by:

getKeyArn in interface IApiKey

getKeyId

public java.lang.String getKeyId()

The API key ID.

Specified by:

getKeyId in interface IApiKey