Class ApiKey

(experimental) An API Key.

Inheritance

object

Resource

ApiKey

Implements

IApiKey

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Location.Alpha

Assembly: Amazon.CDK.AWS.Location.Alpha.dll

Syntax (csharp)

public class ApiKey : Resource, IApiKey, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class ApiKey Inherits Resource Implements IApiKey, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html

ExampleMetadata: infused

Examples

new ApiKey(this, "APIKeyAny", new ApiKeyProps {
                 // specify allowed actions
                 AllowMapsActions = new [] { AllowMapsAction.GET_STATIC_MAP },
                 AllowPlacesActions = new [] { AllowPlacesAction.GET_PLACE },
                 AllowRoutesActions = new [] { AllowRoutesAction.CALCULATE_ISOLINES }
             });

Synopsis

Constructors

ApiKey(Construct, string, IApiKeyProps?)

(experimental) An API Key.

Properties

ApiKeyArn	(experimental) The Amazon Resource Name (ARN) of the api key resource.
ApiKeyCreateTime	(experimental) The timestamp for when the api key resource was created in ISO 8601 format.
ApiKeyName	(experimental) The name of the api key.
ApiKeyUpdateTime	(experimental) The timestamp for when the api key resource was last updated in ISO 8601 format.
PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.

Methods

FromApiKeyArn(Construct, string, string)	(experimental) Use an existing api key by ARN.
FromApiKeyName(Construct, string, string)	(experimental) Use an existing api key by name.

Constructors

ApiKey(Construct, string, IApiKeyProps?)

(experimental) An API Key.

public ApiKey(Construct scope, string id, IApiKeyProps? props = null)

Parameters

scope Construct

id string

props IApiKeyProps

Remarks

Stability: Experimental

Properties

ApiKeyArn

(experimental) The Amazon Resource Name (ARN) of the api key resource.

public virtual string ApiKeyArn { get; }

Property Value

string

Remarks

Stability: Experimental

ApiKeyCreateTime

(experimental) The timestamp for when the api key resource was created in ISO 8601 format.

public virtual string ApiKeyCreateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

ApiKeyName

(experimental) The name of the api key.

public virtual string ApiKeyName { get; }

Property Value

string

Remarks

Stability: Experimental

ApiKeyUpdateTime

(experimental) The timestamp for when the api key resource was last updated in ISO 8601 format.

public virtual string ApiKeyUpdateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

Methods

FromApiKeyArn(Construct, string, string)

(experimental) Use an existing api key by ARN.

public static IApiKey FromApiKeyArn(Construct scope, string id, string apiKeyArn)

Parameters

scope Construct

id string

apiKeyArn string

Returns

IApiKey

Remarks

Stability: Experimental

FromApiKeyName(Construct, string, string)

(experimental) Use an existing api key by name.

public static IApiKey FromApiKeyName(Construct scope, string id, string apiKeyName)

Parameters

scope Construct

id string

apiKeyName string

Returns

IApiKey

Remarks

Stability: Experimental

Implements

IApiKey

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware