com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.identitymanagement.AmazonIdentityManagement#putGroupPolicy(PutGroupPolicyRequest) PutGroupPolicy operation}.
*
* Adds (or updates) a policy document associated with the specified
* group. For information about policies, refer to
* Overview of Policies
* in Using AWS Identity and Access Management .
*
*
* For information about limits on the number of policies you can
* associate with a group, see
* Limitations on IAM Entities
* in Using AWS Identity and Access Management .
*
*
* NOTE:Because policy documents can be large, you should use POST
* rather than GET when calling PutGroupPolicy. For information about
* setting up signatures and authorization through the API, go to Signing
* AWS API Requests in the AWS General Reference. For general information
* about using the Query API with IAM, go to Making Query Requests in
* Using IAM.
*
*
* @see com.amazonaws.services.identitymanagement.AmazonIdentityManagement#putGroupPolicy(PutGroupPolicyRequest)
*/
public class PutGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable {
/**
* Name of the group to associate the policy with.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*/
private String groupName;
/**
* Name of the policy document.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*/
private String policyName;
/**
* The policy document.
*
* Constraints:
* Length: 1 - 131072
* Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
*/
private String policyDocument;
/**
* Default constructor for a new PutGroupPolicyRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public PutGroupPolicyRequest() {}
/**
* Constructs a new PutGroupPolicyRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param groupName Name of the group to associate the policy with.
* @param policyName Name of the policy document.
* @param policyDocument The policy document.
*/
public PutGroupPolicyRequest(String groupName, String policyName, String policyDocument) {
setGroupName(groupName);
setPolicyName(policyName);
setPolicyDocument(policyDocument);
}
/**
* Name of the group to associate the policy with.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @return Name of the group to associate the policy with.
*/
public String getGroupName() {
return groupName;
}
/**
* Name of the group to associate the policy with.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @param groupName Name of the group to associate the policy with.
*/
public void setGroupName(String groupName) {
this.groupName = groupName;
}
/**
* Name of the group to associate the policy with.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @param groupName Name of the group to associate the policy with.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutGroupPolicyRequest withGroupName(String groupName) {
this.groupName = groupName;
return this;
}
/**
* Name of the policy document.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @return Name of the policy document.
*/
public String getPolicyName() {
return policyName;
}
/**
* Name of the policy document.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @param policyName Name of the policy document.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* Name of the policy document.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 128
* Pattern: [\w+=,.@-]*
*
* @param policyName Name of the policy document.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutGroupPolicyRequest withPolicyName(String policyName) {
this.policyName = policyName;
return this;
}
/**
* The policy document.
*
* Constraints:
* Length: 1 - 131072
* Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
*
* @return The policy document.
*/
public String getPolicyDocument() {
return policyDocument;
}
/**
* The policy document.
*
* Constraints:
* Length: 1 - 131072
* Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
*
* @param policyDocument The policy document.
*/
public void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
/**
* The policy document.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 131072
* Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+
*
* @param policyDocument The policy document.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutGroupPolicyRequest withPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getGroupName() != null) sb.append("GroupName: " + getGroupName() + ",");
if (getPolicyName() != null) sb.append("PolicyName: " + getPolicyName() + ",");
if (getPolicyDocument() != null) sb.append("PolicyDocument: " + getPolicyDocument() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode());
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode + ((getPolicyDocument() == null) ? 0 : getPolicyDocument().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PutGroupPolicyRequest == false) return false;
PutGroupPolicyRequest other = (PutGroupPolicyRequest)obj;
if (other.getGroupName() == null ^ this.getGroupName() == null) return false;
if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == 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;
}
}