Package software.amazon.awscdk.services.apigateway

Class CfnApiKeyProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.CfnApiKeyProps.Jsii$Proxy
All Implemented Interfaces:
CfnApiKeyProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnApiKeyProps
@Stability(Stable) @Internal public static final class CfnApiKeyProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnApiKeyProps
An implementation for CfnApiKeyProps

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

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

    CfnApiKeyProps.Builder, CfnApiKeyProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnApiKeyProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnApiKeyProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getCustomerId()
    An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
    final String
    getDescription()
    The description of the ApiKey.
    final Object
    getEnabled()
    Specifies whether the ApiKey can be used by callers.
    final Object
    getGenerateDistinctId()
    Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.
    final String
    getName()
    A name for the API key.
    final Object
    getStageKeys()
    DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    final List<CfnTag>
    getTags()
    The key-value map of strings.
    final String
    getValue()
    Specifies a value of the API key.
    final int
    hashCode()
     

    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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnApiKeyProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnApiKeyProps.Builder.

  • Method Details

    • getCustomerId

      public final String getCustomerId()
      Description copied from interface: CfnApiKeyProps
      An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
      Specified by:
      getCustomerId in interface CfnApiKeyProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnApiKeyProps
      The description of the ApiKey.
      Specified by:
      getDescription in interface CfnApiKeyProps

    • getEnabled

      public final Object getEnabled()
      Description copied from interface: CfnApiKeyProps
      Specifies whether the ApiKey can be used by callers.
      Specified by:
      getEnabled in interface CfnApiKeyProps

    • getGenerateDistinctId

      public final Object getGenerateDistinctId()
      Description copied from interface: CfnApiKeyProps
      Specifies whether ( true ) or not ( false ) the key identifier is distinct from the created API key value.

      This parameter is deprecated and should not be used.

      Specified by:
      getGenerateDistinctId in interface CfnApiKeyProps

    • getName

      public final String getName()
      Description copied from interface: CfnApiKeyProps
      A name for the API key.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. For more information, see Name Type .

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

      Specified by:
      getName in interface CfnApiKeyProps

    • getStageKeys

      public final Object getStageKeys()
      Description copied from interface: CfnApiKeyProps
      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
      Specified by:
      getStageKeys in interface CfnApiKeyProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnApiKeyProps
      The key-value map of strings.

      The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

      Specified by:
      getTags in interface CfnApiKeyProps

    • getValue

      public final String getValue()
      Description copied from interface: CfnApiKeyProps
      Specifies a value of the API key.
      Specified by:
      getValue in interface CfnApiKeyProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object