Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnApiKeyPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnApiKeyPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:55.423Z") @Stability(Stable) public class CfnApiKeyPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.apigateway.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnApiKeyPropsMixin cfnApiKeyPropsMixin = CfnApiKeyPropsMixin.Builder.create(CfnApiKeyMixinProps.builder()
         .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())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnApiKeyPropsMixin.Builder
    A fluent builder for CfnApiKeyPropsMixin.
    static interface 
    CfnApiKeyPropsMixin.StageKeyProperty
    StageKey is a property of the AWS::ApiGateway::ApiKey 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.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::ApiGateway::ApiKey.
     
    CfnApiKeyPropsMixin(CfnApiKeyMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::ApiGateway::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::ApiGateway::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::ApiGateway::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()