StageState constructor
- 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,String, String> ?> - Input<
Map< ? tagsAll,String, String> ?> - Input<
Map< ? variables,String, String> ?> - 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.
Implementation
const StageState({
this.accessLogSettings,
this.arn,
this.cacheClusterEnabled,
this.cacheClusterSize,
this.canarySettings,
this.clientCertificateId,
this.deployment,
this.description,
this.documentationVersion,
this.executionArn,
this.invokeUrl,
this.region,
this.restApi,
this.stageName,
this.tags,
this.tagsAll,
this.variables,
this.webAclArn,
this.xrayTracingEnabled,
});