deletePermission method

Future<void> deletePermission({
  1. required String certificateAuthorityArn,
  2. required String principal,
  3. String? sourceAccount,
})

Revokes permissions on a private CA granted 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. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.

Permissions can be granted with the CreatePermission action and listed with the ListPermissions 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 InvalidStateException. May throw RequestFailedException.

Parameter certificateAuthorityArn : The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's 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 will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

Parameter sourceAccount : The AWS account that calls this action.

Implementation

Future<void> deletePermission({
  required String certificateAuthorityArn,
  required String principal,
  String? sourceAccount,
}) async {
  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.DeletePermission'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'CertificateAuthorityArn': certificateAuthorityArn,
      'Principal': principal,
      if (sourceAccount != null) 'SourceAccount': sourceAccount,
    },
  );
}