StageProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.StageProps.Jsii$Proxy

All Implemented Interfaces:

MethodDeploymentOptions, StageOptions, StageProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

StageProps
```
@Stability(value=Stable)
 @Internal
public static final class StageProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements StageProps
```
An implementation for StageProps

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.StageProps
  StageProps.Builder, StageProps.Jsii$Proxy

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`IAccessLogDestination`	`getAccessLogDestination()` The CloudWatch Logs log group.
`AccessLogFormat`	`getAccessLogFormat()` A single line format of access logs of data, as specified by selected $content variables.
`Boolean`	`getCacheClusterEnabled()` Indicates whether cache clustering is enabled for the stage.
`String`	`getCacheClusterSize()` The stage's cache cluster size.
`Boolean`	`getCacheDataEncrypted()` Indicates whether the cached responses are encrypted.
`Duration`	`getCacheTtl()` Specifies the time to live (TTL), in seconds, for cached responses.
`Boolean`	`getCachingEnabled()` Specifies whether responses should be cached and returned for requests.
`String`	`getClientCertificateId()` The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
`Boolean`	`getDataTraceEnabled()` Specifies whether data trace logging is enabled for this method.
`Deployment`	`getDeployment()` The deployment that this stage points to [disable-awslint:ref-via-interface].
`String`	`getDescription()` A description of the purpose of the stage.
`String`	`getDocumentationVersion()` The version identifier of the API documentation snapshot.
`MethodLoggingLevel`	`getLoggingLevel()` Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
`Map<String,MethodDeploymentOptions>`	`getMethodOptions()` Method deployment options for specific resources/methods.
`Boolean`	`getMetricsEnabled()` Specifies whether Amazon CloudWatch metrics are enabled for this method.
`String`	`getStageName()` The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
`Number`	`getThrottlingBurstLimit()` Specifies the throttling burst limit.
`Number`	`getThrottlingRateLimit()` Specifies the throttling rate limit.
`Boolean`	`getTracingEnabled()` Specifies whether Amazon X-Ray tracing is enabled for this method.
`Map<String,String>`	`getVariables()` A map that defines the stage variables.
`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

Methods inherited from interface software.amazon.awscdk.services.apigateway.StageProps
builder

- Constructor Detail
  - 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(StageProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the StageProps.Builder.
- Method Detail
  - getDeployment
```
public final Deployment getDeployment()
```
    Description copied from interface: StageProps
    
    The deployment that this stage points to [disable-awslint:ref-via-interface].
    
    Specified by:
    
    getDeployment in interface StageProps
  - getAccessLogDestination
```
public final IAccessLogDestination getAccessLogDestination()
```
    Description copied from interface: StageOptions
    
    The CloudWatch Logs log group.
    Default: - No destination
    
    Specified by:
    
    getAccessLogDestination in interface StageOptions
  - getAccessLogFormat
```
public final AccessLogFormat getAccessLogFormat()
```
    Description copied from interface: StageOptions
    
    A single line format of access logs of data, as specified by selected $content variables.
    The format must include at least AccessLogFormat.contextRequestId().
    Default: - Common Log Format
    
    Specified by:
    
    getAccessLogFormat in interface StageOptions
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
  - getCacheClusterEnabled
```
public final Boolean getCacheClusterEnabled()
```
    Description copied from interface: StageOptions
    
    Indicates whether cache clustering is enabled for the stage.
    Default: - Disabled for the stage.
    
    Specified by:
    
    getCacheClusterEnabled in interface StageOptions
  - getCacheClusterSize
```
public final String getCacheClusterSize()
```
    Description copied from interface: StageOptions
    
    The stage's cache cluster size.
    Default: 0.5
    
    Specified by:
    
    getCacheClusterSize in interface StageOptions
  - getClientCertificateId
```
public final String getClientCertificateId()
```
    Description copied from interface: StageOptions
    
    The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
    Default: - None.
    
    Specified by:
    
    getClientCertificateId in interface StageOptions
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: StageOptions
    
    A description of the purpose of the stage.
    Default: - No description.
    
    Specified by:
    
    getDescription in interface StageOptions
  - getDocumentationVersion
```
public final String getDocumentationVersion()
```
    Description copied from interface: StageOptions
    
    The version identifier of the API documentation snapshot.
    Default: - No documentation version.
    
    Specified by:
    
    getDocumentationVersion in interface StageOptions
  - getMethodOptions
```
public final Map<String,MethodDeploymentOptions> getMethodOptions()
```
    Description copied from interface: StageOptions
    
    Method deployment options for specific resources/methods.
    These will override common options defined in StageOptions#methodOptions.
    Default: - Common options will be used.
    
    Specified by:
    
    getMethodOptions in interface StageOptions
  - getStageName
```
public final String getStageName()
```
    Description copied from interface: StageOptions
    
    The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
    Default: - "prod"
    
    Specified by:
    
    getStageName in interface StageOptions
  - getTracingEnabled
```
public final Boolean getTracingEnabled()
```
    Description copied from interface: StageOptions
    
    Specifies whether Amazon X-Ray tracing is enabled for this method.
    Default: false
    
    Specified by:
    
    getTracingEnabled in interface StageOptions
  - getVariables
```
public final Map<String,String> getVariables()
```
    Description copied from interface: StageOptions
    
    A map that defines the stage variables.
    Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
    Default: - No stage variables.
    
    Specified by:
    
    getVariables in interface StageOptions
  - getCacheDataEncrypted
```
public final Boolean getCacheDataEncrypted()
```
    Description copied from interface: MethodDeploymentOptions
    
    Indicates whether the cached responses are encrypted.
    Default: false
    
    Specified by:
    
    getCacheDataEncrypted in interface MethodDeploymentOptions
  - getCacheTtl
```
public final Duration getCacheTtl()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies the time to live (TTL), in seconds, for cached responses.
    The higher the TTL, the longer the response will be cached.
    Default: Duration.minutes(5)
    
    Specified by:
    
    getCacheTtl in interface MethodDeploymentOptions
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
  - getCachingEnabled
```
public final Boolean getCachingEnabled()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies whether responses should be cached and returned for requests.
    A cache cluster must be enabled on the stage for responses to be cached.
    Default: - Caching is Disabled.
    
    Specified by:
    
    getCachingEnabled in interface MethodDeploymentOptions
  - getDataTraceEnabled
```
public final Boolean getDataTraceEnabled()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies whether data trace logging is enabled for this method.
    When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.
    Default: false
    
    Specified by:
    
    getDataTraceEnabled in interface MethodDeploymentOptions
  - getLoggingLevel
```
public final MethodLoggingLevel getLoggingLevel()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
    Default: - Off
    
    Specified by:
    
    getLoggingLevel in interface MethodDeploymentOptions
  - getMetricsEnabled
```
public final Boolean getMetricsEnabled()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies whether Amazon CloudWatch metrics are enabled for this method.
    Default: false
    
    Specified by:
    
    getMetricsEnabled in interface MethodDeploymentOptions
  - getThrottlingBurstLimit
```
public final Number getThrottlingBurstLimit()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies the throttling burst limit.
    The total rate of all requests in your AWS account is limited to 5,000 requests.
    Default: - No additional restriction.
    
    Specified by:
    
    getThrottlingBurstLimit in interface MethodDeploymentOptions
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
  - getThrottlingRateLimit
```
public final Number getThrottlingRateLimit()
```
    Description copied from interface: MethodDeploymentOptions
    
    Specifies the throttling rate limit.
    The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
    Default: - No additional restriction.
    
    Specified by:
    
    getThrottlingRateLimit in interface MethodDeploymentOptions
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
  - $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

Class StageProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.apigateway.StageProps

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getDeployment

getAccessLogDestination

getAccessLogFormat

getCacheClusterEnabled

getCacheClusterSize

getClientCertificateId

getDescription

getDocumentationVersion

getMethodOptions

getStageName

getTracingEnabled

getVariables

getCacheDataEncrypted

getCacheTtl

getCachingEnabled

getDataTraceEnabled

getLoggingLevel

getMetricsEnabled

getThrottlingBurstLimit

getThrottlingRateLimit

$jsii$toJson

equals

hashCode