apigateway_create_deployment: Creates a Deployment resource, which makes a specified...

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Usage

1
2
3
apigateway_create_deployment(restApiId, stageName, stageDescription,
  description, cacheClusterEnabled, cacheClusterSize, variables,
  canarySettings, tracingEnabled)

Arguments

restApiId

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

stageName

The name of the Stage resource for the Deployment resource to create.

stageDescription

The description of the Stage resource for the Deployment resource to create.

description

The description for the Deployment resource to create.

cacheClusterEnabled

Enables a cache cluster for the Stage resource specified in the input.

cacheClusterSize

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

variables

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

canarySettings

The input configuration for the canary deployment when the deployment is a canary release deployment.

tracingEnabled

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  id = "string",
  description = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  apiSummary = list(
    list(
      list(
        authorizationType = "string",
        apiKeyRequired = TRUE|FALSE
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
svc$create_deployment(
  restApiId = "string",
  stageName = "string",
  stageDescription = "string",
  description = "string",
  cacheClusterEnabled = TRUE|FALSE,
  cacheClusterSize = "0.5"|"1.6"|"6.1"|"13.5"|"28.4"|"58.2"|"118"|"237",
  variables = list(
    "string"
  ),
  canarySettings = list(
    percentTraffic = 123.0,
    stageVariableOverrides = list(
      "string"
    ),
    useStageCache = TRUE|FALSE
  ),
  tracingEnabled = TRUE|FALSE
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.