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

Class PutUserPolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iam.model.IamRequest
software.amazon.awssdk.services.iam.model.PutUserPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutUserPolicyRequest.Builder,PutUserPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutUserPolicyRequest extends IamRequest implements ToCopyableBuilder<PutUserPolicyRequest.Builder,PutUserPolicyRequest>

  • Method Details

    • userName

      public final String userName()

      The name of the user to associate the policy with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

      Returns:
      The name of the user to associate the policy with.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • policyName

      public final String policyName()

      The name of the policy document.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

      Returns:
      The name of the policy document.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • policyDocument

      public final String policyDocument()

      The policy document.

      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 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 policy document.

      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 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 ( )

    • toBuilder

      public PutUserPolicyRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutUserPolicyRequest.Builder,PutUserPolicyRequest>
      Specified by:
      toBuilder in class IamRequest

    • builder

      public static PutUserPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutUserPolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo