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< ? routeSettings, Input<StageRouteSetting> ?>Map< ? stageVariables, Input<String, String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll})String, String> ?> -
Creates a new StageState.
accessLogSettingsSettings for logging access in this stage. Use theaws.apigateway.Accountresource to configure permissions for CloudWatch Logging.apiIdAPI identifier.arnARN of the stage.autoDeployWhether updates to an API automatically trigger a new deployment. Defaults tofalse. Applicable for HTTP APIs.clientCertificateIdIdentifier of a client certificate for the stage. Use theaws.apigateway.ClientCertificateresource to configure a client certificate. Supported only for WebSocket APIs.defaultRouteSettingsDefault route settings for the stage.deploymentIdDeployment identifier of the stage. Use theaws.apigatewayv2.Deploymentresource to configure a deployment.descriptionDescription for the stage. Must be less than or equal to 1024 characters in length.executionArnARN prefix to be used in anaws.lambda.Permission'ssourceArnattribute. For WebSocket APIs this attribute can additionally be used in anaws.iam.Policyto authorize access to the@connectionsAPI. See the Amazon API Gateway Developer Guide for details.invokeUrlURL to invoke the API pointing to the stage, e.g.,wss://z4675bid1j.execute-api.eu-west-2.amazonaws.com/example-stage, orhttps://z4675bid1j.execute-api.eu-west-2.amazonaws.com/nameName of the stage. Must be between 1 and 128 characters in length.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.routeSettingsRoute settings for the stage.stageVariablesMap that defines the stage variables for the stage.tagsMap of tags to assign to the stage. 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.const -
StageState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
accessLogSettings
→ Input<
StageAccessLogSettings?> ? -
Settings for logging access in this stage. Use the
aws.apigateway.Accountresource 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.ClientCertificateresource 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.Deploymentresource 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'ssourceArnattribute. For WebSocket APIs this attribute can additionally be used in anaws.iam.Policyto authorize access to the@connectionsAPI. 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, orhttps://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
-
Map of tags to assign to the stage. 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
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