StageState class

Input properties used for looking up and filtering Stage resources.

Constructors

StageState({Input<StageAccessLogSettings?>? accessLogSettings, Input<String?>? apiId, Input<String?>? arn, Input<bool?>? autoDeploy, Input<String?>? clientCertificateId, Input<StageDefaultRouteSettings?>? defaultRouteSettings, Input<String?>? deploymentId, Input<String?>? description, Input<String?>? executionArn, Input<String?>? invokeUrl, Input<String?>? name, Input<String?>? region, Input<List<StageRouteSetting>?>? routeSettings, Input<Map<String, String>?>? stageVariables, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll})
Creates a new StageState. accessLogSettings Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging. apiId API identifier. arn ARN of the stage. autoDeploy Whether updates to an API automatically trigger a new deployment. Defaults to false. Applicable for HTTP APIs. clientCertificateId Identifier of a client certificate for the stage. Use the aws.apigateway.ClientCertificate resource to configure a client certificate. Supported only for WebSocket APIs. defaultRouteSettings Default route settings for the stage. deploymentId Deployment identifier of the stage. Use the aws.apigatewayv2.Deployment resource to configure a deployment. description Description for the stage. Must be less than or equal to 1024 characters in length. executionArn ARN prefix to be used in an aws.lambda.Permission's sourceArn attribute. For WebSocket APIs this attribute can additionally be used in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details. invokeUrl URL to invoke the API pointing to the stage, e.g., wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage, or https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/ name Name of the stage. Must be between 1 and 128 characters in length. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. routeSettings Route settings for the stage. stageVariables Map that defines the stage variables for the stage. tags Map of tags to assign to the stage. 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.
const
StageState.fromMap(Map<String, dynamic> map)
factory

Properties

accessLogSettings → Input<StageAccessLogSettings?>?
Settings for logging access in this stage. Use the aws.apigateway.Account resource to configure permissions for CloudWatch Logging.
final
apiId → Input<String?>?
API identifier.
final
arn → Input<String?>?
ARN of the stage.
final
autoDeploy → Input<bool?>?
Whether updates to an API automatically trigger a new deployment. Defaults to false. Applicable for HTTP APIs.
final
clientCertificateId → Input<String?>?
Identifier of a client certificate for the stage. Use the aws.apigateway.ClientCertificate resource to configure a client certificate. Supported only for WebSocket APIs.
final
defaultRouteSettings → Input<StageDefaultRouteSettings?>?
Default route settings for the stage.
final
deploymentId → Input<String?>?
Deployment identifier of the stage. Use the aws.apigatewayv2.Deployment resource to configure a deployment.
final
description → Input<String?>?
Description for the stage. Must be less than or equal to 1024 characters in length.
final
executionArn → Input<String?>?
ARN prefix to be used in an aws.lambda.Permission's sourceArn attribute. For WebSocket APIs this attribute can additionally be used in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.
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., wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage, or https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/
final
name → Input<String?>?
Name of the stage. Must be between 1 and 128 characters in length.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
routeSettings → Input<List<StageRouteSetting>?>?
Route settings for the stage.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageVariables → Input<Map<String, String>?>?
Map that defines the stage variables for the stage.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the stage. 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

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