UpdateFirewallEncryptionConfigurationCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkFirewallClient, UpdateFirewallEncryptionConfigurationCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
// const { NetworkFirewallClient, UpdateFirewallEncryptionConfigurationCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
const client = new NetworkFirewallClient(config);
const input = { // UpdateFirewallEncryptionConfigurationRequest
  UpdateToken: "STRING_VALUE",
  FirewallArn: "STRING_VALUE",
  FirewallName: "STRING_VALUE",
  EncryptionConfiguration: { // EncryptionConfiguration
    KeyId: "STRING_VALUE",
    Type: "CUSTOMER_KMS" || "AWS_OWNED_KMS_KEY", // required
  },
};
const command = new UpdateFirewallEncryptionConfigurationCommand(input);
const response = await client.send(command);
// { // UpdateFirewallEncryptionConfigurationResponse
//   FirewallArn: "STRING_VALUE",
//   FirewallName: "STRING_VALUE",
//   UpdateToken: "STRING_VALUE",
//   EncryptionConfiguration: { // EncryptionConfiguration
//     KeyId: "STRING_VALUE",
//     Type: "CUSTOMER_KMS" || "AWS_OWNED_KMS_KEY", // required
//   },
// };

UpdateFirewallEncryptionConfigurationCommand Input

See UpdateFirewallEncryptionConfigurationCommandInput for more details

Parameter
Type
Description
EncryptionConfiguration
EncryptionConfiguration | undefined

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.

FirewallArn
string | undefined

The Amazon Resource Name (ARN) of the firewall.

FirewallName
string | undefined

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

UpdateToken
string | undefined

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.

UpdateFirewallEncryptionConfigurationCommand Output

See UpdateFirewallEncryptionConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EncryptionConfiguration
EncryptionConfiguration | undefined

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.

FirewallArn
string | undefined

The Amazon Resource Name (ARN) of the firewall.

FirewallName
string | undefined

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

UpdateToken
string | undefined

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.

Throws

Name
Fault
Details
InternalServerError
server

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidRequestException
client

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

InvalidTokenException
client

The token you provided is stale or isn't valid for the operation.

ResourceNotFoundException
client

Unable to locate a resource using the parameters that you provided.

ResourceOwnerCheckException
client

Unable to change the resource because your account doesn't own it.

ThrottlingException
client

Unable to process the request due to throttling limitations.

NetworkFirewallServiceException
Base exception class for all service exceptions from NetworkFirewall service.