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

Class CreatePolicyVersionRequest

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.CreatePolicyVersionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePolicyVersionRequest.Builder,CreatePolicyVersionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePolicyVersionRequest extends IamRequest implements ToCopyableBuilder<CreatePolicyVersionRequest.Builder,CreatePolicyVersionRequest>

  • Method Details

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Returns:
      The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

      For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • policyDocument

      public final String policyDocument()

      The JSON policy document that you want to use as the content for this new version of the 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.

      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 this new version of the 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.

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

    • setAsDefault

      public final Boolean setAsDefault()

      Specifies whether to set this version as the policy's default version.

      When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

      For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

      Returns:
      Specifies whether to set this version as the policy's default version.

      When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

      For more information about managed policy versions, see Versioning for managed policies in the IAM User Guide.

    • toBuilder

      public CreatePolicyVersionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePolicyVersionRequest.Builder,CreatePolicyVersionRequest>
      Specified by:
      toBuilder in class IamRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePolicyVersionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePolicyVersionRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.