Creates a new Stage resource that references a pre-existing Deployment for the API¶

Description¶

Creates a new Stage resource that references a pre-existing Deployment for the API.

Usage¶

apigateway_create_stage(restApiId, stageName, deploymentId, description,
  cacheClusterEnabled, cacheClusterSize, variables, documentationVersion,
  canarySettings, tracingEnabled, tags)

Arguments¶

restApiId

[required] The string identifier of the associated RestApi.
stageName

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

[required] The identifier of the Deployment resource for the Stage resource.
description

The description of the Stage resource.
cacheClusterEnabled

Whether cache clustering is enabled for the stage.
cacheClusterSize

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
variables

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

The version of the associated API documentation.
canarySettings

The canary deployment settings of this stage.
tracingEnabled

Specifies whether active tracing with X-ray is enabled for the Stage.
tags

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Value¶

A list with the following syntax:

list(
  deploymentId = "string",
  clientCertificateId = "string",
  stageName = "string",
  description = "string",
  cacheClusterEnabled = TRUE|FALSE,
  cacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237",
  cacheClusterStatus = "CREATE_IN_PROGRESS"|"AVAILABLE"|"DELETE_IN_PROGRESS"|"NOT_AVAILABLE"|"FLUSH_IN_PROGRESS",
  methodSettings = list(
    list(
      metricsEnabled = TRUE|FALSE,
      loggingLevel = "string",
      dataTraceEnabled = TRUE|FALSE,
      throttlingBurstLimit = 123,
      throttlingRateLimit = 123.0,
      cachingEnabled = TRUE|FALSE,
      cacheTtlInSeconds = 123,
      cacheDataEncrypted = TRUE|FALSE,
      requireAuthorizationForCacheControl = TRUE|FALSE,
      unauthorizedCacheControlHeaderStrategy = "FAIL_WITH_403"|"SUCCEED_WITH_RESPONSE_HEADER"|"SUCCEED_WITHOUT_RESPONSE_HEADER"
    )
  ),
  variables = list(
    "string"
  ),
  documentationVersion = "string",
  accessLogSettings = list(
    format = "string",
    destinationArn = "string"
  ),
  canarySettings = list(
    percentTraffic = 123.0,
    deploymentId = "string",
    stageVariableOverrides = list(
      "string"
    ),
    useStageCache = TRUE|FALSE
  ),
  tracingEnabled = TRUE|FALSE,
  webAclArn = "string",
  tags = list(
    "string"
  ),
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDate = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_stage(
  restApiId = "string",
  stageName = "string",
  deploymentId = "string",
  description = "string",
  cacheClusterEnabled = TRUE|FALSE,
  cacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237",
  variables = list(
    "string"
  ),
  documentationVersion = "string",
  canarySettings = list(
    percentTraffic = 123.0,
    deploymentId = "string",
    stageVariableOverrides = list(
      "string"
    ),
    useStageCache = TRUE|FALSE
  ),
  tracingEnabled = TRUE|FALSE,
  tags = list(
    "string"
  )
)