StageArgs class

The set of arguments for Stage. The set of arguments for Stage.

Constructors

StageArgs({Input<StageAccessLogSettings?>? accessLogSettings, Input<bool?>? cacheClusterEnabled, Input<String?>? cacheClusterSize, Input<StageCanarySettings?>? canarySettings, Input<String?>? clientCertificateId, required Input deployment, Input<String?>? description, Input<String?>? documentationVersion, Input<String?>? region, required Input restApi, required Input<String> stageName, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? variables, Input<bool?>? xrayTracingEnabled})
Creates a new StageArgs. accessLogSettings Enables access logs for the API stage. See Access Log Settings below. 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. 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. variables Map that defines the stage variables. xrayTracingEnabled Whether active tracing with X-ray is enabled. Defaults to false.
const
StageArgs.fromMap(Map<String, dynamic> map)
factory

Properties

accessLogSettings → Input<StageAccessLogSettings?>?
Enables access logs for the API stage. See Access Log Settings below.
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
hashCode → int
The hash code for this object.
no setterinherited
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
variables → Input<Map<String, String>?>?
Map that defines the stage variables.
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