paws.networking (version 0.1.6)

apigatewayv2_update_stage: Updates a Stage

Description

Updates a Stage.

Usage

apigatewayv2_update_stage(AccessLogSettings, ApiId, AutoDeploy,
  ClientCertificateId, DefaultRouteSettings, DeploymentId, Description,
  RouteSettings, StageName, StageVariables)

Arguments

AccessLogSettings

Settings for logging access in this stage.

ApiId

[required] The API identifier.

AutoDeploy

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

ClientCertificateId

The identifier of a client certificate for a Stage.

DefaultRouteSettings

The default route settings for the stage.

DeploymentId

The deployment identifier for the API stage. Can\'t be updated if autoDeploy is enabled.

Description

The description for the API stage.

RouteSettings

Route settings for the stage.

StageName

[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

StageVariables

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-.\_\~:/?\#&=,]+. Supported only for WebSocket APIs.

Request syntax

svc$update_stage(
  AccessLogSettings = list(
    DestinationArn = "string",
    Format = "string"
  ),
  ApiId = "string",
  AutoDeploy = TRUE|FALSE,
  ClientCertificateId = "string",
  DefaultRouteSettings = list(
    DataTraceEnabled = TRUE|FALSE,
    DetailedMetricsEnabled = TRUE|FALSE,
    LoggingLevel = "ERROR"|"INFO"|"false",
    ThrottlingBurstLimit = 123,
    ThrottlingRateLimit = 123.0
  ),
  DeploymentId = "string",
  Description = "string",
  RouteSettings = list(
    list(
      DataTraceEnabled = TRUE|FALSE,
      DetailedMetricsEnabled = TRUE|FALSE,
      LoggingLevel = "ERROR"|"INFO"|"false",
      ThrottlingBurstLimit = 123,
      ThrottlingRateLimit = 123.0
    )
  ),
  StageName = "string",
  StageVariables = list(
    "string"
  )
)