createPolicyVersion method

Future<CreatePolicyVersionResponse> createPolicyVersion({ required String policyArn, required String policyDocument, bool? setAsDefault, })

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

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

May throw NoSuchEntityException. May throw MalformedPolicyDocumentException. May throw InvalidInputException. May throw LimitExceededException. May throw ServiceFailureException.

Parameter 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) and AWS Service Namespaces in the AWS General Reference.

Parameter 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 AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 (\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)

Parameter 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.

Implementation

Future<CreatePolicyVersionResponse> createPolicyVersion({
  required String policyArn,
  required String policyDocument,
  bool? setAsDefault,
}) async {
  ArgumentError.checkNotNull(policyArn, 'policyArn');
  _s.validateStringLength(
    'policyArn',
    policyArn,
    20,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(policyDocument, 'policyDocument');
  _s.validateStringLength(
    'policyDocument',
    policyDocument,
    1,
    131072,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['PolicyArn'] = policyArn;
  $request['PolicyDocument'] = policyDocument;
  setAsDefault?.also((arg) => $request['SetAsDefault'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'CreatePolicyVersion',
    version: '2010-05-08',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['CreatePolicyVersionRequest'],
    shapes: shapes,
    resultWrapper: 'CreatePolicyVersionResult',
  );
  return CreatePolicyVersionResponse.fromXml($result);
}