software.amazon.awssdk.services.networkfirewall.model

Class CreateFirewallRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest

software.amazon.awssdk.services.networkfirewall.model.CreateFirewallRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFirewallRequest.Builder,CreateFirewallRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFirewallRequest
extends NetworkFirewallRequest
implements ToCopyableBuilder<CreateFirewallRequest.Builder,CreateFirewallRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFirewallRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFirewallRequest.Builder	builder()
Boolean	deleteProtection() A flag indicating whether it is possible to delete the firewall.
String	description() A description of the firewall.
EncryptionConfiguration	encryptionConfiguration() A complex type that contains settings for encryption of your firewall resources.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firewallName() The descriptive name of the firewall.
String	firewallPolicyArn() The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
Boolean	firewallPolicyChangeProtection() A setting indicating whether the firewall is protected against a change to the firewall policy association.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetMappings() For responses, this returns true if the service returned a value for the SubnetMappings property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFirewallRequest.Builder>	serializableBuilderClass()
Boolean	subnetChangeProtection() A setting indicating whether the firewall is protected against changes to the subnet associations.
List<SubnetMapping>	subnetMappings() The public subnets to use for your Network Firewall firewalls.
List<Tag>	tags() The key:value pairs to associate with the resource.
CreateFirewallRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() The unique identifier of the VPC where Network Firewall should create the firewall.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

firewallName

public final String 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

public final String 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

public final String 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 the isEmpty() 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

public final List<SubnetMapping> 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

public final Boolean deleteProtection()

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates 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 to TRUE.

Returns:

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates 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 to TRUE.

subnetChangeProtection

public final Boolean 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

public final Boolean 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

public final String 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 the isEmpty() 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

public final List<Tag> 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

public final EncryptionConfiguration 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.

toBuilder

public CreateFirewallRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFirewallRequest.Builder,CreateFirewallRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static CreateFirewallRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFirewallRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo