/* * Copyright 2018-2023 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 AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreatePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The friendly name of the policy. *

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. * For example, you cannot create resources named both "MyResource" and "myresource". *

*/ 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 (/). *

*

* This parameter allows (through its regex pattern) a string of * characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward * slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL * character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

* */ private String path; /** *

* The JSON policy document that you want to use as the content for the new policy. *

*

* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can * provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before * submitting it to IAM. *

*

* The maximum length of the policy document that you can pass in this operation, including whitespace, is listed * below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

*

* To learn more about JSON policy grammar, see Grammar of the IAM JSON * policy language in the IAM User Guide. *

*

* The regex pattern used to validate this parameter is a string of * characters consisting of the following: *

* */ 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; /** *

* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name * and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User * Guide. *

* *

* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request * fails and the resource is not created. *

* */ private com.amazonaws.internal.SdkInternalList tags; /** *

* The friendly name of the policy. *

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. * For example, you cannot create resources named both "MyResource" and "myresource". *

* * @param policyName * The friendly name of the policy.

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by * case. For example, you cannot create resources named both "MyResource" and "myresource". */ public void setPolicyName(String policyName) { this.policyName = policyName; } /** *

* The friendly name of the policy. *

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. * For example, you cannot create resources named both "MyResource" and "myresource". *

* * @return The friendly name of the policy.

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by * case. For example, you cannot create resources named both "MyResource" and "myresource". */ public String getPolicyName() { return this.policyName; } /** *

* The friendly name of the policy. *

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. * For example, you cannot create resources named both "MyResource" and "myresource". *

* * @param policyName * The friendly name of the policy.

*

* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by * case. For example, you cannot create resources named both "MyResource" and "myresource". * @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 (/). *

*

* This parameter allows (through its regex pattern) a string of * characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward * slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL * character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

* * * @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 (/). *

*

* This parameter allows (through its regex pattern) a string * of characters consisting of either a forward slash (/) by itself or a string that must begin and end with * forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through * the DEL character (\u007F), including most punctuation characters, digits, and upper and * lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

*/ 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 (/). *

*

* This parameter allows (through its regex pattern) a string of * characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward * slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL * character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

* * * @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 (/). *

*

* This parameter allows (through its regex pattern) a string * of characters consisting of either a forward slash (/) by itself or a string that must begin and end with * forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through * the DEL character (\u007F), including most punctuation characters, digits, and upper and * lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

*/ 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 (/). *

*

* This parameter allows (through its regex pattern) a string of * characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward * slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL * character (\u007F), including most punctuation characters, digits, and upper and lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

* * * @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 (/). *

*

* This parameter allows (through its regex pattern) a string * of characters consisting of either a forward slash (/) by itself or a string that must begin and end with * forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through * the DEL character (\u007F), including most punctuation characters, digits, and upper and * lowercased letters. *

* *

* You cannot use an asterisk (*) in the path name. *

* @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. *

*

* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can * provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before * submitting it to IAM. *

*

* The maximum length of the policy document that you can pass in this operation, including whitespace, is listed * below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

*

* To learn more about JSON policy grammar, see Grammar of the IAM JSON * policy language in the IAM User Guide. *

*

* The regex pattern used to validate this parameter is a string of * characters consisting of the following: *

*
    *
  • *

    * Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII * character range *

    *
    • *
  • *

    * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) *

    *
    • *
  • *

    * The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D * ) *

    *
    • *
* * @param policyDocument * The JSON policy document that you want to use as the content for the new policy.

*

* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, * you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON * format before submitting it to IAM. *

*

* The maximum length of the policy document that you can pass in this operation, including whitespace, is * listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

*

* To learn more about JSON policy grammar, see Grammar of the IAM * JSON policy language in the IAM User Guide. *

*

* The regex pattern used to validate this parameter is a * string of characters consisting of the following: *

*
    *
  • *

    * Any printable ASCII character ranging from the space character (\u0020) through the end of * the ASCII character range *

    *
    • *
  • *

    * The printable characters in the Basic Latin and Latin-1 Supplement character set (through * \u00FF) *

    *
    • *
  • *

    * The special characters tab (\u0009), line feed (\u000A), and carriage return ( * \u000D) *

    *
    • */ public void setPolicyDocument(String policyDocument) { this.policyDocument = policyDocument; } /** *

    * The JSON policy document that you want to use as the content for the new policy. *

    *

    * You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can * provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before * submitting it to IAM. *

    *

    * The maximum length of the policy document that you can pass in this operation, including whitespace, is listed * below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

    *

    * To learn more about JSON policy grammar, see Grammar of the IAM JSON * policy language in the IAM User Guide. *

    *

    * The regex pattern used to validate this parameter is a string of * characters consisting of the following: *

    *
      *
    • *

      * Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII * character range *

      *
      • *
    • *

      * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) *

      *
      • *
    • *

      * The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D * ) *

      *
      • *
    * * @return The JSON policy document that you want to use as the content for the new policy.

    *

    * You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, * you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON * format before submitting it to IAM. *

    *

    * The maximum length of the policy document that you can pass in this operation, including whitespace, is * listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

    *

    * To learn more about JSON policy grammar, see Grammar of the * IAM JSON policy language in the IAM User Guide. *

    *

    * The regex pattern used to validate this parameter is a * string of characters consisting of the following: *

    *
      *
    • *

      * Any printable ASCII character ranging from the space character (\u0020) through the end of * the ASCII character range *

      *
      • *
    • *

      * The printable characters in the Basic Latin and Latin-1 Supplement character set (through * \u00FF) *

      *
      • *
    • *

      * The special characters tab (\u0009), line feed (\u000A), and carriage return ( * \u000D) *

      *
      • */ public String getPolicyDocument() { return this.policyDocument; } /** *

      * The JSON policy document that you want to use as the content for the new policy. *

      *

      * You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can * provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before * submitting it to IAM. *

      *

      * The maximum length of the policy document that you can pass in this operation, including whitespace, is listed * below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

      *

      * To learn more about JSON policy grammar, see Grammar of the IAM JSON * policy language in the IAM User Guide. *

      *

      * The regex pattern used to validate this parameter is a string of * characters consisting of the following: *

      *
        *
      • *

        * Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII * character range *

        *
        • *
      • *

        * The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF) *

        *
        • *
      • *

        * The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D * ) *

        *
        • *
      * * @param policyDocument * The JSON policy document that you want to use as the content for the new policy.

      *

      * You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, * you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON * format before submitting it to IAM. *

      *

      * The maximum length of the policy document that you can pass in this operation, including whitespace, is * listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas. *

      *

      * To learn more about JSON policy grammar, see Grammar of the IAM * JSON policy language in the IAM User Guide. *

      *

      * The regex pattern used to validate this parameter is a * string of characters consisting of the following: *

      *
        *
      • *

        * Any printable ASCII character ranging from the space character (\u0020) through the end of * the ASCII character range *

        *
        • *
      • *

        * The printable characters in the Basic Latin and Latin-1 Supplement character set (through * \u00FF) *

        *
        • *
      • *

        * The special characters tab (\u0009), line feed (\u000A), and carriage return ( * \u000D) *

        *
        • * @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; } /** *

        * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name * and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User * Guide. *

        * *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request * fails and the resource is not created. *

        *         * * @return A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key * name and an associated value. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

        *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire * request fails and the resource is not created. *

        */ public java.util.List getTags() { if (tags == null) { tags = new com.amazonaws.internal.SdkInternalList(); } return tags; } /** *

        * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name * and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User * Guide. *

        * *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request * fails and the resource is not created. *

        *         * * @param tags * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key * name and an associated value. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

        *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire * request fails and the resource is not created. *

        */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new com.amazonaws.internal.SdkInternalList(tags); } /** *

        * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name * and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User * Guide. *

        * *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request * fails and the resource 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 new IAM customer managed policy. Each tag consists of a key * name and an associated value. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

        *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire * request fails and the resource 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 com.amazonaws.internal.SdkInternalList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

        * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name * and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User * Guide. *

        * *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request * fails and the resource is not created. *

        *         * * @param tags * A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key * name and an associated value. For more information about tagging, see Tagging IAM resources in the * IAM User Guide.

        *

        * If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire * request fails and the resource 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 (getPolicyName() != null) sb.append("PolicyName: ").append(getPolicyName()).append(","); if (getPath() != null) sb.append("Path: ").append(getPath()).append(","); if (getPolicyDocument() != null) sb.append("PolicyDocument: ").append(getPolicyDocument()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).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.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; 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 + ((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()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public CreatePolicyRequest clone() { return (CreatePolicyRequest) super.clone(); } }