Package software.amazon.awscdk.cfnpropertymixins.services.location

Class CfnAPIKeyPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.location.CfnAPIKeyPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.133Z")
@Stability(Stable)
public class CfnAPIKeyPropsMixin
extends Mixin
implements software.constructs.IMixin

The API key resource in your AWS account, which lets you grant actions for Amazon Location resources to the API key bearer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.location.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAPIKeyPropsMixin cfnAPIKeyPropsMixin = CfnAPIKeyPropsMixin.Builder.create(CfnAPIKeyMixinProps.builder()
         .description("description")
         .expireTime("expireTime")
         .forceDelete(false)
         .forceUpdate(false)
         .keyName("keyName")
         .noExpiry(false)
         .restrictions(ApiKeyRestrictionsProperty.builder()
                 .allowActions(List.of("allowActions"))
                 .allowAndroidApps(List.of(AndroidAppProperty.builder()
                         .certificateFingerprint("certificateFingerprint")
                         .package("package")
                         .build()))
                 .allowAppleApps(List.of(AppleAppProperty.builder()
                         .bundleId("bundleId")
                         .build()))
                 .allowReferers(List.of("allowReferers"))
                 .allowResources(List.of("allowResources"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-apikey.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnAPIKeyPropsMixin.AndroidAppProperty	Example:
static interface	CfnAPIKeyPropsMixin.ApiKeyRestrictionsProperty	API Restrictions on the allowed actions, resources, and referers for an API key resource.
static interface	CfnAPIKeyPropsMixin.AppleAppProperty	Example:
static final class	CfnAPIKeyPropsMixin.Builder	A fluent builder for CfnAPIKeyPropsMixin.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnAPIKeyPropsMixin(CfnAPIKeyMixinProps props)	Create a mixin to apply properties to AWS::Location::APIKey.
	CfnAPIKeyPropsMixin(CfnAPIKeyMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Location::APIKey.
protected	CfnAPIKeyPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAPIKeyPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnAPIKeyMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnAPIKeyPropsMixin

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

CfnAPIKeyPropsMixin

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

CfnAPIKeyPropsMixin

@Stability(Stable)
public CfnAPIKeyPropsMixin(@NotNull
 CfnAPIKeyMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Location::APIKey.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnAPIKeyPropsMixin

@Stability(Stable)
public CfnAPIKeyPropsMixin(@NotNull
 CfnAPIKeyMixinProps props)

Create a mixin to apply properties to AWS::Location::APIKey.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnAPIKeyMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()