Class StageProps.Jsii$Proxy
- All Implemented Interfaces:
MethodDeploymentOptions
,StageOptions
,StageProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
StageProps
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
ConstructorsModifierConstructorDescriptionprotected
Jsii$Proxy
(StageProps.Builder builder) Constructor that initializes the object based on literal property values passed by theStageProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final IAccessLogDestination
The CloudWatch Logs log group or Firehose delivery stream where to write access logs.final AccessLogFormat
A single line format of access logs of data, as specified by selected $content variables.final Boolean
Indicates whether cache clustering is enabled for the stage.final String
The stage's cache cluster size.final Boolean
Indicates whether the cached responses are encrypted.final Duration
Specifies the time to live (TTL), in seconds, for cached responses.final Boolean
Specifies whether responses should be cached and returned for requests.final String
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.final Boolean
Specifies whether data trace logging is enabled for this method.final Deployment
The deployment that this stage points to [disable-awslint:ref-via-interface].final String
A description of the purpose of the stage.final String
The version identifier of the API documentation snapshot.final MethodLoggingLevel
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.final Map<String,
MethodDeploymentOptions> Method deployment options for specific resources/methods.final Boolean
Specifies whether Amazon CloudWatch metrics are enabled for this method.final String
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).final Number
Specifies the throttling burst limit.final Number
Specifies the throttling rate limit.final Boolean
Specifies whether Amazon X-Ray tracing is enabled for this method.A map that defines the stage variables.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theStageProps.Builder
.
-
-
Method Details
-
getDeployment
Description copied from interface:StageProps
The deployment that this stage points to [disable-awslint:ref-via-interface].- Specified by:
getDeployment
in interfaceStageProps
-
getAccessLogDestination
Description copied from interface:StageOptions
The CloudWatch Logs log group or Firehose delivery stream where to write access logs.Default: - No destination
- Specified by:
getAccessLogDestination
in interfaceStageOptions
-
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 either
AccessLogFormat.contextRequestId()
orAccessLogFormat.contextExtendedRequestId()
.Default: - Common Log Format
- Specified by:
getAccessLogFormat
in interfaceStageOptions
- See Also:
-
getCacheClusterEnabled
Description copied from interface:StageOptions
Indicates whether cache clustering is enabled for the stage.Default: - Disabled for the stage.
- Specified by:
getCacheClusterEnabled
in interfaceStageOptions
-
getCacheClusterSize
Description copied from interface:StageOptions
The stage's cache cluster size.Default: 0.5
- Specified by:
getCacheClusterSize
in interfaceStageOptions
-
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 interfaceStageOptions
-
getDescription
Description copied from interface:StageOptions
A description of the purpose of the stage.Default: - No description.
- Specified by:
getDescription
in interfaceStageOptions
-
getDocumentationVersion
Description copied from interface:StageOptions
The version identifier of the API documentation snapshot.Default: - No documentation version.
- Specified by:
getDocumentationVersion
in interfaceStageOptions
-
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 interfaceStageOptions
-
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 interfaceStageOptions
-
getTracingEnabled
Description copied from interface:StageOptions
Specifies whether Amazon X-Ray tracing is enabled for this method.Default: false
- Specified by:
getTracingEnabled
in interfaceStageOptions
-
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 interfaceStageOptions
-
getCacheDataEncrypted
Description copied from interface:MethodDeploymentOptions
Indicates whether the cached responses are encrypted.Default: false
- Specified by:
getCacheDataEncrypted
in interfaceMethodDeploymentOptions
-
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 interfaceMethodDeploymentOptions
- See Also:
-
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 interfaceMethodDeploymentOptions
-
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 interfaceMethodDeploymentOptions
-
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 interfaceMethodDeploymentOptions
-
getMetricsEnabled
Description copied from interface:MethodDeploymentOptions
Specifies whether Amazon CloudWatch metrics are enabled for this method.Default: false
- Specified by:
getMetricsEnabled
in interfaceMethodDeploymentOptions
-
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 interfaceMethodDeploymentOptions
- See Also:
-
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 interfaceMethodDeploymentOptions
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-