software.amazon.awssdk.services.networkfirewall.model

Class CreateFirewallPolicyRequest

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.CreateFirewallPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFirewallPolicyRequest.Builder,CreateFirewallPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFirewallPolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateFirewallPolicyRequest.Builder	builder()
String	description() A description of the firewall policy.
Boolean	dryRun() Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
EncryptionConfiguration	encryptionConfiguration() A complex type that contains settings for encryption of your firewall policy resources.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FirewallPolicy	firewallPolicy() The rule groups and policy actions to use in the firewall policy.
String	firewallPolicyName() The descriptive name of the firewall policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFirewallPolicyRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() The key:value pairs to associate with the resource.
CreateFirewallPolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

firewallPolicyName

public final String firewallPolicyName()

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

Returns:

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

firewallPolicy

public final FirewallPolicy firewallPolicy()

The rule groups and policy actions to use in the firewall policy.

Returns:

The rule groups and policy actions to use in the firewall policy.

description

public final String description()

A description of the firewall policy.

Returns:

A description of the firewall policy.

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.

dryRun

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

Returns:

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.

encryptionConfiguration

public final EncryptionConfiguration encryptionConfiguration()

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

Returns:

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

toBuilder

public CreateFirewallPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFirewallPolicyRequest.Builder,CreateFirewallPolicyRequest>

Specified by:

toBuilder in class NetworkFirewallRequest

builder

public static CreateFirewallPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFirewallPolicyRequest.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