com.amazonaws.services.organizations.model.OrganizationalUnit Maven / Gradle / Ivy
Show all versions of aws-java-sdk-organizations 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.organizations.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a
* root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any
* child OUs.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class OrganizationalUnit implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
* is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*/
private String id;
/**
*
* The Amazon Resource Name (ARN) of this OU.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*/
private String arn;
/**
*
* The friendly name of this OU.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*/
private String name;
/**
*
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
* is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*
* @param id
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
* The regex pattern for an organizational unit ID string
* requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the
* OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
* is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*
* @return The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
* The regex pattern for an organizational unit ID string
* requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the
* OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or
* digits.
*/
public String getId() {
return this.id;
}
/**
*
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
* is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*
* @param id
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
* The regex pattern for an organizational unit ID string
* requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the
* OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OrganizationalUnit withId(String id) {
setId(id);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of this OU.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of this OU.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of this OU.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @return The Amazon Resource Name (ARN) of this OU.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of this OU.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of this OU.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OrganizationalUnit withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The friendly name of this OU.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @param name
* The friendly name of this OU.
*
* The regex pattern that is used to validate this parameter is
* a string of any of the characters in the ASCII character range.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The friendly name of this OU.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @return The friendly name of this OU.
*
* The regex pattern that is used to validate this parameter
* is a string of any of the characters in the ASCII character range.
*/
public String getName() {
return this.name;
}
/**
*
* The friendly name of this OU.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @param name
* The friendly name of this OU.
*
* The regex pattern that is used to validate this parameter is
* a string of any of the characters in the ASCII character range.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public OrganizationalUnit withName(String name) {
setName(name);
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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof OrganizationalUnit == false)
return false;
OrganizationalUnit other = (OrganizationalUnit) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == 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 + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
return hashCode;
}
@Override
public OrganizationalUnit clone() {
try {
return (OrganizationalUnit) 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.organizations.model.transform.OrganizationalUnitMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}