com.amazonaws.services.networkfirewall.model.CreateFirewallRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-networkfirewall Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.networkfirewall.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFirewallRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*/
private String firewallName;
/**
*
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*
*/
private String firewallPolicyArn;
/**
*
* The unique identifier of the VPC where Network Firewall should create the firewall.
*
*
* You can't change this setting after you create the firewall.
*
*/
private String vpcId;
/**
*
* 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.
*
*/
private java.util.List subnetMappings;
/**
*
* 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.
*
*/
private Boolean deleteProtection;
/**
*
* 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.
*
*/
private Boolean subnetChangeProtection;
/**
*
* 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.
*
*/
private Boolean firewallPolicyChangeProtection;
/**
*
* A description of the firewall.
*
*/
private String description;
/**
*
* The key:value pairs to associate with the resource.
*
*/
private java.util.List tags;
/**
*
* A complex type that contains settings for encryption of your firewall resources.
*
*/
private EncryptionConfiguration encryptionConfiguration;
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* @param firewallName
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*/
public void setFirewallName(String firewallName) {
this.firewallName = firewallName;
}
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* @return The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*/
public String getFirewallName() {
return this.firewallName;
}
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* @param firewallName
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withFirewallName(String firewallName) {
setFirewallName(firewallName);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*
*
* @param firewallPolicyArn
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*/
public void setFirewallPolicyArn(String firewallPolicyArn) {
this.firewallPolicyArn = firewallPolicyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*
*
* @return The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*/
public String getFirewallPolicyArn() {
return this.firewallPolicyArn;
}
/**
*
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
*
*
* @param firewallPolicyArn
* The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withFirewallPolicyArn(String firewallPolicyArn) {
setFirewallPolicyArn(firewallPolicyArn);
return this;
}
/**
*
* The unique identifier of the VPC where Network Firewall should create the firewall.
*
*
* You can't change this setting after you create the firewall.
*
*
* @param 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.
*/
public void setVpcId(String vpcId) {
this.vpcId = 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.
*
*
* @return The unique identifier of the VPC where Network Firewall should create the firewall.
*
* You can't change this setting after you create the firewall.
*/
public String getVpcId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withVpcId(String vpcId) {
setVpcId(vpcId);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getSubnetMappings() {
return 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.
*
*
* @param 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.
*/
public void setSubnetMappings(java.util.Collection subnetMappings) {
if (subnetMappings == null) {
this.subnetMappings = null;
return;
}
this.subnetMappings = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSubnetMappings(java.util.Collection)} or {@link #withSubnetMappings(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withSubnetMappings(SubnetMapping... subnetMappings) {
if (this.subnetMappings == null) {
setSubnetMappings(new java.util.ArrayList(subnetMappings.length));
}
for (SubnetMapping ele : subnetMappings) {
this.subnetMappings.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withSubnetMappings(java.util.Collection subnetMappings) {
setSubnetMappings(subnetMappings);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDeleteProtection(Boolean deleteProtection) {
this.deleteProtection = 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.
*
*
* @return 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.
*/
public Boolean getDeleteProtection() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withDeleteProtection(Boolean deleteProtection) {
setDeleteProtection(deleteProtection);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isDeleteProtection() {
return this.deleteProtection;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setSubnetChangeProtection(Boolean subnetChangeProtection) {
this.subnetChangeProtection = 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.
*
*
* @return 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.
*/
public Boolean getSubnetChangeProtection() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withSubnetChangeProtection(Boolean subnetChangeProtection) {
setSubnetChangeProtection(subnetChangeProtection);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isSubnetChangeProtection() {
return this.subnetChangeProtection;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setFirewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection) {
this.firewallPolicyChangeProtection = 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.
*
*
* @return 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.
*/
public Boolean getFirewallPolicyChangeProtection() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withFirewallPolicyChangeProtection(Boolean firewallPolicyChangeProtection) {
setFirewallPolicyChangeProtection(firewallPolicyChangeProtection);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isFirewallPolicyChangeProtection() {
return this.firewallPolicyChangeProtection;
}
/**
*
* A description of the firewall.
*
*
* @param description
* A description of the firewall.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the firewall.
*
*
* @return A description of the firewall.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the firewall.
*
*
* @param description
* A description of the firewall.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The key:value pairs to associate with the resource.
*
*
* @return The key:value pairs to associate with the resource.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* The key:value pairs to associate with the resource.
*
*
* @param tags
* The key:value pairs to associate with the resource.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* The key:value pairs to associate with the resource.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* The key:value pairs to associate with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* The key:value pairs to associate with the resource.
*
*
* @param tags
* The key:value pairs to associate with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A complex type that contains settings for encryption of your firewall resources.
*
*
* @param encryptionConfiguration
* A complex type that contains settings for encryption of your firewall resources.
*/
public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) {
this.encryptionConfiguration = encryptionConfiguration;
}
/**
*
* A complex type that contains settings for encryption of your firewall resources.
*
*
* @return A complex type that contains settings for encryption of your firewall resources.
*/
public EncryptionConfiguration getEncryptionConfiguration() {
return this.encryptionConfiguration;
}
/**
*
* A complex type that contains settings for encryption of your firewall resources.
*
*
* @param encryptionConfiguration
* A complex type that contains settings for encryption of your firewall resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFirewallRequest withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) {
setEncryptionConfiguration(encryptionConfiguration);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFirewallName() != null)
sb.append("FirewallName: ").append(getFirewallName()).append(",");
if (getFirewallPolicyArn() != null)
sb.append("FirewallPolicyArn: ").append(getFirewallPolicyArn()).append(",");
if (getVpcId() != null)
sb.append("VpcId: ").append(getVpcId()).append(",");
if (getSubnetMappings() != null)
sb.append("SubnetMappings: ").append(getSubnetMappings()).append(",");
if (getDeleteProtection() != null)
sb.append("DeleteProtection: ").append(getDeleteProtection()).append(",");
if (getSubnetChangeProtection() != null)
sb.append("SubnetChangeProtection: ").append(getSubnetChangeProtection()).append(",");
if (getFirewallPolicyChangeProtection() != null)
sb.append("FirewallPolicyChangeProtection: ").append(getFirewallPolicyChangeProtection()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getEncryptionConfiguration() != null)
sb.append("EncryptionConfiguration: ").append(getEncryptionConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateFirewallRequest == false)
return false;
CreateFirewallRequest other = (CreateFirewallRequest) obj;
if (other.getFirewallName() == null ^ this.getFirewallName() == null)
return false;
if (other.getFirewallName() != null && other.getFirewallName().equals(this.getFirewallName()) == false)
return false;
if (other.getFirewallPolicyArn() == null ^ this.getFirewallPolicyArn() == null)
return false;
if (other.getFirewallPolicyArn() != null && other.getFirewallPolicyArn().equals(this.getFirewallPolicyArn()) == false)
return false;
if (other.getVpcId() == null ^ this.getVpcId() == null)
return false;
if (other.getVpcId() != null && other.getVpcId().equals(this.getVpcId()) == false)
return false;
if (other.getSubnetMappings() == null ^ this.getSubnetMappings() == null)
return false;
if (other.getSubnetMappings() != null && other.getSubnetMappings().equals(this.getSubnetMappings()) == false)
return false;
if (other.getDeleteProtection() == null ^ this.getDeleteProtection() == null)
return false;
if (other.getDeleteProtection() != null && other.getDeleteProtection().equals(this.getDeleteProtection()) == false)
return false;
if (other.getSubnetChangeProtection() == null ^ this.getSubnetChangeProtection() == null)
return false;
if (other.getSubnetChangeProtection() != null && other.getSubnetChangeProtection().equals(this.getSubnetChangeProtection()) == false)
return false;
if (other.getFirewallPolicyChangeProtection() == null ^ this.getFirewallPolicyChangeProtection() == null)
return false;
if (other.getFirewallPolicyChangeProtection() != null
&& other.getFirewallPolicyChangeProtection().equals(this.getFirewallPolicyChangeProtection()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getEncryptionConfiguration() == null ^ this.getEncryptionConfiguration() == null)
return false;
if (other.getEncryptionConfiguration() != null && other.getEncryptionConfiguration().equals(this.getEncryptionConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFirewallName() == null) ? 0 : getFirewallName().hashCode());
hashCode = prime * hashCode + ((getFirewallPolicyArn() == null) ? 0 : getFirewallPolicyArn().hashCode());
hashCode = prime * hashCode + ((getVpcId() == null) ? 0 : getVpcId().hashCode());
hashCode = prime * hashCode + ((getSubnetMappings() == null) ? 0 : getSubnetMappings().hashCode());
hashCode = prime * hashCode + ((getDeleteProtection() == null) ? 0 : getDeleteProtection().hashCode());
hashCode = prime * hashCode + ((getSubnetChangeProtection() == null) ? 0 : getSubnetChangeProtection().hashCode());
hashCode = prime * hashCode + ((getFirewallPolicyChangeProtection() == null) ? 0 : getFirewallPolicyChangeProtection().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getEncryptionConfiguration() == null) ? 0 : getEncryptionConfiguration().hashCode());
return hashCode;
}
@Override
public CreateFirewallRequest clone() {
return (CreateFirewallRequest) super.clone();
}
}