Package software.amazon.awscdk.services.apigateway

Class ApiKeyProps.Jsii$Proxy

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

  • 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.ApiKeyProps

    ApiKeyProps.Builder, ApiKeyProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(ApiKeyProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the ApiKeyProps.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
    getApiKeyName()
    A name for the API key.
    final String
    getCustomerId()
    An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
    final CorsOptions
    getDefaultCorsPreflightOptions()
    Adds a CORS preflight OPTIONS method to this resource and all child resources.
    final Integration
    getDefaultIntegration()
    An integration to use as a default for all methods created within this API unless an integration is specified.
    final MethodOptions
    getDefaultMethodOptions()
    Method options to use as a default for all methods created within this API unless custom options are specified.
    final String
    getDescription()
    A description of the purpose of the API key.
    final Boolean
    getEnabled()
    Indicates whether the API key can be used by clients.
    final Boolean
    getGenerateDistinctId()
    Specifies whether the key identifier is distinct from the created API key value.
    final List<IRestApi>
    getResources()
    (deprecated) A list of resources this api key is associated with.
    final List<IStage>
    getStages()
    A list of Stages this api key is associated with.
    final String
    getValue()
    The 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(ApiKeyProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the ApiKeyProps.Builder.

  • Method Details

    • getCustomerId

      public final String getCustomerId()
      Description copied from interface: ApiKeyProps
      An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

      Default: none

      Specified by:
      getCustomerId in interface ApiKeyProps

    • getEnabled

      public final Boolean getEnabled()
      Description copied from interface: ApiKeyProps
      Indicates whether the API key can be used by clients.

      Default: true

      Specified by:
      getEnabled in interface ApiKeyProps

    • getGenerateDistinctId

      public final Boolean getGenerateDistinctId()
      Description copied from interface: ApiKeyProps
      Specifies whether the key identifier is distinct from the created API key value.

      Default: false

      Specified by:
      getGenerateDistinctId in interface ApiKeyProps

    • getResources

      public final List<IRestApi> getResources()
      Description copied from interface: ApiKeyProps
      (deprecated) A list of resources this api key is associated with.

      Default: none

      Specified by:
      getResources in interface ApiKeyProps

    • getStages

      public final List<IStage> getStages()
      Description copied from interface: ApiKeyProps
      A list of Stages this api key is associated with.

      Default: - the api key is not associated with any stages

      Specified by:
      getStages in interface ApiKeyProps

    • getApiKeyName

      public final String getApiKeyName()
      Description copied from interface: ApiKeyOptions
      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.

      Default: automically generated name

      Specified by:
      getApiKeyName in interface ApiKeyOptions

    • getDescription

      public final String getDescription()
      Description copied from interface: ApiKeyOptions
      A description of the purpose of the API key.

      Default: none

      Specified by:
      getDescription in interface ApiKeyOptions

    • getValue

      public final String getValue()
      Description copied from interface: ApiKeyOptions
      The value of the API key.

      Must be at least 20 characters long.

      Default: none

      Specified by:
      getValue in interface ApiKeyOptions

    • getDefaultCorsPreflightOptions

      public final CorsOptions getDefaultCorsPreflightOptions()
      Description copied from interface: ResourceOptions
      Adds a CORS preflight OPTIONS method to this resource and all child resources.

      You can add CORS at the resource-level using addCorsPreflight.

      Default: - CORS is disabled

      Specified by:
      getDefaultCorsPreflightOptions in interface ResourceOptions

    • getDefaultIntegration

      public final Integration getDefaultIntegration()
      Description copied from interface: ResourceOptions
      An integration to use as a default for all methods created within this API unless an integration is specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultIntegration in interface ResourceOptions

    • getDefaultMethodOptions

      public final MethodOptions getDefaultMethodOptions()
      Description copied from interface: ResourceOptions
      Method options to use as a default for all methods created within this API unless custom options are specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultMethodOptions in interface ResourceOptions

    • $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