Create Stage

apigatewayv2_create_stage

R Documentation

Creates a Stage for an API

Description

Creates a Stage for an API.

Usage

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

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. Supported only for WebSocket APIs.
DefaultRouteSettings	The default route settings for the stage.
DeploymentId	The deployment identifier of the API stage.
Description	The description for the API stage.
RouteSettings	Route settings for the stage, by routeKey.
StageName	[required] The name of the stage.
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-._~:/?#&=,]+.
Tags	The collection of tags. Each tag element is associated with a given resource.

Value

A list with the following syntax:

list(
  AccessLogSettings = list(
    DestinationArn = "string",
    Format = "string"
  ),
  ApiGatewayManaged = TRUE|FALSE,
  AutoDeploy = TRUE|FALSE,
  ClientCertificateId = "string",
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  DefaultRouteSettings = list(
    DataTraceEnabled = TRUE|FALSE,
    DetailedMetricsEnabled = TRUE|FALSE,
    LoggingLevel = "ERROR"|"INFO"|"OFF",
    ThrottlingBurstLimit = 123,
    ThrottlingRateLimit = 123.0
  ),
  DeploymentId = "string",
  Description = "string",
  LastDeploymentStatusMessage = "string",
  LastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  RouteSettings = list(
    list(
      DataTraceEnabled = TRUE|FALSE,
      DetailedMetricsEnabled = TRUE|FALSE,
      LoggingLevel = "ERROR"|"INFO"|"OFF",
      ThrottlingBurstLimit = 123,
      ThrottlingRateLimit = 123.0
    )
  ),
  StageName = "string",
  StageVariables = list(
    "string"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$create_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"|"OFF",
    ThrottlingBurstLimit = 123,
    ThrottlingRateLimit = 123.0
  ),
  DeploymentId = "string",
  Description = "string",
  RouteSettings = list(
    list(
      DataTraceEnabled = TRUE|FALSE,
      DetailedMetricsEnabled = TRUE|FALSE,
      LoggingLevel = "ERROR"|"INFO"|"OFF",
      ThrottlingBurstLimit = 123,
      ThrottlingRateLimit = 123.0
    )
  ),
  StageName = "string",
  StageVariables = list(
    "string"
  ),
  Tags = list(
    "string"
  )
)