Class CreateFirewallRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateFirewallRequest.Builder,CreateFirewallRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal BooleanOptional.final List<AvailabilityZoneMapping> Required.builder()final BooleanA flag indicating whether it is possible to delete the firewall.final StringA description of the firewall.final List<EnabledAnalysisType> An optional setting indicating the specific traffic analysis types to enable on the firewall.An optional setting indicating the specific traffic analysis types to enable on the firewall.final EncryptionConfigurationA complex type that contains settings for encryption of your firewall resources.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe descriptive name of the firewall.final StringThe Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.final BooleanA setting indicating whether the firewall is protected against a change to the firewall policy association.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the AvailabilityZoneMappings property.final booleanFor responses, this returns true if the service returned a value for the EnabledAnalysisTypes property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the NatGatewayCreateMappings property.final booleanFor responses, this returns true if the service returned a value for the SubnetMappings property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final IgwFirewallConfigurationSettings that make this firewall an internet gateway firewall.final List<NatGatewayCreateMapping> The NAT gateways that Network Firewall creates for a proxy mode firewall, one for each Availability Zone.final ProxySettingsThe proxy settings for a proxy mode firewall: the ports and protocols on which the firewall's proxy listens for traffic, and optionally your own domain name and certificate.static Class<? extends CreateFirewallRequest.Builder> final BooleanA setting indicating whether the firewall is protected against changes to the subnet associations.final List<SubnetMapping> The public subnets to use for your Network Firewall firewalls.tags()The key:value pairs to associate with the resource.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final StringRequired when creating a transit gateway-attached firewall.How a proxy mode firewall handles traffic that isn't sent to its proxy listener.final StringHow a proxy mode firewall handles traffic that isn't sent to its proxy listener.final VpcEndpointThe VPC and subnets for the endpoints of a proxy mode firewall.final StringvpcId()The unique identifier of the VPC where Network Firewall should create the firewall.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
firewallName
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- Returns:
- The descriptive name of the firewall. You can't change the name of a firewall after you create it.
-
firewallPolicyArn
The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
- Returns:
- The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
-
vpcId
The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
- Returns:
- The unique identifier of the VPC where Network Firewall should create the firewall.
You can't change this setting after you create the firewall.
-
hasSubnetMappings
public final boolean hasSubnetMappings()For responses, this returns true if the service returned a value for the SubnetMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
subnetMappings
The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSubnetMappings()method.- Returns:
- The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.
-
deleteProtection
A flag indicating whether it is possible to delete the firewall. A setting of
TRUEindicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE.- Returns:
- A flag indicating whether it is possible to delete the firewall. A setting of
TRUEindicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE.
-
subnetChangeProtection
A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE.- Returns:
- A setting indicating whether the firewall is protected against changes to the subnet associations. Use
this setting to protect against accidentally modifying the subnet associations for a firewall that is in
use. When you create a firewall, the operation initializes this setting to
TRUE.
-
firewallPolicyChangeProtection
A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE.- Returns:
- A setting indicating whether the firewall is protected against a change to the firewall policy
association. Use this setting to protect against accidentally modifying the firewall policy for a
firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE.
-
description
A description of the firewall.
- Returns:
- A description of the firewall.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The key:value pairs to associate with the resource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The key:value pairs to associate with the resource.
-
encryptionConfiguration
A complex type that contains settings for encryption of your firewall resources.
- Returns:
- A complex type that contains settings for encryption of your firewall resources.
-
enabledAnalysisTypes
An optional setting indicating the specific traffic analysis types to enable on the firewall.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnabledAnalysisTypes()method.- Returns:
- An optional setting indicating the specific traffic analysis types to enable on the firewall.
-
hasEnabledAnalysisTypes
public final boolean hasEnabledAnalysisTypes()For responses, this returns true if the service returned a value for the EnabledAnalysisTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
enabledAnalysisTypesAsStrings
An optional setting indicating the specific traffic analysis types to enable on the firewall.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasEnabledAnalysisTypes()method.- Returns:
- An optional setting indicating the specific traffic analysis types to enable on the firewall.
-
transitGatewayId
Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through Resource Access Manager.
After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.
For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.
- Returns:
- Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway
to attach to this firewall. You can provide either a transit gateway from your account or one that has
been shared with you through Resource Access Manager.
After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.
For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.
-
hasAvailabilityZoneMappings
public final boolean hasAvailabilityZoneMappings()For responses, this returns true if the service returned a value for the AvailabilityZoneMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
availabilityZoneMappings
Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The
AvailabilityZoneChangeProtectionsetting controls whether you can make these modifications.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAvailabilityZoneMappings()method.- Returns:
- Required. The Availability Zones where you want to create firewall endpoints for a transit
gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the
firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.
You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The
AvailabilityZoneChangeProtectionsetting controls whether you can make these modifications.
-
availabilityZoneChangeProtection
Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to
TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.Default value:
FALSE- Returns:
- Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone
configuration. When set to
TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.Default value:
FALSE
-
igwFirewallConfiguration
Settings that make this firewall an internet gateway firewall. An internet gateway firewall inspects all traffic between a VPC and its internet gateway, without changes to your subnets or route tables. Amazon Web Services Network Security Manager creates and manages internet gateway firewalls on your behalf, so you don't include this setting when you create a standard Network Firewall firewall.
When this setting is present,
FirewallNamemust equal theVpcId,AvailabilityZoneMappingsis required and must use Availability Zone IDs, and you can't specifySubnetMappingsor a transit gateway.- Returns:
- Settings that make this firewall an internet gateway firewall. An internet gateway firewall inspects all
traffic between a VPC and its internet gateway, without changes to your subnets or route tables. Amazon
Web Services Network Security Manager creates and manages internet gateway firewalls on your behalf, so
you don't include this setting when you create a standard Network Firewall firewall.
When this setting is present,
FirewallNamemust equal theVpcId,AvailabilityZoneMappingsis required and must use Availability Zone IDs, and you can't specifySubnetMappingsor a transit gateway.
-
hasNatGatewayCreateMappings
public final boolean hasNatGatewayCreateMappings()For responses, this returns true if the service returned a value for the NatGatewayCreateMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
natGatewayCreateMappings
The NAT gateways that Network Firewall creates for a proxy mode firewall, one for each Availability Zone. When you specify this, you create a proxy mode firewall. Destinations see the IP address of the NAT gateway in the client's Availability Zone as the source of the traffic.
Specify one mapping for each Availability Zone in
VpcEndpoint, and no other Availability Zones. Each NAT gateway subnet must be in theVpcEndpointVPC and can't be one of the firewall endpoint subnets.You need permission to call the Amazon EC2
CreateNatGatewayaction.If Network Firewall can't set up an Availability Zone, for example because Amazon EC2 rejects the NAT gateway, it removes the Availability Zone from the firewall. It also deletes the NAT gateway that it created there. The Availability Zone's
Attachmentstatus isFAILED, and its status message explains why. You can add the Availability Zone again withAssociateSubnets. If no Availability Zone can be set up, the firewall status isFAILED.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasNatGatewayCreateMappings()method.- Returns:
- The NAT gateways that Network Firewall creates for a proxy mode firewall, one for each Availability Zone.
When you specify this, you create a proxy mode firewall. Destinations see the IP address of the NAT
gateway in the client's Availability Zone as the source of the traffic.
Specify one mapping for each Availability Zone in
VpcEndpoint, and no other Availability Zones. Each NAT gateway subnet must be in theVpcEndpointVPC and can't be one of the firewall endpoint subnets.You need permission to call the Amazon EC2
CreateNatGatewayaction.If Network Firewall can't set up an Availability Zone, for example because Amazon EC2 rejects the NAT gateway, it removes the Availability Zone from the firewall. It also deletes the NAT gateway that it created there. The Availability Zone's
Attachmentstatus isFAILED, and its status message explains why. You can add the Availability Zone again withAssociateSubnets. If no Availability Zone can be set up, the firewall status isFAILED.
-
proxySettings
The proxy settings for a proxy mode firewall: the ports and protocols on which the firewall's proxy listens for traffic, and optionally your own domain name and certificate. If you don't specify listeners, the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
To change the listeners later, use
UpdateProxySettings.- Returns:
- The proxy settings for a proxy mode firewall: the ports and protocols on which the firewall's proxy
listens for traffic, and optionally your own domain name and certificate. If you don't specify listeners,
the firewall listens for HTTP on port 3128 and HTTPS on port 8443.
To change the listeners later, use
UpdateProxySettings.
-
vpcEndpoint
The VPC and subnets for the endpoints of a proxy mode firewall. Network Firewall creates a firewall endpoint in each subnet that you specify. It also creates the firewall's NAT gateways in this VPC, in the subnets that you specify in
NatGatewayCreateMappings.To create a proxy mode firewall, you must specify
VpcEndpointandNatGatewayCreateMappings, and you must not specify the top-levelVpcIdandSubnetMappings. Specify one subnet for each Availability Zone where you want to use the firewall.- Returns:
- The VPC and subnets for the endpoints of a proxy mode firewall. Network Firewall creates a firewall
endpoint in each subnet that you specify. It also creates the firewall's NAT gateways in this VPC, in the
subnets that you specify in
NatGatewayCreateMappings.To create a proxy mode firewall, you must specify
VpcEndpointandNatGatewayCreateMappings, and you must not specify the top-levelVpcIdandSubnetMappings. Specify one subnet for each Availability Zone where you want to use the firewall.
-
transparentFilteringNatScope
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a value, the firewall uses
NAT_ALL. You can choose from the following values:-
NAT_ALL- After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address. -
NAT_NONE- After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
If the service returns an enum value that is not available in the current SDK version,
transparentFilteringNatScopewill returnTransparentFilteringNatScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtransparentFilteringNatScopeAsString().- Returns:
- How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a
value, the firewall uses
NAT_ALL. You can choose from the following values:-
NAT_ALL- After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address. -
NAT_NONE- After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
-
- See Also:
-
-
transparentFilteringNatScopeAsString
How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a value, the firewall uses
NAT_ALL. You can choose from the following values:-
NAT_ALL- After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address. -
NAT_NONE- After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
If the service returns an enum value that is not available in the current SDK version,
transparentFilteringNatScopewill returnTransparentFilteringNatScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtransparentFilteringNatScopeAsString().- Returns:
- How a proxy mode firewall handles traffic that isn't sent to its proxy listener. If you don't specify a
value, the firewall uses
NAT_ALL. You can choose from the following values:-
NAT_ALL- After inspection, the firewall sends this traffic out through its NAT gateway, which translates the source address. -
NAT_NONE- After inspection, the firewall returns this traffic to the firewall endpoint without address translation.
You can specify this only for a proxy mode firewall, and you can't change it after you create the firewall.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateFirewallRequest.Builder,CreateFirewallRequest> - Specified by:
toBuilderin classNetworkFirewallRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-