Update Firewall Encryption Configuration

networkfirewall_update_firewall_encryption_configuration

R Documentation

A complex type that contains settings for encryption of your firewall resources¶

Description¶

A complex type that contains settings for encryption of your firewall resources.

Usage¶

networkfirewall_update_firewall_encryption_configuration(UpdateToken,
  FirewallArn, FirewallName, EncryptionConfiguration)

Arguments¶

UpdateToken

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

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

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

FirewallName

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

EncryptionConfiguration

A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.

Value¶

A list with the following syntax:

list(
  FirewallArn = "string",
  FirewallName = "string",
  UpdateToken = "string",
  EncryptionConfiguration = list(
    KeyId = "string",
    Type = "CUSTOMER_KMS"|"AWS_OWNED_KMS_KEY"
  )
)

Request syntax¶

svc$update_firewall_encryption_configuration(
  UpdateToken = "string",
  FirewallArn = "string",
  FirewallName = "string",
  EncryptionConfiguration = list(
    KeyId = "string",
    Type = "CUSTOMER_KMS"|"AWS_OWNED_KMS_KEY"
  )
)