com.amazonaws.services.organizations.model.CreatePolicyRequest 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 CreatePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy
* type you specify in the Type parameter.
*
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*
*/
private String content;
/**
*
* An optional description to assign to the policy.
*
*/
private String description;
/**
*
* The friendly name to assign to the policy.
*
*
* 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 type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*/
private String type;
/**
*
* A list of tags that you want to attach to the newly created policy. 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.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire
* request fails and the policy is not created.
*
*
*/
private java.util.List tags;
/**
*
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy
* type you specify in the Type parameter.
*
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*
*
* @param content
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the
* policy type you specify in the Type parameter.
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*/
public void setContent(String content) {
this.content = content;
}
/**
*
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy
* type you specify in the Type parameter.
*
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*
*
* @return The policy text content to add to the new policy. The text that you supply must adhere to the rules of
* the policy type you specify in the Type parameter.
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*/
public String getContent() {
return this.content;
}
/**
*
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy
* type you specify in the Type parameter.
*
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
*
*
* @param content
* The policy text content to add to the new policy. The text that you supply must adhere to the rules of the
* policy type you specify in the Type parameter.
*
* The maximum size of a policy document depends on the policy's type. For more information, see Maximum and minimum values in the Organizations User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePolicyRequest withContent(String content) {
setContent(content);
return this;
}
/**
*
* An optional description to assign to the policy.
*
*
* @param description
* An optional description to assign to the policy.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* An optional description to assign to the policy.
*
*
* @return An optional description to assign to the policy.
*/
public String getDescription() {
return this.description;
}
/**
*
* An optional description to assign to the policy.
*
*
* @param description
* An optional description to assign to the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePolicyRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The friendly name to assign to the policy.
*
*
* 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 to assign to the policy.
*
* 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 to assign to the policy.
*
*
* 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 to assign to the policy.
*
* 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 to assign to the policy.
*
*
* 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 to assign to the policy.
*
* 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 CreatePolicyRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*
* @param type
* The type of policy to create. You can specify one of the following values:
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
* TAG_POLICY
*
*
* @see PolicyType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*
* @return The type of policy to create. You can specify one of the following values:
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
* TAG_POLICY
*
*
* @see PolicyType
*/
public String getType() {
return this.type;
}
/**
*
* The type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*
* @param type
* The type of policy to create. You can specify one of the following values:
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
* TAG_POLICY
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public CreatePolicyRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*
* @param type
* The type of policy to create. You can specify one of the following values:
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
* TAG_POLICY
*
*
* @see PolicyType
*/
public void setType(PolicyType type) {
withType(type);
}
/**
*
* The type of policy to create. You can specify one of the following values:
*
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
*
* TAG_POLICY
*
*
*
*
* @param type
* The type of policy to create. You can specify one of the following values:
*
* -
*
*
* -
*
*
* BACKUP_POLICY
*
*
* -
*
*
* -
*
* TAG_POLICY
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public CreatePolicyRequest withType(PolicyType type) {
this.type = type.toString();
return this;
}
/**
*
* A list of tags that you want to attach to the newly created policy. 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.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire
* request fails and the policy is not created.
*
*
*
* @return A list of tags that you want to attach to the newly created policy. 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.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the
* entire request fails and the policy is not created.
*
*/
public java.util.List getTags() {
return tags;
}
/**
*
* A list of tags that you want to attach to the newly created policy. 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.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire
* request fails and the policy is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the newly created policy. 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.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the
* entire request fails and the policy is not created.
*
*/
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 newly created policy. 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.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire
* request fails and the policy is not 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
* A list of tags that you want to attach to the newly created policy. 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.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the
* entire request fails and the policy is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePolicyRequest 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 newly created policy. 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.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the entire
* request fails and the policy is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the newly created policy. 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.
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for a policy, then the
* entire request fails and the policy is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePolicyRequest 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 (getContent() != null)
sb.append("Content: ").append(getContent()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).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 CreatePolicyRequest == false)
return false;
CreatePolicyRequest other = (CreatePolicyRequest) obj;
if (other.getContent() == null ^ this.getContent() == null)
return false;
if (other.getContent() != null && other.getContent().equals(this.getContent()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == 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.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == 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 + ((getContent() == null) ? 0 : getContent().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreatePolicyRequest clone() {
return (CreatePolicyRequest) super.clone();
}
}