com.amazonaws.services.shield.model.CreateProtectionRequest Maven / Gradle / Ivy
/*
* 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.shield.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 CreateProtectionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Friendly name for the Protection you are creating.
*
*/
private String name;
/**
*
* The ARN (Amazon Resource Name) of the resource to be protected.
*
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*
*/
private String resourceArn;
/**
*
* One or more tag key-value pairs for the Protection object that is created.
*
*/
private java.util.List tags;
/**
*
* Friendly name for the Protection you are creating.
*
*
* @param name
* Friendly name for the Protection you are creating.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* Friendly name for the Protection you are creating.
*
*
* @return Friendly name for the Protection you are creating.
*/
public String getName() {
return this.name;
}
/**
*
* Friendly name for the Protection you are creating.
*
*
* @param name
* Friendly name for the Protection you are creating.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProtectionRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The ARN (Amazon Resource Name) of the resource to be protected.
*
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*
*
* @param resourceArn
* The ARN (Amazon Resource Name) of the resource to be protected.
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*/
public void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
/**
*
* The ARN (Amazon Resource Name) of the resource to be protected.
*
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*
*
* @return The ARN (Amazon Resource Name) of the resource to be protected.
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
*
* The ARN (Amazon Resource Name) of the resource to be protected.
*
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
*
*
* @param resourceArn
* The ARN (Amazon Resource Name) of the resource to be protected.
*
* The ARN should be in one of the following formats:
*
*
* -
*
* For an Application Load Balancer:
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
*
*
* -
*
* For an Elastic Load Balancer (Classic Load Balancer):
* arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name
*
*
* -
*
* For an Amazon CloudFront distribution:
* arn:aws:cloudfront::account-id:distribution/distribution-id
*
*
* -
*
* For an Global Accelerator standard accelerator:
* arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
*
*
* -
*
* For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id
*
*
* -
*
* For an Elastic IP address:
* arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProtectionRequest withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
*
* One or more tag key-value pairs for the Protection object that is created.
*
*
* @return One or more tag key-value pairs for the Protection object that is created.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* One or more tag key-value pairs for the Protection object that is created.
*
*
* @param tags
* One or more tag key-value pairs for the Protection object that is created.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* One or more tag key-value pairs for the Protection object that is created.
*
*
* 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
* One or more tag key-value pairs for the Protection object that is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProtectionRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* One or more tag key-value pairs for the Protection object that is created.
*
*
* @param tags
* One or more tag key-value pairs for the Protection object that is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateProtectionRequest withTags(java.util.Collection tags) {
setTags(tags);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateProtectionRequest == false)
return false;
CreateProtectionRequest other = (CreateProtectionRequest) obj;
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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateProtectionRequest clone() {
return (CreateProtectionRequest) super.clone();
}
}