createPermission method

Future<void> createPermission({ required List<ActionType> actions, required String certificateAuthorityArn, required String principal, String? sourceAccount, })

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

• If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
• For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
• If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

May throw ResourceNotFoundException. May throw InvalidArnException. May throw PermissionAlreadyExistsException. May throw LimitExceededException. May throw InvalidStateException. May throw RequestFailedException.

Parameter actions : The actions that the specified AWS service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

Parameter certificateAuthorityArn : The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Parameter principal : The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

Parameter sourceAccount : The ID of the calling account.

Implementation

Future<void> createPermission({
  required List<ActionType> actions,
  required String certificateAuthorityArn,
  required String principal,
  String? sourceAccount,
}) async {
  ArgumentError.checkNotNull(actions, 'actions');
  ArgumentError.checkNotNull(
      certificateAuthorityArn, 'certificateAuthorityArn');
  _s.validateStringLength(
    'certificateAuthorityArn',
    certificateAuthorityArn,
    5,
    200,
    isRequired: true,
  );
  ArgumentError.checkNotNull(principal, 'principal');
  _s.validateStringLength(
    'principal',
    principal,
    0,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'sourceAccount',
    sourceAccount,
    12,
    12,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'ACMPrivateCA.CreatePermission'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Actions': actions.map((e) => e.toValue()).toList(),
      'CertificateAuthorityArn': certificateAuthorityArn,
      'Principal': principal,
      if (sourceAccount != null) 'SourceAccount': sourceAccount,
    },
  );
}