Java tutorial
/* * Copyright 2014-2019 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.identitymanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/PutUserPolicy" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class PutUserPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * The name of the user to associate the policy with. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> */ private String userName; /** * <p> * The name of the policy document. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> */ private String policyName; /** * <p> * The policy document. * </p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you * can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format * before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a string of * characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> * </ul> */ private String policyDocument; /** * Default constructor for PutUserPolicyRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize the object after creating it. */ public PutUserPolicyRequest() { } /** * Constructs a new PutUserPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to * initialize any additional object members. * * @param userName * The name of the user to associate the policy with.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- * @param policyName * The name of the policy document. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- * @param policyDocument * The policy document. * </p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in * YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy * to JSON format before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a * string of characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character * range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> */ public PutUserPolicyRequest(String userName, String policyName, String policyDocument) { setUserName(userName); setPolicyName(policyName); setPolicyDocument(policyDocument); } /** * <p> * The name of the user to associate the policy with. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @param userName * The name of the user to associate the policy with.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- */ public void setUserName(String userName) { this.userName = userName; } /** * <p> * The name of the user to associate the policy with. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @return The name of the user to associate the policy with.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- */ public String getUserName() { return this.userName; } /** * <p> * The name of the user to associate the policy with. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @param userName * The name of the user to associate the policy with.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- * @return Returns a reference to this object so that method calls can be chained together. */ public PutUserPolicyRequest withUserName(String userName) { setUserName(userName); return this; } /** * <p> * The name of the policy document. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @param policyName * The name of the policy document.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- */ public void setPolicyName(String policyName) { this.policyName = policyName; } /** * <p> * The name of the policy document. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @return The name of the policy document.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- */ public String getPolicyName() { return this.policyName; } /** * <p> * The name of the policy document. * </p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of * characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of * the following characters: _+=,.@- * </p> * * @param policyName * The name of the policy document.</p> * <p> * This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string * of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also * include any of the following characters: _+=,.@- * @return Returns a reference to this object so that method calls can be chained together. */ public PutUserPolicyRequest withPolicyName(String policyName) { setPolicyName(policyName); return this; } /** * <p> * The policy document. * </p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you * can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format * before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a string of * characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> * </ul> * * @param policyDocument * The policy document.</p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in * YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy * to JSON format before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a * string of characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character * range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> */ public void setPolicyDocument(String policyDocument) { this.policyDocument = policyDocument; } /** * <p> * The policy document. * </p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you * can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format * before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a string of * characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> * </ul> * * @return The policy document.</p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in * YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy * to JSON format before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a * string of characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character * range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> */ public String getPolicyDocument() { return this.policyDocument; } /** * <p> * The policy document. * </p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you * can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format * before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a string of * characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> * </ul> * * @param policyDocument * The policy document.</p> * <p> * You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in * YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy * to JSON format before submitting it to IAM. * </p> * <p> * The <a href="http://wikipedia.org/wiki/regex">regex pattern</a> used to validate this parameter is a * string of characters consisting of the following: * </p> * <ul> * <li> * <p> * Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character * range * </p> * </li> * <li> * <p> * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) * </p> * </li> * <li> * <p> * The special characters tab ( ), line feed ( ), and carriage return ( ) * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. */ public PutUserPolicyRequest withPolicyDocument(String policyDocument) { setPolicyDocument(policyDocument); 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 (getUserName() != null) sb.append("UserName: ").append(getUserName()).append(","); if (getPolicyName() != null) sb.append("PolicyName: ").append(getPolicyName()).append(","); if (getPolicyDocument() != null) sb.append("PolicyDocument: ").append(getPolicyDocument()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PutUserPolicyRequest == false) return false; PutUserPolicyRequest other = (PutUserPolicyRequest) obj; if (other.getUserName() == null ^ this.getUserName() == null) return false; if (other.getUserName() != null && other.getUserName().equals(this.getUserName()) == false) return false; if (other.getPolicyName() == null ^ this.getPolicyName() == null) return false; if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false) return false; if (other.getPolicyDocument() == null ^ this.getPolicyDocument() == null) return false; if (other.getPolicyDocument() != null && other.getPolicyDocument().equals(this.getPolicyDocument()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getUserName() == null) ? 0 : getUserName().hashCode()); hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode()); hashCode = prime * hashCode + ((getPolicyDocument() == null) ? 0 : getPolicyDocument().hashCode()); return hashCode; } @Override public PutUserPolicyRequest clone() { return (PutUserPolicyRequest) super.clone(); } }