Package software.amazon.awssdk.services.networkfirewall.model

Interface UpdateFirewallPolicyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateFirewallPolicyRequest.Builder,UpdateFirewallPolicyRequest>, NetworkFirewallRequest.Builder, SdkBuilder<UpdateFirewallPolicyRequest.Builder,UpdateFirewallPolicyRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateFirewallPolicyRequest
public static interface UpdateFirewallPolicyRequest.Builder extends NetworkFirewallRequest.Builder, SdkPojo, CopyableBuilder<UpdateFirewallPolicyRequest.Builder,UpdateFirewallPolicyRequest>

  • Method Details

    • updateToken

      UpdateFirewallPolicyRequest.Builder updateToken(String updateToken)

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

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

      Parameters:
      updateToken - A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicyArn

      UpdateFirewallPolicyRequest.Builder firewallPolicyArn(String firewallPolicyArn)

      The Amazon Resource Name (ARN) of the firewall policy.

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

      Parameters:
      firewallPolicyArn - The Amazon Resource Name (ARN) of the firewall policy.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicyName

      UpdateFirewallPolicyRequest.Builder firewallPolicyName(String firewallPolicyName)

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

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

      Parameters:
      firewallPolicyName - The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicy

      UpdateFirewallPolicyRequest.Builder firewallPolicy(FirewallPolicy firewallPolicy)

      The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

      Parameters:
      firewallPolicy - The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • firewallPolicy

      default UpdateFirewallPolicyRequest.Builder firewallPolicy(Consumer<FirewallPolicy.Builder> firewallPolicy)

      The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

      This is a convenience method that creates an instance of the FirewallPolicy.Builder avoiding the need to create one manually via FirewallPolicy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to firewallPolicy(FirewallPolicy).

      Parameters:
      firewallPolicy - a consumer that will call methods on FirewallPolicy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      UpdateFirewallPolicyRequest.Builder description(String description)

      A description of the firewall policy.

      Parameters:
      description - A description of the firewall policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      UpdateFirewallPolicyRequest.Builder dryRun(Boolean dryRun)

      Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

      If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

      If set to FALSE, Network Firewall makes the requested changes to your resources.

      Parameters:
      dryRun - Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.

      If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.

      If set to FALSE, Network Firewall makes the requested changes to your resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      UpdateFirewallPolicyRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

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

      Parameters:
      encryptionConfiguration - A complex type that contains settings for encryption of your firewall policy resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default UpdateFirewallPolicyRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

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

      This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

      Parameters:
      encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateFirewallPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateFirewallPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.