StageState class
Input properties used for looking up and filtering Stage resources.
Constructors
-
StageState({Input<
StageAccessLogSettings?> ? accessLogSettings, Input<String?> ? arn, Input<bool?> ? cacheClusterEnabled, Input<String?> ? cacheClusterSize, Input<StageCanarySettings?> ? canarySettings, Input<String?> ? clientCertificateId, Input? deployment, Input<String?> ? description, Input<String?> ? documentationVersion, Input<String?> ? executionArn, Input<String?> ? invokeUrl, Input<String?> ? region, Input? restApi, Input<String?> ? stageName, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>Map< ? variables, Input<String, String> ?>String?> ? webAclArn, Input<bool?> ? xrayTracingEnabled}) -
Creates a new StageState.
accessLogSettingsEnables access logs for the API stage. See Access Log Settings below.arnARNcacheClusterEnabledWhether a cache cluster is enabled for the stagecacheClusterSizeSize of the cache cluster for the stage, if enabled. Allowed values include0.5,1.6,6.1,13.5,28.4,58.2,118and237.canarySettingsConfiguration settings of a canary deployment. See Canary Settings below.clientCertificateIdIdentifier of a client certificate for the stage.deploymentID of the deployment that the stage points todescriptionDescription of the stage.documentationVersionVersion of the associated API documentation.executionArnExecution ARN to be used inlambdaPermission'ssourceArnwhen allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prodinvokeUrlURL to invoke the API pointing to the stage, e.g.,https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prodregionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.restApiID of the associated REST APIstageNameName of the stagetagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.variablesMap that defines the stage variables.webAclArnARN of the WebAcl associated with the Stage.xrayTracingEnabledWhether active tracing with X-ray is enabled. Defaults tofalse.const -
StageState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accessLogSettings
→ Input<
StageAccessLogSettings?> ? -
Enables access logs for the API stage. See Access Log Settings below.
final
-
arn
→ Input<
String?> ? -
ARN
final
-
cacheClusterEnabled
→ Input<
bool?> ? -
Whether a cache cluster is enabled for the stage
final
-
cacheClusterSize
→ Input<
String?> ? -
Size of the cache cluster for the stage, if enabled. Allowed values include
0.5,1.6,6.1,13.5,28.4,58.2,118and237.final -
canarySettings
→ Input<
StageCanarySettings?> ? -
Configuration settings of a canary deployment. See Canary Settings below.
final
-
clientCertificateId
→ Input<
String?> ? -
Identifier of a client certificate for the stage.
final
- deployment → Input?
-
ID of the deployment that the stage points to
final
-
description
→ Input<
String?> ? -
Description of the stage.
final
-
documentationVersion
→ Input<
String?> ? -
Version of the associated API documentation.
final
-
executionArn
→ Input<
String?> ? -
Execution ARN to be used in
lambdaPermission'ssourceArnwhen allowing API Gateway to invoke a Lambda function, e.g.,arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prodfinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
invokeUrl
→ Input<
String?> ? -
URL to invoke the API pointing to the stage, e.g.,
https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prodfinal -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- restApi → Input?
-
ID of the associated REST API
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stageName
→ Input<
String?> ? -
Name of the stage
final
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
variables
→ Input<
Map< ?String, String> ?> -
Map that defines the stage variables.
final
-
webAclArn
→ Input<
String?> ? -
ARN of the WebAcl associated with the Stage.
final
-
xrayTracingEnabled
→ Input<
bool?> ? -
Whether active tracing with X-ray is enabled. Defaults to
false.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited