Skip to content

Update Proxy

networkfirewall_update_proxy R Documentation

Updates the properties of the specified proxy

Description

Updates the properties of the specified proxy.

Usage

networkfirewall_update_proxy(NatGatewayId, ProxyName, ProxyArn,
  ListenerPropertiesToAdd, ListenerPropertiesToRemove,
  TlsInterceptProperties, UpdateToken)

Arguments

NatGatewayId

[required] The NAT Gateway the proxy is attached to.

ProxyName

The descriptive name of the proxy. You can't change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

ProxyArn

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

ListenerPropertiesToAdd

Listener properties for HTTP and HTTPS traffic to add.

ListenerPropertiesToRemove

Listener properties for HTTP and HTTPS traffic to remove.

TlsInterceptProperties

TLS decryption on traffic to filter on attributes in the HTTP header.

UpdateToken

[required] A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Value

A list with the following syntax:

list(
  Proxy = list(
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    DeleteTime = as.POSIXct(
      "2015-01-01"
    ),
    UpdateTime = as.POSIXct(
      "2015-01-01"
    ),
    FailureCode = "string",
    FailureMessage = "string",
    ProxyState = "ATTACHING"|"ATTACHED"|"DETACHING"|"DETACHED"|"ATTACH_FAILED"|"DETACH_FAILED",
    ProxyModifyState = "MODIFYING"|"COMPLETED"|"FAILED",
    NatGatewayId = "string",
    ProxyConfigurationName = "string",
    ProxyConfigurationArn = "string",
    ProxyName = "string",
    ProxyArn = "string",
    ListenerProperties = list(
      list(
        Port = 123,
        Type = "HTTP"|"HTTPS"
      )
    ),
    TlsInterceptProperties = list(
      PcaArn = "string",
      TlsInterceptMode = "ENABLED"|"DISABLED"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  ),
  UpdateToken = "string"
)

Request syntax

svc$update_proxy(
  NatGatewayId = "string",
  ProxyName = "string",
  ProxyArn = "string",
  ListenerPropertiesToAdd = list(
    list(
      Port = 123,
      Type = "HTTP"|"HTTPS"
    )
  ),
  ListenerPropertiesToRemove = list(
    list(
      Port = 123,
      Type = "HTTP"|"HTTPS"
    )
  ),
  TlsInterceptProperties = list(
    PcaArn = "string",
    TlsInterceptMode = "ENABLED"|"DISABLED"
  ),
  UpdateToken = "string"
)