@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSNetworkFirewall extends Object implements AWSNetworkFirewall
AWSNetworkFirewall
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateFirewallPolicyResult |
associateFirewallPolicy(AssociateFirewallPolicyRequest request)
Associates a FirewallPolicy to a Firewall.
|
AssociateSubnetsResult |
associateSubnets(AssociateSubnetsRequest request)
Associates the specified subnets in the Amazon VPC to the firewall.
|
CreateFirewallResult |
createFirewall(CreateFirewallRequest request)
Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.
|
CreateFirewallPolicyResult |
createFirewallPolicy(CreateFirewallPolicyRequest request)
Creates the firewall policy for the firewall according to the specifications.
|
CreateRuleGroupResult |
createRuleGroup(CreateRuleGroupRequest request)
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection,
a capacity setting, and tags.
|
DeleteFirewallResult |
deleteFirewall(DeleteFirewallRequest request)
Deletes the specified Firewall and its FirewallStatus.
|
DeleteFirewallPolicyResult |
deleteFirewallPolicy(DeleteFirewallPolicyRequest request)
Deletes the specified FirewallPolicy.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a resource policy that you created in a PutResourcePolicy request.
|
DeleteRuleGroupResult |
deleteRuleGroup(DeleteRuleGroupRequest request)
Deletes the specified RuleGroup.
|
DescribeFirewallResult |
describeFirewall(DescribeFirewallRequest request)
Returns the data objects for the specified firewall.
|
DescribeFirewallPolicyResult |
describeFirewallPolicy(DescribeFirewallPolicyRequest request)
Returns the data objects for the specified firewall policy.
|
DescribeLoggingConfigurationResult |
describeLoggingConfiguration(DescribeLoggingConfigurationRequest request)
Returns the logging configuration for the specified firewall.
|
DescribeResourcePolicyResult |
describeResourcePolicy(DescribeResourcePolicyRequest request)
Retrieves a resource policy that you created in a PutResourcePolicy request.
|
DescribeRuleGroupResult |
describeRuleGroup(DescribeRuleGroupRequest request)
Returns the data objects for the specified rule group.
|
DisassociateSubnetsResult |
disassociateSubnets(DisassociateSubnetsRequest request)
Removes the specified subnet associations from the firewall.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListFirewallPoliciesResult |
listFirewallPolicies(ListFirewallPoliciesRequest request)
Retrieves the metadata for the firewall policies that you have defined.
|
ListFirewallsResult |
listFirewalls(ListFirewallsRequest request)
Retrieves the metadata for the firewalls that you have defined.
|
ListRuleGroupsResult |
listRuleGroups(ListRuleGroupsRequest request)
Retrieves the metadata for the rule groups that you have defined.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the tags associated with the specified resource.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the tags with the specified keys from the specified resource.
|
UpdateFirewallDeleteProtectionResult |
updateFirewallDeleteProtection(UpdateFirewallDeleteProtectionRequest request)
Modifies the flag,
DeleteProtection , which indicates whether it is possible to delete the firewall. |
UpdateFirewallDescriptionResult |
updateFirewallDescription(UpdateFirewallDescriptionRequest request)
Modifies the description for the specified firewall.
|
UpdateFirewallPolicyResult |
updateFirewallPolicy(UpdateFirewallPolicyRequest request)
Updates the properties of the specified firewall policy.
|
UpdateFirewallPolicyChangeProtectionResult |
updateFirewallPolicyChangeProtection(UpdateFirewallPolicyChangeProtectionRequest request)
|
UpdateLoggingConfigurationResult |
updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)
Sets the logging configuration for the specified firewall.
|
UpdateRuleGroupResult |
updateRuleGroup(UpdateRuleGroupRequest request)
Updates the rule settings for the specified rule group.
|
UpdateSubnetChangeProtectionResult |
updateSubnetChangeProtection(UpdateSubnetChangeProtectionRequest request)
|
public AssociateFirewallPolicyResult associateFirewallPolicy(AssociateFirewallPolicyRequest request)
AWSNetworkFirewall
Associates a FirewallPolicy to a Firewall.
A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection rule groups and other settings. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
associateFirewallPolicy
in interface AWSNetworkFirewall
public AssociateSubnetsResult associateSubnets(AssociateSubnetsRequest request)
AWSNetworkFirewall
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
associateSubnets
in interface AWSNetworkFirewall
public CreateFirewallResult createFirewall(CreateFirewallRequest request)
AWSNetworkFirewall
Creates an AWS Network Firewall Firewall and accompanying FirewallStatus for a VPC.
The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
After you create a firewall, you can provide additional settings, like the logging configuration.
To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
To manage a firewall's tags, use the standard AWS resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
createFirewall
in interface AWSNetworkFirewall
public CreateFirewallPolicyResult createFirewallPolicy(CreateFirewallPolicyRequest request)
AWSNetworkFirewall
Creates the firewall policy for the firewall according to the specifications.
An AWS Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
createFirewallPolicy
in interface AWSNetworkFirewall
public CreateRuleGroupResult createRuleGroup(CreateRuleGroupRequest request)
AWSNetworkFirewall
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
You provide your rule group specification in your request using either RuleGroup
or
Rules
.
createRuleGroup
in interface AWSNetworkFirewall
public DeleteFirewallResult deleteFirewall(DeleteFirewallRequest request)
AWSNetworkFirewall
Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's
DeleteProtection
flag to be FALSE
. You can't revert this operation.
You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.
To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.
deleteFirewall
in interface AWSNetworkFirewall
public DeleteFirewallPolicyResult deleteFirewallPolicy(DeleteFirewallPolicyRequest request)
AWSNetworkFirewall
Deletes the specified FirewallPolicy.
deleteFirewallPolicy
in interface AWSNetworkFirewall
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSNetworkFirewall
Deletes a resource policy that you created in a PutResourcePolicy request.
deleteResourcePolicy
in interface AWSNetworkFirewall
public DeleteRuleGroupResult deleteRuleGroup(DeleteRuleGroupRequest request)
AWSNetworkFirewall
Deletes the specified RuleGroup.
deleteRuleGroup
in interface AWSNetworkFirewall
public DescribeFirewallResult describeFirewall(DescribeFirewallRequest request)
AWSNetworkFirewall
Returns the data objects for the specified firewall.
describeFirewall
in interface AWSNetworkFirewall
public DescribeFirewallPolicyResult describeFirewallPolicy(DescribeFirewallPolicyRequest request)
AWSNetworkFirewall
Returns the data objects for the specified firewall policy.
describeFirewallPolicy
in interface AWSNetworkFirewall
public DescribeLoggingConfigurationResult describeLoggingConfiguration(DescribeLoggingConfigurationRequest request)
AWSNetworkFirewall
Returns the logging configuration for the specified firewall.
describeLoggingConfiguration
in interface AWSNetworkFirewall
public DescribeResourcePolicyResult describeResourcePolicy(DescribeResourcePolicyRequest request)
AWSNetworkFirewall
Retrieves a resource policy that you created in a PutResourcePolicy request.
describeResourcePolicy
in interface AWSNetworkFirewall
public DescribeRuleGroupResult describeRuleGroup(DescribeRuleGroupRequest request)
AWSNetworkFirewall
Returns the data objects for the specified rule group.
describeRuleGroup
in interface AWSNetworkFirewall
public DisassociateSubnetsResult disassociateSubnets(DisassociateSubnetsRequest request)
AWSNetworkFirewall
Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing.
disassociateSubnets
in interface AWSNetworkFirewall
public ListFirewallPoliciesResult listFirewallPolicies(ListFirewallPoliciesRequest request)
AWSNetworkFirewall
Retrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a single call might not return the full list.
listFirewallPolicies
in interface AWSNetworkFirewall
public ListFirewallsResult listFirewalls(ListFirewallsRequest request)
AWSNetworkFirewall
Retrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those VPCs.
Depending on your setting for max results and the number of firewalls, a single call might not return the full list.
listFirewalls
in interface AWSNetworkFirewall
public ListRuleGroupsResult listRuleGroups(ListRuleGroupsRequest request)
AWSNetworkFirewall
Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list.
listRuleGroups
in interface AWSNetworkFirewall
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSNetworkFirewall
Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
listTagsForResource
in interface AWSNetworkFirewall
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSNetworkFirewall
Creates or updates an AWS Identity and Access Management policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the AWS Resource Access Manager (RAM) service to manage resource sharing for Network Firewall.
Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
For additional information about resource sharing using RAM, see AWS Resource Access Manager User Guide.
putResourcePolicy
in interface AWSNetworkFirewall
public TagResourceResult tagResource(TagResourceRequest request)
AWSNetworkFirewall
Adds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
tagResource
in interface AWSNetworkFirewall
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSNetworkFirewall
Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
You can manage tags for the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups.
untagResource
in interface AWSNetworkFirewall
public UpdateFirewallDeleteProtectionResult updateFirewallDeleteProtection(UpdateFirewallDeleteProtectionRequest request)
AWSNetworkFirewall
Modifies the flag, DeleteProtection
, which indicates whether it is possible to delete the firewall.
If the flag is set to TRUE
, the firewall is protected against deletion. This setting helps protect
against accidentally deleting a firewall that's in use.
updateFirewallDeleteProtection
in interface AWSNetworkFirewall
public UpdateFirewallDescriptionResult updateFirewallDescription(UpdateFirewallDescriptionRequest request)
AWSNetworkFirewall
Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.
updateFirewallDescription
in interface AWSNetworkFirewall
public UpdateFirewallPolicyResult updateFirewallPolicy(UpdateFirewallPolicyRequest request)
AWSNetworkFirewall
Updates the properties of the specified firewall policy.
updateFirewallPolicy
in interface AWSNetworkFirewall
public UpdateFirewallPolicyChangeProtectionResult updateFirewallPolicyChangeProtection(UpdateFirewallPolicyChangeProtectionRequest request)
AWSNetworkFirewall
updateFirewallPolicyChangeProtection
in interface AWSNetworkFirewall
public UpdateLoggingConfigurationResult updateLoggingConfiguration(UpdateLoggingConfigurationRequest request)
AWSNetworkFirewall
Sets the logging configuration for the specified firewall.
To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide the modified object to this update call. You must change the logging configuration one LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
You can perform only one of the following actions in any call to UpdateLoggingConfiguration
:
Create a new log destination object by adding a single LogDestinationConfig
array element to
LogDestinationConfigs
.
Delete a log destination object by removing a single LogDestinationConfig
array element from
LogDestinationConfigs
.
Change the LogDestination
setting in a single LogDestinationConfig
array element.
You can't change the LogDestinationType
or LogType
in a
LogDestinationConfig
. To change these settings, delete the existing
LogDestinationConfig
object and create a new one, using two separate calls to this update operation.
updateLoggingConfiguration
in interface AWSNetworkFirewall
public UpdateRuleGroupResult updateRuleGroup(UpdateRuleGroupRequest request)
AWSNetworkFirewall
Updates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you modify all firewall policies that use the rule group.
To update a rule group, first call DescribeRuleGroup to retrieve the current RuleGroup object, update the object as needed, and then provide the updated object to this call.
updateRuleGroup
in interface AWSNetworkFirewall
public UpdateSubnetChangeProtectionResult updateSubnetChangeProtection(UpdateSubnetChangeProtectionRequest request)
AWSNetworkFirewall
updateSubnetChangeProtection
in interface AWSNetworkFirewall
public void shutdown()
AWSNetworkFirewall
shutdown
in interface AWSNetworkFirewall
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSNetworkFirewall
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSNetworkFirewall
request
- The originally executed request.