com.amazonaws.services.accessanalyzer.model.Trail Maven / Gradle / Ivy
/*
* 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.accessanalyzer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details about the CloudTrail trail being analyzed to generate a policy.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Trail implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*
*/
private String cloudTrailArn;
/**
*
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*
*/
private java.util.List regions;
/**
*
* Possible values are true or false. If set to true, IAM Access Analyzer
* retrieves CloudTrail data from all regions to analyze and generate a policy.
*
*/
private Boolean allRegions;
/**
*
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*
*
* @param cloudTrailArn
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*/
public void setCloudTrailArn(String cloudTrailArn) {
this.cloudTrailArn = cloudTrailArn;
}
/**
*
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*
*
* @return Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*/
public String getCloudTrailArn() {
return this.cloudTrailArn;
}
/**
*
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
*
*
* @param cloudTrailArn
* Specifies the ARN of the trail. The format of a trail ARN is
* arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trail withCloudTrailArn(String cloudTrailArn) {
setCloudTrailArn(cloudTrailArn);
return this;
}
/**
*
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*
*
* @return A list of regions to get CloudTrail data from and analyze to generate a policy.
*/
public java.util.List getRegions() {
return regions;
}
/**
*
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*
*
* @param regions
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*/
public void setRegions(java.util.Collection regions) {
if (regions == null) {
this.regions = null;
return;
}
this.regions = new java.util.ArrayList(regions);
}
/**
*
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegions(java.util.Collection)} or {@link #withRegions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param regions
* A list of regions to get CloudTrail data from and analyze to generate a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trail withRegions(String... regions) {
if (this.regions == null) {
setRegions(new java.util.ArrayList(regions.length));
}
for (String ele : regions) {
this.regions.add(ele);
}
return this;
}
/**
*
* A list of regions to get CloudTrail data from and analyze to generate a policy.
*
*
* @param regions
* A list of regions to get CloudTrail data from and analyze to generate a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trail withRegions(java.util.Collection regions) {
setRegions(regions);
return this;
}
/**
*
* Possible values are true or false. If set to true, IAM Access Analyzer
* retrieves CloudTrail data from all regions to analyze and generate a policy.
*
*
* @param allRegions
* Possible values are true or false. If set to true, IAM Access
* Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
*/
public void setAllRegions(Boolean allRegions) {
this.allRegions = allRegions;
}
/**
*
* Possible values are true or false. If set to true, IAM Access Analyzer
* retrieves CloudTrail data from all regions to analyze and generate a policy.
*
*
* @return Possible values are true or false. If set to true, IAM Access
* Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
*/
public Boolean getAllRegions() {
return this.allRegions;
}
/**
*
* Possible values are true or false. If set to true, IAM Access Analyzer
* retrieves CloudTrail data from all regions to analyze and generate a policy.
*
*
* @param allRegions
* Possible values are true or false. If set to true, IAM Access
* Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Trail withAllRegions(Boolean allRegions) {
setAllRegions(allRegions);
return this;
}
/**
*
* Possible values are true or false. If set to true, IAM Access Analyzer
* retrieves CloudTrail data from all regions to analyze and generate a policy.
*
*
* @return Possible values are true or false. If set to true, IAM Access
* Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.
*/
public Boolean isAllRegions() {
return this.allRegions;
}
/**
* 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 (getCloudTrailArn() != null)
sb.append("CloudTrailArn: ").append(getCloudTrailArn()).append(",");
if (getRegions() != null)
sb.append("Regions: ").append(getRegions()).append(",");
if (getAllRegions() != null)
sb.append("AllRegions: ").append(getAllRegions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Trail == false)
return false;
Trail other = (Trail) obj;
if (other.getCloudTrailArn() == null ^ this.getCloudTrailArn() == null)
return false;
if (other.getCloudTrailArn() != null && other.getCloudTrailArn().equals(this.getCloudTrailArn()) == false)
return false;
if (other.getRegions() == null ^ this.getRegions() == null)
return false;
if (other.getRegions() != null && other.getRegions().equals(this.getRegions()) == false)
return false;
if (other.getAllRegions() == null ^ this.getAllRegions() == null)
return false;
if (other.getAllRegions() != null && other.getAllRegions().equals(this.getAllRegions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCloudTrailArn() == null) ? 0 : getCloudTrailArn().hashCode());
hashCode = prime * hashCode + ((getRegions() == null) ? 0 : getRegions().hashCode());
hashCode = prime * hashCode + ((getAllRegions() == null) ? 0 : getAllRegions().hashCode());
return hashCode;
}
@Override
public Trail clone() {
try {
return (Trail) 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.accessanalyzer.model.transform.TrailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}