Interface AcmPcaClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.
The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.
Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.
To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AcmPcaClientBuilder
builder()
Create a builder that can be used to configure and create aAcmPcaClient
.static AcmPcaClient
create()
Create aAcmPcaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCertificateAuthority
(Consumer<CreateCertificateAuthorityRequest.Builder> createCertificateAuthorityRequest) Creates a root or subordinate private certificate authority (CA).createCertificateAuthority
(CreateCertificateAuthorityRequest createCertificateAuthorityRequest) Creates a root or subordinate private certificate authority (CA).createCertificateAuthorityAuditReport
(Consumer<CreateCertificateAuthorityAuditReportRequest.Builder> createCertificateAuthorityAuditReportRequest) Creates an audit report that lists every time that your CA private key is used.createCertificateAuthorityAuditReport
(CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest) Creates an audit report that lists every time that your CA private key is used.default CreatePermissionResponse
createPermission
(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com
).default CreatePermissionResponse
createPermission
(CreatePermissionRequest createPermissionRequest) Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (acm.amazonaws.com
).deleteCertificateAuthority
(Consumer<DeleteCertificateAuthorityRequest.Builder> deleteCertificateAuthorityRequest) Deletes a private certificate authority (CA).deleteCertificateAuthority
(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest) Deletes a private certificate authority (CA).default DeletePermissionResponse
deletePermission
(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).default DeletePermissionResponse
deletePermission
(DeletePermissionRequest deletePermissionRequest) Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).default DeletePolicyResponse
deletePolicy
(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Deletes the resource-based policy attached to a private CA.default DeletePolicyResponse
deletePolicy
(DeletePolicyRequest deletePolicyRequest) Deletes the resource-based policy attached to a private CA.describeCertificateAuthority
(Consumer<DescribeCertificateAuthorityRequest.Builder> describeCertificateAuthorityRequest) Lists information about your private certificate authority (CA) or one that has been shared with you.describeCertificateAuthority
(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest) Lists information about your private certificate authority (CA) or one that has been shared with you.describeCertificateAuthorityAuditReport
(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest) Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action.describeCertificateAuthorityAuditReport
(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest) Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action.default GetCertificateResponse
getCertificate
(Consumer<GetCertificateRequest.Builder> getCertificateRequest) Retrieves a certificate from your private CA or one that has been shared with you.default GetCertificateResponse
getCertificate
(GetCertificateRequest getCertificateRequest) Retrieves a certificate from your private CA or one that has been shared with you.getCertificateAuthorityCertificate
(Consumer<GetCertificateAuthorityCertificateRequest.Builder> getCertificateAuthorityCertificateRequest) Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you.getCertificateAuthorityCertificate
(GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest) Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you.getCertificateAuthorityCsr
(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest) Retrieves the certificate signing request (CSR) for your private certificate authority (CA).getCertificateAuthorityCsr
(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest) Retrieves the certificate signing request (CSR) for your private certificate authority (CA).default GetPolicyResponse
getPolicy
(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Retrieves the resource-based policy attached to a private CA.default GetPolicyResponse
getPolicy
(GetPolicyRequest getPolicyRequest) Retrieves the resource-based policy attached to a private CA.importCertificateAuthorityCertificate
(Consumer<ImportCertificateAuthorityCertificateRequest.Builder> importCertificateAuthorityCertificateRequest) Imports a signed private CA certificate into Amazon Web Services Private CA.importCertificateAuthorityCertificate
(ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest) Imports a signed private CA certificate into Amazon Web Services Private CA.default IssueCertificateResponse
issueCertificate
(Consumer<IssueCertificateRequest.Builder> issueCertificateRequest) Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate.default IssueCertificateResponse
issueCertificate
(IssueCertificateRequest issueCertificateRequest) Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate.Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.listCertificateAuthorities
(Consumer<ListCertificateAuthoritiesRequest.Builder> listCertificateAuthoritiesRequest) Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.listCertificateAuthorities
(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.This is a variant oflistCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.listCertificateAuthoritiesPaginator
(Consumer<ListCertificateAuthoritiesRequest.Builder> listCertificateAuthoritiesRequest) This is a variant oflistCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.listCertificateAuthoritiesPaginator
(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) This is a variant oflistCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.default ListPermissionsResponse
listPermissions
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).default ListPermissionsResponse
listPermissions
(ListPermissionsRequest listPermissionsRequest) List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).default ListPermissionsIterable
listPermissionsPaginator
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation.default ListPermissionsIterable
listPermissionsPaginator
(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation.default ListTagsResponse
listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Lists the tags, if any, that are associated with your private CA or one that has been shared with you.default ListTagsResponse
listTags
(ListTagsRequest listTagsRequest) Lists the tags, if any, that are associated with your private CA or one that has been shared with you.default ListTagsIterable
listTagsPaginator
(Consumer<ListTagsRequest.Builder> listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation.default ListTagsIterable
listTagsPaginator
(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation.default PutPolicyResponse
putPolicy
(Consumer<PutPolicyRequest.Builder> putPolicyRequest) Attaches a resource-based policy to a private CA.default PutPolicyResponse
putPolicy
(PutPolicyRequest putPolicyRequest) Attaches a resource-based policy to a private CA.restoreCertificateAuthority
(Consumer<RestoreCertificateAuthorityRequest.Builder> restoreCertificateAuthorityRequest) Restores a certificate authority (CA) that is in theDELETED
state.restoreCertificateAuthority
(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest) Restores a certificate authority (CA) that is in theDELETED
state.default RevokeCertificateResponse
revokeCertificate
(Consumer<RevokeCertificateRequest.Builder> revokeCertificateRequest) Revokes a certificate that was issued inside Amazon Web Services Private CA.default RevokeCertificateResponse
revokeCertificate
(RevokeCertificateRequest revokeCertificateRequest) Revokes a certificate that was issued inside Amazon Web Services Private CA.default AcmPcaServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagCertificateAuthorityResponse
tagCertificateAuthority
(Consumer<TagCertificateAuthorityRequest.Builder> tagCertificateAuthorityRequest) Adds one or more tags to your private CA.default TagCertificateAuthorityResponse
tagCertificateAuthority
(TagCertificateAuthorityRequest tagCertificateAuthorityRequest) Adds one or more tags to your private CA.untagCertificateAuthority
(Consumer<UntagCertificateAuthorityRequest.Builder> untagCertificateAuthorityRequest) Remove one or more tags from your private CA.untagCertificateAuthority
(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest) Remove one or more tags from your private CA.updateCertificateAuthority
(Consumer<UpdateCertificateAuthorityRequest.Builder> updateCertificateAuthorityRequest) Updates the status or configuration of a private certificate authority (CA).updateCertificateAuthority
(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest) Updates the status or configuration of a private certificate authority (CA).default AcmPcaWaiter
waiter()
Create an instance ofAcmPcaWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createCertificateAuthority
default CreateCertificateAuthorityResponse createCertificateAuthority(CreateCertificateAuthorityRequest createCertificateAuthorityRequest) throws InvalidArgsException, InvalidPolicyException, InvalidTagException, LimitExceededException, AwsServiceException, SdkClientException, AcmPcaException Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
- Parameters:
createCertificateAuthorityRequest
-- Returns:
- Result of the CreateCertificateAuthority operation returned by the service.
- See Also:
-
createCertificateAuthority
default CreateCertificateAuthorityResponse createCertificateAuthority(Consumer<CreateCertificateAuthorityRequest.Builder> createCertificateAuthorityRequest) throws InvalidArgsException, InvalidPolicyException, InvalidTagException, LimitExceededException, AwsServiceException, SdkClientException, AcmPcaException Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, an optional configuration for Online Certificate Status Protocol (OCSP) and/or a certificate revocation list (CRL), the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The OCSP configuration can optionally specify a custom URL for the OCSP responder. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
This is a convenience which creates an instance of the
CreateCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaCreateCertificateAuthorityRequest.builder()
- Parameters:
createCertificateAuthorityRequest
- AConsumer
that will call methods onCreateCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the CreateCertificateAuthority operation returned by the service.
- See Also:
-
createCertificateAuthorityAuditReport
default CreateCertificateAuthorityAuditReportResponse createCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidArgsException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
You can generate a maximum of one report every 30 minutes.
- Parameters:
createCertificateAuthorityAuditReportRequest
-- Returns:
- Result of the CreateCertificateAuthorityAuditReport operation returned by the service.
- See Also:
-
createCertificateAuthorityAuditReport
default CreateCertificateAuthorityAuditReportResponse createCertificateAuthorityAuditReport(Consumer<CreateCertificateAuthorityAuditReportRequest.Builder> createCertificateAuthorityAuditReportRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidArgsException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
You can generate a maximum of one report every 30 minutes.
This is a convenience which creates an instance of the
CreateCertificateAuthorityAuditReportRequest.Builder
avoiding the need to create one manually viaCreateCertificateAuthorityAuditReportRequest.builder()
- Parameters:
createCertificateAuthorityAuditReportRequest
- AConsumer
that will call methods onCreateCertificateAuthorityAuditReportRequest.Builder
to create a request.- Returns:
- Result of the CreateCertificateAuthorityAuditReport operation returned by the service.
- See Also:
-
createPermission
default CreatePermissionResponse createPermission(CreatePermissionRequest createPermissionRequest) throws ResourceNotFoundException, InvalidArnException, PermissionAlreadyExistsException, LimitExceededException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (
acm.amazonaws.com
). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services 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 Amazon Web Services Private CA.
- Parameters:
createPermissionRequest
-- Returns:
- Result of the CreatePermission operation returned by the service.
- See Also:
-
-
createPermission
default CreatePermissionResponse createPermission(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) throws ResourceNotFoundException, InvalidArnException, PermissionAlreadyExistsException, LimitExceededException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (
acm.amazonaws.com
). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services 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 Amazon Web Services Private CA.
This is a convenience which creates an instance of the
CreatePermissionRequest.Builder
avoiding the need to create one manually viaCreatePermissionRequest.builder()
- Parameters:
createPermissionRequest
- AConsumer
that will call methods onCreatePermissionRequest.Builder
to create a request.- Returns:
- Result of the CreatePermission operation returned by the service.
- See Also:
-
-
deleteCertificateAuthority
default DeleteCertificateAuthorityResponse deleteCertificateAuthority(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest) throws ConcurrentModificationException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to
DISABLED
.Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is
CREATING
). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA isPENDING_CERTIFICATE
).When you successfully call DeleteCertificateAuthority, the CA's status changes to
DELETED
. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set thePermanentDeletionTimeInDays
parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in theDELETED
state. To restore an eligible CA, call the RestoreCertificateAuthority action.- Parameters:
deleteCertificateAuthorityRequest
-- Returns:
- Result of the DeleteCertificateAuthority operation returned by the service.
- See Also:
-
deleteCertificateAuthority
default DeleteCertificateAuthorityResponse deleteCertificateAuthority(Consumer<DeleteCertificateAuthorityRequest.Builder> deleteCertificateAuthorityRequest) throws ConcurrentModificationException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to
DISABLED
.Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is
CREATING
). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into Amazon Web Services Private CA (that is, the status of the CA isPENDING_CERTIFICATE
).When you successfully call DeleteCertificateAuthority, the CA's status changes to
DELETED
. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set thePermanentDeletionTimeInDays
parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in theDELETED
state. To restore an eligible CA, call the RestoreCertificateAuthority action.
This is a convenience which creates an instance of the
DeleteCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaDeleteCertificateAuthorityRequest.builder()
- Parameters:
deleteCertificateAuthorityRequest
- AConsumer
that will call methods onDeleteCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the DeleteCertificateAuthority operation returned by the service.
- See Also:
-
deletePermission
default DeletePermissionResponse deletePermission(DeletePermissionRequest deletePermissionRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services 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 Amazon Web Services Private CA.
- Parameters:
deletePermissionRequest
-- Returns:
- Result of the DeletePermission operation returned by the service.
- See Also:
-
-
deletePermission
default DeletePermissionResponse deletePermission(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services 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 Amazon Web Services Private CA.
This is a convenience which creates an instance of the
DeletePermissionRequest.Builder
avoiding the need to create one manually viaDeletePermissionRequest.builder()
- Parameters:
deletePermissionRequest
- AConsumer
that will call methods onDeletePermissionRequest.Builder
to create a request.- Returns:
- Result of the DeletePermission operation returned by the service.
- See Also:
-
-
deletePolicy
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws ConcurrentModificationException, InvalidArnException, InvalidStateException, LockoutPreventedException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.
If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.
The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.
The current policy can be shown with GetPolicy and updated with PutPolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
- Parameters:
deletePolicyRequest
-- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
-
deletePolicy
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws ConcurrentModificationException, InvalidArnException, InvalidStateException, LockoutPreventedException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.
If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.
The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.
The current policy can be shown with GetPolicy and updated with PutPolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builder
avoiding the need to create one manually viaDeletePolicyRequest.builder()
- Parameters:
deletePolicyRequest
- AConsumer
that will call methods onDeletePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeletePolicy operation returned by the service.
- See Also:
-
-
describeCertificateAuthority
default DescribeCertificateAuthorityResponse describeCertificateAuthority(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
-
CREATING
- Amazon Web Services Private CA is creating your private certificate authority. -
PENDING_CERTIFICATE
- The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA. -
ACTIVE
- Your private CA is active. -
DISABLED
- Your private CA has been disabled. -
EXPIRED
- Your private CA certificate has expired. -
FAILED
- Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. -
DELETED
- Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
- Parameters:
describeCertificateAuthorityRequest
-- Returns:
- Result of the DescribeCertificateAuthority operation returned by the service.
- See Also:
-
-
describeCertificateAuthority
default DescribeCertificateAuthorityResponse describeCertificateAuthority(Consumer<DescribeCertificateAuthorityRequest.Builder> describeCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
-
CREATING
- Amazon Web Services Private CA is creating your private certificate authority. -
PENDING_CERTIFICATE
- The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA. -
ACTIVE
- Your private CA is active. -
DISABLED
- Your private CA has been disabled. -
EXPIRED
- Your private CA certificate has expired. -
FAILED
- Your private CA has failed. Your CA can fail because of problems such a network outage or back-end Amazon Web Services failure or other errors. A failed CA can never return to the pending state. You must create a new CA. -
DELETED
- Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
This is a convenience which creates an instance of the
DescribeCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaDescribeCertificateAuthorityRequest.builder()
- Parameters:
describeCertificateAuthorityRequest
- AConsumer
that will call methods onDescribeCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the DescribeCertificateAuthority operation returned by the service.
- See Also:
-
-
describeCertificateAuthorityAuditReport
default DescribeCertificateAuthorityAuditReportResponse describeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest) throws ResourceNotFoundException, InvalidArnException, InvalidArgsException, AwsServiceException, SdkClientException, AcmPcaException Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
- Parameters:
describeCertificateAuthorityAuditReportRequest
-- Returns:
- Result of the DescribeCertificateAuthorityAuditReport operation returned by the service.
- See Also:
-
describeCertificateAuthorityAuditReport
default DescribeCertificateAuthorityAuditReportResponse describeCertificateAuthorityAuditReport(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest) throws ResourceNotFoundException, InvalidArnException, InvalidArgsException, AwsServiceException, SdkClientException, AcmPcaException Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
This is a convenience which creates an instance of the
DescribeCertificateAuthorityAuditReportRequest.Builder
avoiding the need to create one manually viaDescribeCertificateAuthorityAuditReportRequest.builder()
- Parameters:
describeCertificateAuthorityAuditReportRequest
- AConsumer
that will call methods onDescribeCertificateAuthorityAuditReportRequest.Builder
to create a request.- Returns:
- Result of the DescribeCertificateAuthorityAuditReport operation returned by the service.
- See Also:
-
getCertificate
default GetCertificateResponse getCertificate(GetCertificateRequest getCertificateRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
- Parameters:
getCertificateRequest
-- Returns:
- Result of the GetCertificate operation returned by the service.
- See Also:
-
getCertificate
default GetCertificateResponse getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
This is a convenience which creates an instance of the
GetCertificateRequest.Builder
avoiding the need to create one manually viaGetCertificateRequest.builder()
- Parameters:
getCertificateRequest
- AConsumer
that will call methods onGetCertificateRequest.Builder
to create a request.- Returns:
- Result of the GetCertificate operation returned by the service.
- See Also:
-
getCertificateAuthorityCertificate
default GetCertificateAuthorityCertificateResponse getCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
- Parameters:
getCertificateAuthorityCertificateRequest
-- Returns:
- Result of the GetCertificateAuthorityCertificate operation returned by the service.
- See Also:
-
getCertificateAuthorityCertificate
default GetCertificateAuthorityCertificateResponse getCertificateAuthorityCertificate(Consumer<GetCertificateAuthorityCertificateRequest.Builder> getCertificateAuthorityCertificateRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
This is a convenience which creates an instance of the
GetCertificateAuthorityCertificateRequest.Builder
avoiding the need to create one manually viaGetCertificateAuthorityCertificateRequest.builder()
- Parameters:
getCertificateAuthorityCertificateRequest
- AConsumer
that will call methods onGetCertificateAuthorityCertificateRequest.Builder
to create a request.- Returns:
- Result of the GetCertificateAuthorityCertificate operation returned by the service.
- See Also:
-
getCertificateAuthorityCsr
default GetCertificateAuthorityCsrResponse getCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
- Parameters:
getCertificateAuthorityCsrRequest
-- Returns:
- Result of the GetCertificateAuthorityCsr operation returned by the service.
- See Also:
-
getCertificateAuthorityCsr
default GetCertificateAuthorityCsrResponse getCertificateAuthorityCsr(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest) throws RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
This is a convenience which creates an instance of the
GetCertificateAuthorityCsrRequest.Builder
avoiding the need to create one manually viaGetCertificateAuthorityCsrRequest.builder()
- Parameters:
getCertificateAuthorityCsrRequest
- AConsumer
that will call methods onGetCertificateAuthorityCsrRequest.Builder
to create a request.- Returns:
- Result of the GetCertificateAuthorityCsr operation returned by the service.
- See Also:
-
getPolicy
default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws InvalidArnException, InvalidStateException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a
ResourceNotFoundException
.The policy can be attached or updated with PutPolicy and removed with DeletePolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
- Parameters:
getPolicyRequest
-- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
-
-
getPolicy
default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) throws InvalidArnException, InvalidStateException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a
ResourceNotFoundException
.The policy can be attached or updated with PutPolicy and removed with DeletePolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
This is a convenience which creates an instance of the
GetPolicyRequest.Builder
avoiding the need to create one manually viaGetPolicyRequest.builder()
- Parameters:
getPolicyRequest
- AConsumer
that will call methods onGetPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetPolicy operation returned by the service.
- See Also:
-
-
importCertificateAuthorityCertificate
default ImportCertificateAuthorityCertificateResponse importCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest) throws ConcurrentModificationException, RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidRequestException, InvalidStateException, MalformedCertificateException, CertificateMismatchException, AwsServiceException, SdkClientException, AcmPcaException Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:
-
In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
-
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
-
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
-
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
-
Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
-
Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.
-
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following additional requirements apply when you import a CA certificate.
-
Only a self-signed certificate can be imported as a root CA.
-
A self-signed certificate cannot be imported as a subordinate CA.
-
Your certificate chain must not include the private CA certificate that you are importing.
-
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
-
The chain must be PEM-encoded.
-
The maximum allowed size of a certificate is 32 KB.
-
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
-
Basic constraints (must be marked critical)
-
Subject alternative names
-
Key usage
-
Extended key usage
-
Authority key identifier
-
Subject key identifier
-
Issuer alternative name
-
Subject directory attributes
-
Subject information access
-
Certificate policies
-
Policy mappings
-
Inhibit anyPolicy
Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
-
Name constraints
-
Policy constraints
-
CRL distribution points
-
Authority information access
-
Freshest CRL
-
Any other extension
- Parameters:
importCertificateAuthorityCertificateRequest
-- Returns:
- Result of the ImportCertificateAuthorityCertificate operation returned by the service.
- See Also:
-
-
importCertificateAuthorityCertificate
default ImportCertificateAuthorityCertificateResponse importCertificateAuthorityCertificate(Consumer<ImportCertificateAuthorityCertificateRequest.Builder> importCertificateAuthorityCertificateRequest) throws ConcurrentModificationException, RequestInProgressException, RequestFailedException, ResourceNotFoundException, InvalidArnException, InvalidRequestException, InvalidStateException, MalformedCertificateException, CertificateMismatchException, AwsServiceException, SdkClientException, AcmPcaException Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:
-
In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
-
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
-
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
-
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
-
Installing a certificate for a root CA hosted by Amazon Web Services Private CA.
-
Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA.
-
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following additional requirements apply when you import a CA certificate.
-
Only a self-signed certificate can be imported as a root CA.
-
A self-signed certificate cannot be imported as a subordinate CA.
-
Your certificate chain must not include the private CA certificate that you are importing.
-
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
-
The chain must be PEM-encoded.
-
The maximum allowed size of a certificate is 32 KB.
-
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
-
Basic constraints (must be marked critical)
-
Subject alternative names
-
Key usage
-
Extended key usage
-
Authority key identifier
-
Subject key identifier
-
Issuer alternative name
-
Subject directory attributes
-
Subject information access
-
Certificate policies
-
Policy mappings
-
Inhibit anyPolicy
Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
-
Name constraints
-
Policy constraints
-
CRL distribution points
-
Authority information access
-
Freshest CRL
-
Any other extension
This is a convenience which creates an instance of the
ImportCertificateAuthorityCertificateRequest.Builder
avoiding the need to create one manually viaImportCertificateAuthorityCertificateRequest.builder()
- Parameters:
importCertificateAuthorityCertificateRequest
- AConsumer
that will call methods onImportCertificateAuthorityCertificateRequest.Builder
to create a request.- Returns:
- Result of the ImportCertificateAuthorityCertificate operation returned by the service.
- See Also:
-
-
issueCertificate
default IssueCertificateResponse issueCertificate(IssueCertificateRequest issueCertificateRequest) throws LimitExceededException, ResourceNotFoundException, InvalidStateException, InvalidArnException, InvalidArgsException, MalformedCsrException, AwsServiceException, SdkClientException, AcmPcaException Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.
- Parameters:
issueCertificateRequest
-- Returns:
- Result of the IssueCertificate operation returned by the service.
- See Also:
-
issueCertificate
default IssueCertificateResponse issueCertificate(Consumer<IssueCertificateRequest.Builder> issueCertificateRequest) throws LimitExceededException, ResourceNotFoundException, InvalidStateException, InvalidArnException, InvalidArgsException, MalformedCsrException, AwsServiceException, SdkClientException, AcmPcaException Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.
This is a convenience which creates an instance of the
IssueCertificateRequest.Builder
avoiding the need to create one manually viaIssueCertificateRequest.builder()
- Parameters:
issueCertificateRequest
- AConsumer
that will call methods onIssueCertificateRequest.Builder
to create a request.- Returns:
- Result of the IssueCertificate operation returned by the service.
- See Also:
-
listCertificateAuthorities
default ListCertificateAuthoritiesResponse listCertificateAuthorities(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaException Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
- Parameters:
listCertificateAuthoritiesRequest
-- Returns:
- Result of the ListCertificateAuthorities operation returned by the service.
- See Also:
-
listCertificateAuthorities
default ListCertificateAuthoritiesResponse listCertificateAuthorities(Consumer<ListCertificateAuthoritiesRequest.Builder> listCertificateAuthoritiesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaException Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
This is a convenience which creates an instance of the
ListCertificateAuthoritiesRequest.Builder
avoiding the need to create one manually viaListCertificateAuthoritiesRequest.builder()
- Parameters:
listCertificateAuthoritiesRequest
- AConsumer
that will call methods onListCertificateAuthoritiesRequest.Builder
to create a request.- Returns:
- Result of the ListCertificateAuthorities operation returned by the service.
- See Also:
-
listCertificateAuthorities
default ListCertificateAuthoritiesResponse listCertificateAuthorities() throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaExceptionLists the private certificate authorities that you created by using the CreateCertificateAuthority action.
- Returns:
- Result of the ListCertificateAuthorities operation returned by the service.
- See Also:
-
listCertificateAuthoritiesPaginator
default ListCertificateAuthoritiesIterable listCertificateAuthoritiesPaginator() throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaExceptionThis is a variant of
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client .listCertificateAuthoritiesPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCertificateAuthoritiesPaginator
default ListCertificateAuthoritiesIterable listCertificateAuthoritiesPaginator(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client .listCertificateAuthoritiesPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.- Parameters:
listCertificateAuthoritiesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCertificateAuthoritiesPaginator
default ListCertificateAuthoritiesIterable listCertificateAuthoritiesPaginator(Consumer<ListCertificateAuthoritiesRequest.Builder> listCertificateAuthoritiesRequest) throws InvalidNextTokenException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client .listCertificateAuthoritiesPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListCertificateAuthoritiesIterable responses = client.listCertificateAuthoritiesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificateAuthorities(software.amazon.awssdk.services.acmpca.model.ListCertificateAuthoritiesRequest)
operation.
This is a convenience which creates an instance of the
ListCertificateAuthoritiesRequest.Builder
avoiding the need to create one manually viaListCertificateAuthoritiesRequest.builder()
- Parameters:
listCertificateAuthoritiesRequest
- AConsumer
that will call methods onListCertificateAuthoritiesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissions
default ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidNextTokenException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.
Permissions can be granted with the CreatePermission action and revoked 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 Amazon Web Services Private CA.
- Parameters:
listPermissionsRequest
-- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
-
listPermissions
default ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidNextTokenException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA.
Permissions can be granted with the CreatePermission action and revoked 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 Amazon Web Services Private CA.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidNextTokenException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client .listPermissionsPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation.- Parameters:
listPermissionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidNextTokenException, InvalidStateException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client .listPermissionsPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.acmpca.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation.- Parameters:
listTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, AwsServiceException, SdkClientException, AcmPcaException This is a variant of
listTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.acmpca.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.acmpca.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.acmpca.model.ListTagsRequest)
operation.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putPolicy
default PutPolicyResponse putPolicy(PutPolicyRequest putPolicyRequest) throws ConcurrentModificationException, InvalidArnException, InvalidStateException, InvalidPolicyException, LockoutPreventedException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Attaches a resource-based policy to a private CA.
A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.
The policy can be displayed with GetPolicy and removed with DeletePolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
- Parameters:
putPolicyRequest
-- Returns:
- Result of the PutPolicy operation returned by the service.
- See Also:
-
-
putPolicy
default PutPolicyResponse putPolicy(Consumer<PutPolicyRequest.Builder> putPolicyRequest) throws ConcurrentModificationException, InvalidArnException, InvalidStateException, InvalidPolicyException, LockoutPreventedException, RequestFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, AcmPcaException Attaches a resource-based policy to a private CA.
A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access.
The policy can be displayed with GetPolicy and removed with DeletePolicy.
About Policies
-
A policy grants access on a private CA to an Amazon Web Services customer account, to Amazon Web Services Organizations, or to an Amazon Web Services Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA.
-
A policy permits a user of Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
-
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the Amazon Web Services Private CA policy. For more information, see Using a Service Linked Role with ACM.
-
Updates made in Amazon Web Services Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
This is a convenience which creates an instance of the
PutPolicyRequest.Builder
avoiding the need to create one manually viaPutPolicyRequest.builder()
- Parameters:
putPolicyRequest
- AConsumer
that will call methods onPutPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutPolicy operation returned by the service.
- See Also:
-
-
restoreCertificateAuthority
default RestoreCertificateAuthorityResponse restoreCertificateAuthority(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Restores a certificate authority (CA) that is in the
DELETED
state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in theDELETED
state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status toACTIVE
, call the UpdateCertificateAuthority action. If the private CA was in thePENDING_CERTIFICATE
state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.- Parameters:
restoreCertificateAuthorityRequest
-- Returns:
- Result of the RestoreCertificateAuthority operation returned by the service.
- See Also:
-
restoreCertificateAuthority
default RestoreCertificateAuthorityResponse restoreCertificateAuthority(Consumer<RestoreCertificateAuthorityRequest.Builder> restoreCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidStateException, InvalidArnException, AwsServiceException, SdkClientException, AcmPcaException Restores a certificate authority (CA) that is in the
DELETED
state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in theDELETED
state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status toACTIVE
, call the UpdateCertificateAuthority action. If the private CA was in thePENDING_CERTIFICATE
state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
This is a convenience which creates an instance of the
RestoreCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaRestoreCertificateAuthorityRequest.builder()
- Parameters:
restoreCertificateAuthorityRequest
- AConsumer
that will call methods onRestoreCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the RestoreCertificateAuthority operation returned by the service.
- See Also:
-
revokeCertificate
default RevokeCertificateResponse revokeCertificate(RevokeCertificateRequest revokeCertificateRequest) throws ConcurrentModificationException, InvalidArnException, InvalidRequestException, InvalidStateException, LimitExceededException, ResourceNotFoundException, RequestAlreadyProcessedException, RequestInProgressException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
CRLGenerated
andMisconfiguredCRLBucket
. For more information, see Supported CloudWatch Metrics.Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
- Parameters:
revokeCertificateRequest
-- Returns:
- Result of the RevokeCertificate operation returned by the service.
- See Also:
-
revokeCertificate
default RevokeCertificateResponse revokeCertificate(Consumer<RevokeCertificateRequest.Builder> revokeCertificateRequest) throws ConcurrentModificationException, InvalidArnException, InvalidRequestException, InvalidStateException, LimitExceededException, ResourceNotFoundException, RequestAlreadyProcessedException, RequestInProgressException, RequestFailedException, AwsServiceException, SdkClientException, AcmPcaException Revokes a certificate that was issued inside Amazon Web Services Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. Amazon Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, Amazon Web Services Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
CRLGenerated
andMisconfiguredCRLBucket
. For more information, see Supported CloudWatch Metrics.Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
This is a convenience which creates an instance of the
RevokeCertificateRequest.Builder
avoiding the need to create one manually viaRevokeCertificateRequest.builder()
- Parameters:
revokeCertificateRequest
- AConsumer
that will call methods onRevokeCertificateRequest.Builder
to create a request.- Returns:
- Result of the RevokeCertificate operation returned by the service.
- See Also:
-
tagCertificateAuthority
default TagCertificateAuthorityResponse tagCertificateAuthority(TagCertificateAuthorityRequest tagCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, InvalidTagException, TooManyTagsException, AwsServiceException, SdkClientException, AcmPcaException Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the
CreateCertificateAuthority
action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation.- Parameters:
tagCertificateAuthorityRequest
-- Returns:
- Result of the TagCertificateAuthority operation returned by the service.
- See Also:
-
tagCertificateAuthority
default TagCertificateAuthorityResponse tagCertificateAuthority(Consumer<TagCertificateAuthorityRequest.Builder> tagCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, InvalidTagException, TooManyTagsException, AwsServiceException, SdkClientException, AcmPcaException Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the
CreateCertificateAuthority
action and explicitly allow tagging. For more information, see Attaching tags to a CA at the time of creation.
This is a convenience which creates an instance of the
TagCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaTagCertificateAuthorityRequest.builder()
- Parameters:
tagCertificateAuthorityRequest
- AConsumer
that will call methods onTagCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the TagCertificateAuthority operation returned by the service.
- See Also:
-
untagCertificateAuthority
default UntagCertificateAuthorityResponse untagCertificateAuthority(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, InvalidTagException, AwsServiceException, SdkClientException, AcmPcaException Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.
- Parameters:
untagCertificateAuthorityRequest
-- Returns:
- Result of the UntagCertificateAuthority operation returned by the service.
- See Also:
-
untagCertificateAuthority
default UntagCertificateAuthorityResponse untagCertificateAuthority(Consumer<UntagCertificateAuthorityRequest.Builder> untagCertificateAuthorityRequest) throws ResourceNotFoundException, InvalidArnException, InvalidStateException, InvalidTagException, AwsServiceException, SdkClientException, AcmPcaException Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.
This is a convenience which creates an instance of the
UntagCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaUntagCertificateAuthorityRequest.builder()
- Parameters:
untagCertificateAuthorityRequest
- AConsumer
that will call methods onUntagCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the UntagCertificateAuthority operation returned by the service.
- See Also:
-
updateCertificateAuthority
default UpdateCertificateAuthorityResponse updateCertificateAuthority(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest) throws ConcurrentModificationException, ResourceNotFoundException, InvalidArgsException, InvalidArnException, InvalidStateException, InvalidPolicyException, AwsServiceException, SdkClientException, AcmPcaException Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
ACTIVE
orDISABLED
state before you can update it. You can disable a private CA that is in theACTIVE
state or make a CA that is in theDISABLED
state active again.Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
- Parameters:
updateCertificateAuthorityRequest
-- Returns:
- Result of the UpdateCertificateAuthority operation returned by the service.
- See Also:
-
updateCertificateAuthority
default UpdateCertificateAuthorityResponse updateCertificateAuthority(Consumer<UpdateCertificateAuthorityRequest.Builder> updateCertificateAuthorityRequest) throws ConcurrentModificationException, ResourceNotFoundException, InvalidArgsException, InvalidArnException, InvalidStateException, InvalidPolicyException, AwsServiceException, SdkClientException, AcmPcaException Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
ACTIVE
orDISABLED
state before you can update it. You can disable a private CA that is in theACTIVE
state or make a CA that is in theDISABLED
state active again.Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.
This is a convenience which creates an instance of the
UpdateCertificateAuthorityRequest.Builder
avoiding the need to create one manually viaUpdateCertificateAuthorityRequest.builder()
- Parameters:
updateCertificateAuthorityRequest
- AConsumer
that will call methods onUpdateCertificateAuthorityRequest.Builder
to create a request.- Returns:
- Result of the UpdateCertificateAuthority operation returned by the service.
- See Also:
-
waiter
Create an instance ofAcmPcaWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AcmPcaWaiter
-
create
Create aAcmPcaClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAcmPcaClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-