Update Virtual Gateway

appmesh_update_virtual_gateway

R Documentation

Updates an existing virtual gateway in a specified service mesh

Description

Updates an existing virtual gateway in a specified service mesh.

Usage

appmesh_update_virtual_gateway(clientToken, meshName, meshOwner, spec,
  virtualGatewayName)

Arguments

clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

meshName

[required] The name of the service mesh that the virtual gateway resides in.

meshOwner

The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

spec

[required] The new virtual gateway specification to apply. This overwrites the existing data.

virtualGatewayName

[required] The name of the virtual gateway to update.

Value

A list with the following syntax:

list(
  virtualGateway = list(
    meshName = "string",
    metadata = list(
      arn = "string",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      meshOwner = "string",
      resourceOwner = "string",
      uid = "string",
      version = 123
    ),
    spec = list(
      backendDefaults = list(
        clientPolicy = list(
          tls = list(
            certificate = list(
              file = list(
                certificateChain = "string",
                privateKey = "string"
              ),
              sds = list(
                secretName = "string"
              )
            ),
            enforce = TRUE|FALSE,
            ports = list(
              123
            ),
            validation = list(
              subjectAlternativeNames = list(
                match = list(
                  exact = list(
                    "string"
                  )
                )
              ),
              trust = list(
                acm = list(
                  certificateAuthorityArns = list(
                    "string"
                  )
                ),
                file = list(
                  certificateChain = "string"
                ),
                sds = list(
                  secretName = "string"
                )
              )
            )
          )
        )
      ),
      listeners = list(
        list(
          connectionPool = list(
            grpc = list(
              maxRequests = 123
            ),
            http = list(
              maxConnections = 123,
              maxPendingRequests = 123
            ),
            http2 = list(
              maxRequests = 123
            )
          ),
          healthCheck = list(
            healthyThreshold = 123,
            intervalMillis = 123,
            path = "string",
            port = 123,
            protocol = "http"|"http2"|"grpc",
            timeoutMillis = 123,
            unhealthyThreshold = 123
          ),
          portMapping = list(
            port = 123,
            protocol = "http"|"http2"|"grpc"
          ),
          tls = list(
            certificate = list(
              acm = list(
                certificateArn = "string"
              ),
              file = list(
                certificateChain = "string",
                privateKey = "string"
              ),
              sds = list(
                secretName = "string"
              )
            ),
            mode = "STRICT"|"PERMISSIVE"|"DISABLED",
            validation = list(
              subjectAlternativeNames = list(
                match = list(
                  exact = list(
                    "string"
                  )
                )
              ),
              trust = list(
                file = list(
                  certificateChain = "string"
                ),
                sds = list(
                  secretName = "string"
                )
              )
            )
          )
        )
      ),
      logging = list(
        accessLog = list(
          file = list(
            format = list(
              json = list(
                list(
                  key = "string",
                  value = "string"
                )
              ),
              text = "string"
            ),
            path = "string"
          )
        )
      )
    ),
    status = list(
      status = "ACTIVE"|"INACTIVE"|"DELETED"
    ),
    virtualGatewayName = "string"
  )
)

Request syntax

svc$update_virtual_gateway(
  clientToken = "string",
  meshName = "string",
  meshOwner = "string",
  spec = list(
    backendDefaults = list(
      clientPolicy = list(
        tls = list(
          certificate = list(
            file = list(
              certificateChain = "string",
              privateKey = "string"
            ),
            sds = list(
              secretName = "string"
            )
          ),
          enforce = TRUE|FALSE,
          ports = list(
            123
          ),
          validation = list(
            subjectAlternativeNames = list(
              match = list(
                exact = list(
                  "string"
                )
              )
            ),
            trust = list(
              acm = list(
                certificateAuthorityArns = list(
                  "string"
                )
              ),
              file = list(
                certificateChain = "string"
              ),
              sds = list(
                secretName = "string"
              )
            )
          )
        )
      )
    ),
    listeners = list(
      list(
        connectionPool = list(
          grpc = list(
            maxRequests = 123
          ),
          http = list(
            maxConnections = 123,
            maxPendingRequests = 123
          ),
          http2 = list(
            maxRequests = 123
          )
        ),
        healthCheck = list(
          healthyThreshold = 123,
          intervalMillis = 123,
          path = "string",
          port = 123,
          protocol = "http"|"http2"|"grpc",
          timeoutMillis = 123,
          unhealthyThreshold = 123
        ),
        portMapping = list(
          port = 123,
          protocol = "http"|"http2"|"grpc"
        ),
        tls = list(
          certificate = list(
            acm = list(
              certificateArn = "string"
            ),
            file = list(
              certificateChain = "string",
              privateKey = "string"
            ),
            sds = list(
              secretName = "string"
            )
          ),
          mode = "STRICT"|"PERMISSIVE"|"DISABLED",
          validation = list(
            subjectAlternativeNames = list(
              match = list(
                exact = list(
                  "string"
                )
              )
            ),
            trust = list(
              file = list(
                certificateChain = "string"
              ),
              sds = list(
                secretName = "string"
              )
            )
          )
        )
      )
    ),
    logging = list(
      accessLog = list(
        file = list(
          format = list(
            json = list(
              list(
                key = "string",
                value = "string"
              )
            ),
            text = "string"
          ),
          path = "string"
        )
      )
    )
  ),
  virtualGatewayName = "string"
)