/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace NetworkFirewall { namespace Model { /** */ class UpdateFirewallPolicyRequest : public NetworkFirewallRequest { public: AWS_NETWORKFIREWALL_API UpdateFirewallPolicyRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateFirewallPolicy"; } AWS_NETWORKFIREWALL_API Aws::String SerializePayload() const override; AWS_NETWORKFIREWALL_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::String& GetUpdateToken() const{ return m_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.

*/ inline bool UpdateTokenHasBeenSet() const { return m_updateTokenHasBeenSet; } /** *

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.

*/ inline void SetUpdateToken(const Aws::String& value) { m_updateTokenHasBeenSet = true; m_updateToken = value; } /** *

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.

*/ inline void SetUpdateToken(Aws::String&& value) { m_updateTokenHasBeenSet = true; m_updateToken = std::move(value); } /** *

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.

*/ inline void SetUpdateToken(const char* value) { m_updateTokenHasBeenSet = true; m_updateToken.assign(value); } /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithUpdateToken(const Aws::String& value) { SetUpdateToken(value); return *this;} /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithUpdateToken(Aws::String&& value) { SetUpdateToken(std::move(value)); return *this;} /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithUpdateToken(const char* value) { SetUpdateToken(value); return *this;} /** *

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

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

*/ inline const Aws::String& GetFirewallPolicyArn() const{ return m_firewallPolicyArn; } /** *

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

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

*/ inline bool FirewallPolicyArnHasBeenSet() const { return m_firewallPolicyArnHasBeenSet; } /** *

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

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

*/ inline void SetFirewallPolicyArn(const Aws::String& value) { m_firewallPolicyArnHasBeenSet = true; m_firewallPolicyArn = value; } /** *

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

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

*/ inline void SetFirewallPolicyArn(Aws::String&& value) { m_firewallPolicyArnHasBeenSet = true; m_firewallPolicyArn = std::move(value); } /** *

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

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

*/ inline void SetFirewallPolicyArn(const char* value) { m_firewallPolicyArnHasBeenSet = true; m_firewallPolicyArn.assign(value); } /** *

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

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

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyArn(const Aws::String& value) { SetFirewallPolicyArn(value); return *this;} /** *

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

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

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyArn(Aws::String&& value) { SetFirewallPolicyArn(std::move(value)); return *this;} /** *

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

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

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyArn(const char* value) { SetFirewallPolicyArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetFirewallPolicyName() const{ return m_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.

*/ inline bool FirewallPolicyNameHasBeenSet() const { return m_firewallPolicyNameHasBeenSet; } /** *

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.

*/ inline void SetFirewallPolicyName(const Aws::String& value) { m_firewallPolicyNameHasBeenSet = true; m_firewallPolicyName = value; } /** *

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.

*/ inline void SetFirewallPolicyName(Aws::String&& value) { m_firewallPolicyNameHasBeenSet = true; m_firewallPolicyName = std::move(value); } /** *

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.

*/ inline void SetFirewallPolicyName(const char* value) { m_firewallPolicyNameHasBeenSet = true; m_firewallPolicyName.assign(value); } /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyName(const Aws::String& value) { SetFirewallPolicyName(value); return *this;} /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyName(Aws::String&& value) { SetFirewallPolicyName(std::move(value)); return *this;} /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicyName(const char* value) { SetFirewallPolicyName(value); return *this;} /** *

The updated firewall policy to use for the firewall.

*/ inline const FirewallPolicy& GetFirewallPolicy() const{ return m_firewallPolicy; } /** *

The updated firewall policy to use for the firewall.

*/ inline bool FirewallPolicyHasBeenSet() const { return m_firewallPolicyHasBeenSet; } /** *

The updated firewall policy to use for the firewall.

*/ inline void SetFirewallPolicy(const FirewallPolicy& value) { m_firewallPolicyHasBeenSet = true; m_firewallPolicy = value; } /** *

The updated firewall policy to use for the firewall.

*/ inline void SetFirewallPolicy(FirewallPolicy&& value) { m_firewallPolicyHasBeenSet = true; m_firewallPolicy = std::move(value); } /** *

The updated firewall policy to use for the firewall.

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicy(const FirewallPolicy& value) { SetFirewallPolicy(value); return *this;} /** *

The updated firewall policy to use for the firewall.

*/ inline UpdateFirewallPolicyRequest& WithFirewallPolicy(FirewallPolicy&& value) { SetFirewallPolicy(std::move(value)); return *this;} /** *

A description of the firewall policy.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description of the firewall policy.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description of the firewall policy.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description of the firewall policy.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description of the firewall policy.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description of the firewall policy.

*/ inline UpdateFirewallPolicyRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of the firewall policy.

*/ inline UpdateFirewallPolicyRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description of the firewall policy.

*/ inline UpdateFirewallPolicyRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

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.

*/ inline bool GetDryRun() const{ return m_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.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

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.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

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.

*/ inline UpdateFirewallPolicyRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

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

*/ inline const EncryptionConfiguration& GetEncryptionConfiguration() const{ return m_encryptionConfiguration; } /** *

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

*/ inline bool EncryptionConfigurationHasBeenSet() const { return m_encryptionConfigurationHasBeenSet; } /** *

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

*/ inline void SetEncryptionConfiguration(const EncryptionConfiguration& value) { m_encryptionConfigurationHasBeenSet = true; m_encryptionConfiguration = value; } /** *

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

*/ inline void SetEncryptionConfiguration(EncryptionConfiguration&& value) { m_encryptionConfigurationHasBeenSet = true; m_encryptionConfiguration = std::move(value); } /** *

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

*/ inline UpdateFirewallPolicyRequest& WithEncryptionConfiguration(const EncryptionConfiguration& value) { SetEncryptionConfiguration(value); return *this;} /** *

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

*/ inline UpdateFirewallPolicyRequest& WithEncryptionConfiguration(EncryptionConfiguration&& value) { SetEncryptionConfiguration(std::move(value)); return *this;} private: Aws::String m_updateToken; bool m_updateTokenHasBeenSet = false; Aws::String m_firewallPolicyArn; bool m_firewallPolicyArnHasBeenSet = false; Aws::String m_firewallPolicyName; bool m_firewallPolicyNameHasBeenSet = false; FirewallPolicy m_firewallPolicy; bool m_firewallPolicyHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; EncryptionConfiguration m_encryptionConfiguration; bool m_encryptionConfigurationHasBeenSet = false; }; } // namespace Model } // namespace NetworkFirewall } // namespace Aws