com.amazonaws.services.organizations.model.InviteAccountToOrganizationRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class InviteAccountToOrganizationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is
* a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as the
* Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*/
private HandshakeParty target;
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*/
private String notes;
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*/
private java.util.List tags;
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is
* a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as the
* Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*
* @param target
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number
* as the Id. If you specify "Type": "EMAIL", you must specify the email address
* that is associated with the account.
*
*
* --target [email protected],Type=EMAIL
*/
public void setTarget(HandshakeParty target) {
this.target = target;
}
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is
* a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as the
* Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*
* @return The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number
* as the Id. If you specify "Type": "EMAIL", you must specify the email address
* that is associated with the account.
*
*
* --target [email protected],Type=EMAIL
*/
public HandshakeParty getTarget() {
return this.target;
}
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is
* a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as the
* Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*
* @param target
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number
* as the Id. If you specify "Type": "EMAIL", you must specify the email address
* that is associated with the account.
*
*
* --target [email protected],Type=EMAIL
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InviteAccountToOrganizationRequest withTarget(HandshakeParty target) {
setTarget(target);
return this;
}
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*
* @param notes
* Additional information that you want to include in the generated email to the recipient account owner.
*/
public void setNotes(String notes) {
this.notes = notes;
}
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*
* @return Additional information that you want to include in the generated email to the recipient account owner.
*/
public String getNotes() {
return this.notes;
}
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*
* @param notes
* Additional information that you want to include in the generated email to the recipient account owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InviteAccountToOrganizationRequest withNotes(String notes) {
setNotes(notes);
return this;
}
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*
* @return A list of tags that you want to attach to the account when it becomes a member of the organization. For
* each tag in the list, you must specify both a tag key and a value. You can set the value to an empty
* string, but you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is
* made. The request is rejected if the tags in the request don't match the requirements of the policy at
* that time. Tag policy compliance is not checked again when the invitation is accepted and
* the tags are actually attached to the account. That means that if the tag policy changes between the
* invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*
* @param tags
* A list of tags that you want to attach to the account when it becomes a member of the organization. For
* each tag in the list, you must specify both a tag key and a value. You can set the value to an empty
* string, but you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is
* made. The request is rejected if the tags in the request don't match the requirements of the policy at
* that time. Tag policy compliance is not checked again when the invitation is accepted and
* the tags are actually attached to the account. That means that if the tag policy changes between the
* invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*
* 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
* A list of tags that you want to attach to the account when it becomes a member of the organization. For
* each tag in the list, you must specify both a tag key and a value. You can set the value to an empty
* string, but you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is
* made. The request is rejected if the tags in the request don't match the requirements of the policy at
* that time. Tag policy compliance is not checked again when the invitation is accepted and
* the tags are actually attached to the account. That means that if the tag policy changes between the
* invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InviteAccountToOrganizationRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*
* @param tags
* A list of tags that you want to attach to the account when it becomes a member of the organization. For
* each tag in the list, you must specify both a tag key and a value. You can set the value to an empty
* string, but you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is
* made. The request is rejected if the tags in the request don't match the requirements of the policy at
* that time. Tag policy compliance is not checked again when the invitation is accepted and
* the tags are actually attached to the account. That means that if the tag policy changes between the
* invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public InviteAccountToOrganizationRequest 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 (getTarget() != null)
sb.append("Target: ").append(getTarget()).append(",");
if (getNotes() != null)
sb.append("Notes: ").append("***Sensitive Data Redacted***").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 InviteAccountToOrganizationRequest == false)
return false;
InviteAccountToOrganizationRequest other = (InviteAccountToOrganizationRequest) obj;
if (other.getTarget() == null ^ this.getTarget() == null)
return false;
if (other.getTarget() != null && other.getTarget().equals(this.getTarget()) == false)
return false;
if (other.getNotes() == null ^ this.getNotes() == null)
return false;
if (other.getNotes() != null && other.getNotes().equals(this.getNotes()) == 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 + ((getTarget() == null) ? 0 : getTarget().hashCode());
hashCode = prime * hashCode + ((getNotes() == null) ? 0 : getNotes().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public InviteAccountToOrganizationRequest clone() {
return (InviteAccountToOrganizationRequest) super.clone();
}
}