Package software.amazon.awssdk.services.iam.model

Class CreatePolicyRequest

    • Method Detail

      • policyName

        public final String 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".

        Returns:
        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".

      • path

        public final String 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 ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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

        Returns:
        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 ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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

      • policyDocument

        public final String 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 ( ) through the end of the ASCII character range

        • The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

        • The special characters tab ( ), line feed ( ), and carriage return ( )

        Returns:
        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 ( ) through the end of the ASCII character range

        • The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

        • The special characters tab ( ), line feed ( ), and carriage return ( )

      • description

        public final String 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.

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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.

      • toString

        public final String toString()
        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.
        Overrides:
        toString in class Object