com.amazonaws.services.identitymanagement.model.CreatePolicyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2010-2016 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;
/**
*
*/
public class CreatePolicyRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* The friendly name of the policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of upper and lowercase
* alphanumeric characters with no spaces. You can also include any of the
* following characters: =,.@-
*
*/
private String policyName;
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash
* (/).
*
*
* The regex pattern for this
* parameter is a string of characters consisting of either a forward slash
* (/) by itself or a string that must begin and end with forward slashes,
* containing any ASCII character from the ! (\u0021) thru the DEL character
* (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*
*/
private String path;
/**
*
* The JSON policy document that you want to use as the content for the new
* policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of any printable ASCII
* character ranging from the space character ( ) through end of the ASCII
* character range (\u00FF). It also includes the special characters tab (
* ), line feed ( ), and carriage return ( ).
*
*/
private String policyDocument;
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the
* policy. For example, "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot
* be changed.
*
*/
private String description;
/**
*
* The friendly name of the policy.
*
*
* The regex pattern for this
* parameter is 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 friendly name of the policy.
*
* The regex pattern
* for this parameter is 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;
}
/**
*
* The friendly name of the policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of upper and lowercase
* alphanumeric characters with no spaces. You can also include any of the
* following characters: =,.@-
*
*
* @return The friendly name of the policy.
*
* The regex pattern
* for this parameter is 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;
}
/**
*
* The friendly name of the policy.
*
*
* The regex pattern for this
* parameter is 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 friendly name of the policy.
*
* The regex pattern
* for this parameter is 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 CreatePolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash
* (/).
*
*
* The regex pattern for this
* parameter is a string of characters consisting of either a forward slash
* (/) by itself or a string that must begin and end with forward slashes,
* containing any ASCII character from the ! (\u0021) thru the DEL character
* (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*
*
* @param path
* The path for the policy.
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to
* a slash (/).
*
*
* The regex pattern
* for this parameter is a string of characters consisting of either
* a forward slash (/) by itself or a string that must begin and end
* with forward slashes, containing any ASCII character from the !
* (\u0021) thru the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*/
public void setPath(String path) {
this.path = path;
}
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash
* (/).
*
*
* The regex pattern for this
* parameter is a string of characters consisting of either a forward slash
* (/) by itself or a string that must begin and end with forward slashes,
* containing any ASCII character from the ! (\u0021) thru the DEL character
* (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*
*
* @return The path for the policy.
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to
* a slash (/).
*
*
* The regex pattern
* for this parameter is a string of characters consisting of either
* a forward slash (/) by itself or a string that must begin and end
* with forward slashes, containing any ASCII character from the !
* (\u0021) thru the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
*/
public String getPath() {
return this.path;
}
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash
* (/).
*
*
* The regex pattern for this
* parameter is a string of characters consisting of either a forward slash
* (/) by itself or a string that must begin and end with forward slashes,
* containing any ASCII character from the ! (\u0021) thru the DEL character
* (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
*
*
* @param path
* The path for the policy.
*
* For more information about paths, see IAM Identifiers in the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to
* a slash (/).
*
*
* The regex pattern
* for this parameter is a string of characters consisting of either
* a forward slash (/) by itself or a string that must begin and end
* with forward slashes, containing any ASCII character from the !
* (\u0021) thru the DEL character (\u007F), including most
* punctuation characters, digits, and upper and lowercased letters.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreatePolicyRequest withPath(String path) {
setPath(path);
return this;
}
/**
*
* The JSON policy document that you want to use as the content for the new
* policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of any printable ASCII
* character ranging from the space character ( ) through end of the ASCII
* character range (\u00FF). It also includes the special characters tab (
* ), line feed ( ), and carriage return ( ).
*
*
* @param policyDocument
* The JSON policy document that you want to use as the content for
* the new policy.
*
* The regex pattern
* for this parameter is a string of characters consisting of any
* printable ASCII character ranging from the space character ( )
* through end of the ASCII character range (\u00FF). It also
* includes the special characters tab ( ), line feed ( ), and
* carriage return ( ).
*/
public void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
/**
*
* The JSON policy document that you want to use as the content for the new
* policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of any printable ASCII
* character ranging from the space character ( ) through end of the ASCII
* character range (\u00FF). It also includes the special characters tab (
* ), line feed ( ), and carriage return ( ).
*
*
* @return The JSON policy document that you want to use as the content for
* the new policy.
*
* The regex pattern
* for this parameter is a string of characters consisting of any
* printable ASCII character ranging from the space character ( )
* through end of the ASCII character range (\u00FF). It also
* includes the special characters tab ( ), line feed ( ), and
* carriage return ( ).
*/
public String getPolicyDocument() {
return this.policyDocument;
}
/**
*
* The JSON policy document that you want to use as the content for the new
* policy.
*
*
* The regex pattern for this
* parameter is a string of characters consisting of any printable ASCII
* character ranging from the space character ( ) through end of the ASCII
* character range (\u00FF). It also includes the special characters tab (
* ), line feed ( ), and carriage return ( ).
*
*
* @param policyDocument
* The JSON policy document that you want to use as the content for
* the new policy.
*
* The regex pattern
* for this parameter is a string of characters consisting of any
* printable ASCII character ranging from the space character ( )
* through end of the ASCII character range (\u00FF). It also
* includes the special characters tab ( ), line feed ( ), and
* carriage return ( ).
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreatePolicyRequest withPolicyDocument(String policyDocument) {
setPolicyDocument(policyDocument);
return this;
}
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the
* policy. For example, "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot
* be changed.
*
*
* @param description
* A friendly description of the policy.
*
* Typically used to store information about the permissions defined
* in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it
* cannot be changed.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the
* policy. For example, "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot
* be changed.
*
*
* @return A friendly description of the policy.
*
* Typically used to store information about the permissions defined
* in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned,
* it cannot be changed.
*/
public String getDescription() {
return this.description;
}
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the
* policy. For example, "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot
* be changed.
*
*
* @param description
* A friendly description of the policy.
*
* Typically used to store information about the permissions defined
* in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it
* cannot be changed.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreatePolicyRequest withDescription(String description) {
setDescription(description);
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 (getPolicyName() != null)
sb.append("PolicyName: " + getPolicyName() + ",");
if (getPath() != null)
sb.append("Path: " + getPath() + ",");
if (getPolicyDocument() != null)
sb.append("PolicyDocument: " + getPolicyDocument() + ",");
if (getDescription() != null)
sb.append("Description: " + getDescription());
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.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null
&& other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getPath() == null ^ this.getPath() == null)
return false;
if (other.getPath() != null
&& other.getPath().equals(this.getPath()) == false)
return false;
if (other.getPolicyDocument() == null
^ this.getPolicyDocument() == null)
return false;
if (other.getPolicyDocument() != null
&& other.getPolicyDocument().equals(this.getPolicyDocument()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null
&& other.getDescription().equals(this.getDescription()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode
+ ((getPath() == null) ? 0 : getPath().hashCode());
hashCode = prime
* hashCode
+ ((getPolicyDocument() == null) ? 0 : getPolicyDocument()
.hashCode());
hashCode = prime
* hashCode
+ ((getDescription() == null) ? 0 : getDescription().hashCode());
return hashCode;
}
@Override
public CreatePolicyRequest clone() {
return (CreatePolicyRequest) super.clone();
}
}