This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_apigatewayv2_stage

access_log_settings

Type: STRUCT
Provider name: AccessLogSettings
Description: Settings for logging access in this stage.

  • destination_arn
    Type: STRING
    Provider name: DestinationArn
    Description: The ARN of the CloudWatch Logs log group to receive access logs.
  • format
    Type: STRING
    Provider name: Format
    Description: A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

account_id

Type: STRING

api_gateway_managed

Type: BOOLEAN
Provider name: ApiGatewayManaged
Description: Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage.

auto_deploy

Type: BOOLEAN
Provider name: AutoDeploy
Description: Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

client_certificate_id

Type: STRING
Provider name: ClientCertificateId
Description: The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

created_date

Type: TIMESTAMP
Provider name: CreatedDate
Description: The timestamp when the stage was created.

default_route_settings

Type: STRUCT
Provider name: DefaultRouteSettings
Description: Default route settings for the stage.

  • data_trace_enabled
    Type: BOOLEAN
    Provider name: DataTraceEnabled
    Description: Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
  • detailed_metrics_enabled
    Type: BOOLEAN
    Provider name: DetailedMetricsEnabled
    Description: Specifies whether detailed metrics are enabled.
  • logging_level
    Type: STRING
    Provider name: LoggingLevel
    Description: Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
  • throttling_burst_limit
    Type: INT32
    Provider name: ThrottlingBurstLimit
    Description: Specifies the throttling burst limit.
  • throttling_rate_limit
    Type: DOUBLE
    Provider name: ThrottlingRateLimit
    Description: Specifies the throttling rate limit.

deployment_id

Type: STRING
Provider name: DeploymentId
Description: The identifier of the Deployment that the Stage is associated with. Can’t be updated if autoDeploy is enabled.

description

Type: STRING
Provider name: Description
Description: The description of the stage.

last_deployment_status_message

Type: STRING
Provider name: LastDeploymentStatusMessage
Description: Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

last_updated_date

Type: TIMESTAMP
Provider name: LastUpdatedDate
Description: The timestamp when the stage was last updated.

route_settings

Type: STRING
Provider name: RouteSettings
Description: Route settings for the stage, by routeKey.

stage_arn

Type: STRING

stage_name

Type: STRING
Provider name: StageName
Description: The name of the stage.

stage_variables

Type: MAP_STRING_STRING
Provider name: StageVariables
Description: A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

tags

Type: UNORDERED_LIST_STRING