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<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<Map<String, String>?>? variables, Input<String?>? webAclArn, Input<bool?>? xrayTracingEnabled})
Creates a new StageState. accessLogSettings Enables access logs for the API stage. See Access Log Settings below. arn ARN cacheClusterEnabled Whether a cache cluster is enabled for the stage cacheClusterSize 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, 118 and 237. canarySettings Configuration settings of a canary deployment. See Canary Settings below. clientCertificateId Identifier of a client certificate for the stage. deployment ID of the deployment that the stage points to description Description of the stage. documentationVersion Version of the associated API documentation. executionArn Execution ARN to be used in lambdaPermission's sourceArn when allowing API Gateway to invoke a Lambda function, e.g., arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod invokeUrl URL to invoke the API pointing to the stage, e.g., https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod region Region where this resource will be managed. Defaults to the Region set in the provider configuration. restApi ID of the associated REST API stageName Name of the stage tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. variables Map that defines the stage variables. webAclArn ARN of the WebAcl associated with the Stage. xrayTracingEnabled Whether active tracing with X-ray is enabled. Defaults to false.
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, 118 and 237.
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's sourceArn when allowing API Gateway to invoke a Lambda function, e.g., arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod
final
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/prod
final
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
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration 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