/*
* Copyright 2018-2023 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.shield.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* <p>
* An object that represents a resource that is under DDoS protection.
* </p>
*
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Protection" target="_top">AWS API
* Documentation</a>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Protection implements Serializable, Cloneable, StructuredPojo {
/**
* <p>
* The unique identifier (ID) of the protection.
* </p>
*/
private String id;
/**
* <p>
* The name of the protection. For example, <code>My CloudFront distributions</code>.
* </p>
*/
private String name;
/**
* <p>
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
* </p>
*/
private String resourceArn;
/**
* <p>
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* </p>
*/
private java.util.List<String> healthCheckIds;
/**
* <p>
* The ARN (Amazon Resource Name) of the protection.
* </p>
*/
private String protectionArn;
/**
* <p>
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer
* events that Shield Advanced determines to be DDoS attacks.
* </p>
*/
private ApplicationLayerAutomaticResponseConfiguration applicationLayerAutomaticResponseConfiguration;
/**
* <p>
* The unique identifier (ID) of the protection.
* </p>
*
* @param id
* The unique identifier (ID) of the protection.
*/
public void setId(String id) {
this.id = id;
}
/**
* <p>
* The unique identifier (ID) of the protection.
* </p>
*
* @return The unique identifier (ID) of the protection.
*/
public String getId() {
return this.id;
}
/**
* <p>
* The unique identifier (ID) of the protection.
* </p>
*
* @param id
* The unique identifier (ID) of the protection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withId(String id) {
setId(id);
return this;
}
/**
* <p>
* The name of the protection. For example, <code>My CloudFront distributions</code>.
* </p>
*
* @param name
* The name of the protection. For example, <code>My CloudFront distributions</code>.
*/
public void setName(String name) {
this.name = name;
}
/**
* <p>
* The name of the protection. For example, <code>My CloudFront distributions</code>.
* </p>
*
* @return The name of the protection. For example, <code>My CloudFront distributions</code>.
*/
public String getName() {
return this.name;
}
/**
* <p>
* The name of the protection. For example, <code>My CloudFront distributions</code>.
* </p>
*
* @param name
* The name of the protection. For example, <code>My CloudFront distributions</code>.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withName(String name) {
setName(name);
return this;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
* </p>
*
* @param resourceArn
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
*/
public void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
* </p>
*
* @return The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
* </p>
*
* @param resourceArn
* The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
* <p>
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* </p>
*
* @return The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*/
public java.util.List<String> getHealthCheckIds() {
return healthCheckIds;
}
/**
* <p>
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* </p>
*
* @param healthCheckIds
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*/
public void setHealthCheckIds(java.util.Collection<String> healthCheckIds) {
if (healthCheckIds == null) {
this.healthCheckIds = null;
return;
}
this.healthCheckIds = new java.util.ArrayList<String>(healthCheckIds);
}
/**
* <p>
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* </p>
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setHealthCheckIds(java.util.Collection)} or {@link #withHealthCheckIds(java.util.Collection)} if you want
* to override the existing values.
* </p>
*
* @param healthCheckIds
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withHealthCheckIds(String... healthCheckIds) {
if (this.healthCheckIds == null) {
setHealthCheckIds(new java.util.ArrayList<String>(healthCheckIds.length));
}
for (String ele : healthCheckIds) {
this.healthCheckIds.add(ele);
}
return this;
}
/**
* <p>
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* </p>
*
* @param healthCheckIds
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withHealthCheckIds(java.util.Collection<String> healthCheckIds) {
setHealthCheckIds(healthCheckIds);
return this;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the protection.
* </p>
*
* @param protectionArn
* The ARN (Amazon Resource Name) of the protection.
*/
public void setProtectionArn(String protectionArn) {
this.protectionArn = protectionArn;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the protection.
* </p>
*
* @return The ARN (Amazon Resource Name) of the protection.
*/
public String getProtectionArn() {
return this.protectionArn;
}
/**
* <p>
* The ARN (Amazon Resource Name) of the protection.
* </p>
*
* @param protectionArn
* The ARN (Amazon Resource Name) of the protection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withProtectionArn(String protectionArn) {
setProtectionArn(protectionArn);
return this;
}
/**
* <p>
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer
* events that Shield Advanced determines to be DDoS attacks.
* </p>
*
* @param applicationLayerAutomaticResponseConfiguration
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application
* layer events that Shield Advanced determines to be DDoS attacks.
*/
public void setApplicationLayerAutomaticResponseConfiguration(ApplicationLayerAutomaticResponseConfiguration applicationLayerAutomaticResponseConfiguration) {
this.applicationLayerAutomaticResponseConfiguration = applicationLayerAutomaticResponseConfiguration;
}
/**
* <p>
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer
* events that Shield Advanced determines to be DDoS attacks.
* </p>
*
* @return The automatic application layer DDoS mitigation settings for the protection. This configuration
* determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to
* application layer events that Shield Advanced determines to be DDoS attacks.
*/
public ApplicationLayerAutomaticResponseConfiguration getApplicationLayerAutomaticResponseConfiguration() {
return this.applicationLayerAutomaticResponseConfiguration;
}
/**
* <p>
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer
* events that Shield Advanced determines to be DDoS attacks.
* </p>
*
* @param applicationLayerAutomaticResponseConfiguration
* The automatic application layer DDoS mitigation settings for the protection. This configuration determines
* whether Shield Advanced automatically manages rules in the web ACL in order to respond to application
* layer events that Shield Advanced determines to be DDoS attacks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Protection withApplicationLayerAutomaticResponseConfiguration(
ApplicationLayerAutomaticResponseConfiguration applicationLayerAutomaticResponseConfiguration) {
setApplicationLayerAutomaticResponseConfiguration(applicationLayerAutomaticResponseConfiguration);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getHealthCheckIds() != null)
sb.append("HealthCheckIds: ").append(getHealthCheckIds()).append(",");
if (getProtectionArn() != null)
sb.append("ProtectionArn: ").append(getProtectionArn()).append(",");
if (getApplicationLayerAutomaticResponseConfiguration() != null)
sb.append("ApplicationLayerAutomaticResponseConfiguration: ").append(getApplicationLayerAutomaticResponseConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Protection == false)
return false;
Protection other = (Protection) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getResourceArn() == null ^ this.getResourceArn() == null)
return false;
if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false)
return false;
if (other.getHealthCheckIds() == null ^ this.getHealthCheckIds() == null)
return false;
if (other.getHealthCheckIds() != null && other.getHealthCheckIds().equals(this.getHealthCheckIds()) == false)
return false;
if (other.getProtectionArn() == null ^ this.getProtectionArn() == null)
return false;
if (other.getProtectionArn() != null && other.getProtectionArn().equals(this.getProtectionArn()) == false)
return false;
if (other.getApplicationLayerAutomaticResponseConfiguration() == null ^ this.getApplicationLayerAutomaticResponseConfiguration() == null)
return false;
if (other.getApplicationLayerAutomaticResponseConfiguration() != null
&& other.getApplicationLayerAutomaticResponseConfiguration().equals(this.getApplicationLayerAutomaticResponseConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
hashCode = prime * hashCode + ((getHealthCheckIds() == null) ? 0 : getHealthCheckIds().hashCode());
hashCode = prime * hashCode + ((getProtectionArn() == null) ? 0 : getProtectionArn().hashCode());
hashCode = prime * hashCode
+ ((getApplicationLayerAutomaticResponseConfiguration() == null) ? 0 : getApplicationLayerAutomaticResponseConfiguration().hashCode());
return hashCode;
}
@Override
public Protection clone() {
try {
return (Protection) 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.shield.model.transform.ProtectionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}