com.amazonaws.services.networkfirewall.model.FirewallStatus 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling
* DescribeFirewall and providing the firewall name and ARN.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class FirewallStatus implements Serializable, Cloneable, StructuredPojo {
/**
*
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones where
* you've configured it. This setting is READY only when the ConfigurationSyncStateSummary
* value is IN_SYNC and the Attachment Status values for all of the
* configured subnets are READY.
*
*/
private String status;
/**
*
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This
* summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the
* firewall is ready. The Status setting indicates firewall readiness.
*
*/
private String configurationSyncStateSummary;
/**
*
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per
* Availability Zone where you've configured a subnet. These objects provide details of the information that is
* summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and
* configuration object.
*
*/
private java.util.Map syncStates;
/**
*
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference
* sets in a firewall.
*
*/
private CapacityUsageSummary capacityUsageSummary;
/**
*
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones where
* you've configured it. This setting is READY only when the ConfigurationSyncStateSummary
* value is IN_SYNC and the Attachment Status values for all of the
* configured subnets are READY.
*
*
* @param status
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones
* where you've configured it. This setting is READY only when the
* ConfigurationSyncStateSummary value is IN_SYNC and the Attachment
* Status values for all of the configured subnets are READY.
* @see FirewallStatusValue
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones where
* you've configured it. This setting is READY only when the ConfigurationSyncStateSummary
* value is IN_SYNC and the Attachment Status values for all of the
* configured subnets are READY.
*
*
* @return The readiness of the configured firewall to handle network traffic across all of the Availability Zones
* where you've configured it. This setting is READY only when the
* ConfigurationSyncStateSummary value is IN_SYNC and the Attachment
* Status values for all of the configured subnets are READY.
* @see FirewallStatusValue
*/
public String getStatus() {
return this.status;
}
/**
*
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones where
* you've configured it. This setting is READY only when the ConfigurationSyncStateSummary
* value is IN_SYNC and the Attachment Status values for all of the
* configured subnets are READY.
*
*
* @param status
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones
* where you've configured it. This setting is READY only when the
* ConfigurationSyncStateSummary value is IN_SYNC and the Attachment
* Status values for all of the configured subnets are READY.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FirewallStatusValue
*/
public FirewallStatus withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones where
* you've configured it. This setting is READY only when the ConfigurationSyncStateSummary
* value is IN_SYNC and the Attachment Status values for all of the
* configured subnets are READY.
*
*
* @param status
* The readiness of the configured firewall to handle network traffic across all of the Availability Zones
* where you've configured it. This setting is READY only when the
* ConfigurationSyncStateSummary value is IN_SYNC and the Attachment
* Status values for all of the configured subnets are READY.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FirewallStatusValue
*/
public FirewallStatus withStatus(FirewallStatusValue status) {
this.status = status.toString();
return this;
}
/**
*
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This
* summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the
* firewall is ready. The Status setting indicates firewall readiness.
*
*
* @param configurationSyncStateSummary
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use.
* This summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate
* that the firewall is ready. The Status setting indicates firewall readiness.
* @see ConfigurationSyncState
*/
public void setConfigurationSyncStateSummary(String configurationSyncStateSummary) {
this.configurationSyncStateSummary = configurationSyncStateSummary;
}
/**
*
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This
* summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the
* firewall is ready. The Status setting indicates firewall readiness.
*
*
* @return The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its
* firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall
* is in use. This summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate
* that the firewall is ready. The Status setting indicates firewall readiness.
* @see ConfigurationSyncState
*/
public String getConfigurationSyncStateSummary() {
return this.configurationSyncStateSummary;
}
/**
*
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This
* summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the
* firewall is ready. The Status setting indicates firewall readiness.
*
*
* @param configurationSyncStateSummary
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use.
* This summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate
* that the firewall is ready. The Status setting indicates firewall readiness.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConfigurationSyncState
*/
public FirewallStatus withConfigurationSyncStateSummary(String configurationSyncStateSummary) {
setConfigurationSyncStateSummary(configurationSyncStateSummary);
return this;
}
/**
*
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This
* summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the
* firewall is ready. The Status setting indicates firewall readiness.
*
*
* @param configurationSyncStateSummary
* The configuration sync state for the firewall. This summarizes the sync states reported in the
* Config settings for all of the Availability Zones where you have configured the firewall.
*
*
* When you create a firewall or update its configuration, for example by adding a rule group to its firewall
* policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use.
* This summary indicates whether the configuration changes have been applied everywhere.
*
*
* This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate
* that the firewall is ready. The Status setting indicates firewall readiness.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConfigurationSyncState
*/
public FirewallStatus withConfigurationSyncStateSummary(ConfigurationSyncState configurationSyncStateSummary) {
this.configurationSyncStateSummary = configurationSyncStateSummary.toString();
return this;
}
/**
*
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per
* Availability Zone where you've configured a subnet. These objects provide details of the information that is
* summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and
* configuration object.
*
*
* @return The subnets that you've configured for use by the Network Firewall firewall. This contains one array
* element per Availability Zone where you've configured a subnet. These objects provide details of the
* information that is summarized in the ConfigurationSyncStateSummary and Status,
* broken down by zone and configuration object.
*/
public java.util.Map getSyncStates() {
return syncStates;
}
/**
*
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per
* Availability Zone where you've configured a subnet. These objects provide details of the information that is
* summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and
* configuration object.
*
*
* @param syncStates
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array
* element per Availability Zone where you've configured a subnet. These objects provide details of the
* information that is summarized in the ConfigurationSyncStateSummary and Status,
* broken down by zone and configuration object.
*/
public void setSyncStates(java.util.Map syncStates) {
this.syncStates = syncStates;
}
/**
*
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per
* Availability Zone where you've configured a subnet. These objects provide details of the information that is
* summarized in the ConfigurationSyncStateSummary and Status, broken down by zone and
* configuration object.
*
*
* @param syncStates
* The subnets that you've configured for use by the Network Firewall firewall. This contains one array
* element per Availability Zone where you've configured a subnet. These objects provide details of the
* information that is summarized in the ConfigurationSyncStateSummary and Status,
* broken down by zone and configuration object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallStatus withSyncStates(java.util.Map syncStates) {
setSyncStates(syncStates);
return this;
}
/**
* Add a single SyncStates entry
*
* @see FirewallStatus#withSyncStates
* @returns a reference to this object so that method calls can be chained together.
*/
public FirewallStatus addSyncStatesEntry(String key, SyncState value) {
if (null == this.syncStates) {
this.syncStates = new java.util.HashMap();
}
if (this.syncStates.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.syncStates.put(key, value);
return this;
}
/**
* Removes all the entries added into SyncStates.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallStatus clearSyncStatesEntries() {
this.syncStates = null;
return this;
}
/**
*
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference
* sets in a firewall.
*
*
* @param capacityUsageSummary
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the
* reference sets in a firewall.
*/
public void setCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary) {
this.capacityUsageSummary = capacityUsageSummary;
}
/**
*
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference
* sets in a firewall.
*
*
* @return Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the
* reference sets in a firewall.
*/
public CapacityUsageSummary getCapacityUsageSummary() {
return this.capacityUsageSummary;
}
/**
*
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference
* sets in a firewall.
*
*
* @param capacityUsageSummary
* Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall
* calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the
* reference sets in a firewall.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public FirewallStatus withCapacityUsageSummary(CapacityUsageSummary capacityUsageSummary) {
setCapacityUsageSummary(capacityUsageSummary);
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 (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getConfigurationSyncStateSummary() != null)
sb.append("ConfigurationSyncStateSummary: ").append(getConfigurationSyncStateSummary()).append(",");
if (getSyncStates() != null)
sb.append("SyncStates: ").append(getSyncStates()).append(",");
if (getCapacityUsageSummary() != null)
sb.append("CapacityUsageSummary: ").append(getCapacityUsageSummary());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof FirewallStatus == false)
return false;
FirewallStatus other = (FirewallStatus) obj;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getConfigurationSyncStateSummary() == null ^ this.getConfigurationSyncStateSummary() == null)
return false;
if (other.getConfigurationSyncStateSummary() != null
&& other.getConfigurationSyncStateSummary().equals(this.getConfigurationSyncStateSummary()) == false)
return false;
if (other.getSyncStates() == null ^ this.getSyncStates() == null)
return false;
if (other.getSyncStates() != null && other.getSyncStates().equals(this.getSyncStates()) == false)
return false;
if (other.getCapacityUsageSummary() == null ^ this.getCapacityUsageSummary() == null)
return false;
if (other.getCapacityUsageSummary() != null && other.getCapacityUsageSummary().equals(this.getCapacityUsageSummary()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getConfigurationSyncStateSummary() == null) ? 0 : getConfigurationSyncStateSummary().hashCode());
hashCode = prime * hashCode + ((getSyncStates() == null) ? 0 : getSyncStates().hashCode());
hashCode = prime * hashCode + ((getCapacityUsageSummary() == null) ? 0 : getCapacityUsageSummary().hashCode());
return hashCode;
}
@Override
public FirewallStatus clone() {
try {
return (FirewallStatus) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.networkfirewall.model.transform.FirewallStatusMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}