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

Interface CreatePolicyVersionRequest.Builder

    • Method Detail

      • policyArn

        CreatePolicyVersionRequest.Builder policyArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • policyDocument

        CreatePolicyVersionRequest.Builder policyDocument​(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 ( )

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • setAsDefault

        CreatePolicyVersionRequest.Builder setAsDefault​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.