Package software.amazon.awscdk.services.apigateway

Class CfnStageProps.Jsii$Proxy

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

  • 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(CfnStageProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnStageProps.Builder.

  • Method Details

    • getRestApiId

      public final String getRestApiId()
      Description copied from interface: CfnStageProps
      The string identifier of the associated RestApi.
      Specified by:
      getRestApiId in interface CfnStageProps

    • getAccessLogSetting

      public final Object getAccessLogSetting()
      Description copied from interface: CfnStageProps
      Access log settings, including the access log format and access log destination ARN.
      Specified by:
      getAccessLogSetting in interface CfnStageProps

    • getCacheClusterEnabled

      public final Object getCacheClusterEnabled()
      Description copied from interface: CfnStageProps
      Specifies whether a cache cluster is enabled for the stage.
      Specified by:
      getCacheClusterEnabled in interface CfnStageProps

    • getCacheClusterSize

      public final String getCacheClusterSize()
      Description copied from interface: CfnStageProps
      The stage's cache capacity in GB.

      For more information about choosing a cache size, see Enabling API caching to enhance responsiveness .

      Specified by:
      getCacheClusterSize in interface CfnStageProps

    • getCanarySetting

      public final Object getCanarySetting()
      Description copied from interface: CfnStageProps
      Settings for the canary deployment in this stage.
      Specified by:
      getCanarySetting in interface CfnStageProps

    • getClientCertificateId

      public final String getClientCertificateId()
      Description copied from interface: CfnStageProps
      The identifier of a client certificate for an API stage.
      Specified by:
      getClientCertificateId in interface CfnStageProps

    • getDeploymentId

      public final String getDeploymentId()
      Description copied from interface: CfnStageProps
      The identifier of the Deployment that the stage points to.
      Specified by:
      getDeploymentId in interface CfnStageProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnStageProps
      The stage's description.
      Specified by:
      getDescription in interface CfnStageProps

    • getDocumentationVersion

      public final String getDocumentationVersion()
      Description copied from interface: CfnStageProps
      The version of the associated API documentation.
      Specified by:
      getDocumentationVersion in interface CfnStageProps

    • getMethodSettings

      public final Object getMethodSettings()
      Description copied from interface: CfnStageProps
      A map that defines the method settings for a Stage resource.

      Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\* /\* for overriding all methods in the stage.

      Specified by:
      getMethodSettings in interface CfnStageProps

    • getStageName

      public final String getStageName()
      Description copied from interface: CfnStageProps
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.

      Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

      Specified by:
      getStageName in interface CfnStageProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnStageProps
      The collection of tags.

      Each tag element is associated with a given resource.

      Specified by:
      getTags in interface CfnStageProps

    • getTracingEnabled

      public final Object getTracingEnabled()
      Description copied from interface: CfnStageProps
      Specifies whether active tracing with X-ray is enabled for the Stage.
      Specified by:
      getTracingEnabled in interface CfnStageProps

    • getVariables

      public final Object getVariables()
      Description copied from interface: CfnStageProps
      A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value.

      Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+ .

      Specified by:
      getVariables in interface CfnStageProps

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