@Generated(value="software.amazon.awssdk:codegen") public interface AcmPcaAsyncClient extends SdkClient
builder()
method.
You can use the ACM PCA API to create a private certificate authority (CA). You must first call the CreateCertificateAuthority operation. If successful, the operation returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the GetCertificateAuthorityCsr operation to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the ImportCertificateAuthorityCertificate to import your signed private CA certificate into ACM PCA.
Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the IssueCertificate operation to issue a certificate. Call the RevokeCertificate operation to revoke a certificate.
Certificates issued by your private CA can be trusted only within your organization, not publicly.
Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a RevocationConfiguration object when you call the CreateCertificateAuthority operation. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission.
You can also call the CreateCertificateAuthorityAuditReport to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the IssueCertificate or RevokeCertificate operation is called.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static AcmPcaAsyncClient create()
AcmPcaAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static AcmPcaAsyncClientBuilder builder()
AcmPcaAsyncClient
.default CompletableFuture<CreateCertificateAuthorityResponse> createCertificateAuthority(CreateCertificateAuthorityRequest createCertificateAuthorityRequest)
Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. 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 to sign, and X.500 subject information. The CRL (certificate revocation list) 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 operation returns the Amazon Resource Name (ARN) of the CA.
createCertificateAuthorityRequest
- default CompletableFuture<CreateCertificateAuthorityResponse> createCertificateAuthority(Consumer<CreateCertificateAuthorityRequest.Builder> createCertificateAuthorityRequest)
Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. 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 to sign, and X.500 subject information. The CRL (certificate revocation list) 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 operation returns the Amazon Resource Name (ARN) of the CA.
This is a convenience which creates an instance of the CreateCertificateAuthorityRequest.Builder
avoiding
the need to create one manually via CreateCertificateAuthorityRequest.builder()
createCertificateAuthorityRequest
- A Consumer
that will call methods on CreateCertificateAuthorityRequest.Builder
to create a
request.default CompletableFuture<CreateCertificateAuthorityAuditReportResponse> createCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest createCertificateAuthorityAuditReportRequest)
Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.
createCertificateAuthorityAuditReportRequest
- default CompletableFuture<CreateCertificateAuthorityAuditReportResponse> createCertificateAuthorityAuditReport(Consumer<CreateCertificateAuthorityAuditReportRequest.Builder> createCertificateAuthorityAuditReportRequest)
Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.
This is a convenience which creates an instance of the
CreateCertificateAuthorityAuditReportRequest.Builder
avoiding the need to create one manually via
CreateCertificateAuthorityAuditReportRequest.builder()
createCertificateAuthorityAuditReportRequest
- A Consumer
that will call methods on CreateCertificateAuthorityAuditReportRequest.Builder
to create a request.default CompletableFuture<DeleteCertificateAuthorityResponse> deleteCertificateAuthority(DeleteCertificateAuthorityRequest deleteCertificateAuthorityRequest)
Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA
that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before
you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the
CertificateAuthorityStatus parameter to DISABLED
.
Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the
CertificateAuthority is CREATING
). You can also delete it if the CA has been created but you
haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE
) into ACM PCA.
If the CA is in one of the aforementioned states and you call DeleteCertificateAuthority, the CA's status
changes to DELETED
. However, the CA won't be permentantly deleted until the restoration period has
passed. By default, if you do not set the PermanentDeletionTimeInDays
parameter, the CA remains
restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority
operation returns the time remaining in the restoration window of a Private CA in the DELETED
state.
To restore an eligable CA, call the RestoreCertificateAuthority operation.
deleteCertificateAuthorityRequest
- default CompletableFuture<DeleteCertificateAuthorityResponse> deleteCertificateAuthority(Consumer<DeleteCertificateAuthorityRequest.Builder> deleteCertificateAuthorityRequest)
Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA
that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before
you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the
CertificateAuthorityStatus parameter to DISABLED
.
Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the
CertificateAuthority is CREATING
). You can also delete it if the CA has been created but you
haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE
) into ACM PCA.
If the CA is in one of the aforementioned states and you call DeleteCertificateAuthority, the CA's status
changes to DELETED
. However, the CA won't be permentantly deleted until the restoration period has
passed. By default, if you do not set the PermanentDeletionTimeInDays
parameter, the CA remains
restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority
operation returns the time remaining in the restoration window of a Private CA in the DELETED
state.
To restore an eligable CA, call the RestoreCertificateAuthority operation.
This is a convenience which creates an instance of the DeleteCertificateAuthorityRequest.Builder
avoiding
the need to create one manually via DeleteCertificateAuthorityRequest.builder()
deleteCertificateAuthorityRequest
- A Consumer
that will call methods on DeleteCertificateAuthorityRequest.Builder
to create a
request.default CompletableFuture<DescribeCertificateAuthorityResponse> describeCertificateAuthority(DescribeCertificateAuthorityRequest describeCertificateAuthorityRequest)
Lists information about your private certificate authority (CA). 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
- ACM PCA is creating your private certificate authority.
PENDING_CERTIFICATE
- The certificate is pending. You must use your on-premises root or subordinate
CA to sign your private CA CSR and then import it into PCA.
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
backend AWS 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 will be permanently
deleted. The length of time remaining in the CA's restoration period will also be included in this operation's
output.
describeCertificateAuthorityRequest
- default CompletableFuture<DescribeCertificateAuthorityResponse> describeCertificateAuthority(Consumer<DescribeCertificateAuthorityRequest.Builder> describeCertificateAuthorityRequest)
Lists information about your private certificate authority (CA). 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
- ACM PCA is creating your private certificate authority.
PENDING_CERTIFICATE
- The certificate is pending. You must use your on-premises root or subordinate
CA to sign your private CA CSR and then import it into PCA.
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
backend AWS 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 will be permanently
deleted. The length of time remaining in the CA's restoration period will also be included in this operation's
output.
This is a convenience which creates an instance of the DescribeCertificateAuthorityRequest.Builder
avoiding the need to create one manually via DescribeCertificateAuthorityRequest.builder()
describeCertificateAuthorityRequest
- A Consumer
that will call methods on DescribeCertificateAuthorityRequest.Builder
to create
a request.default CompletableFuture<DescribeCertificateAuthorityAuditReportResponse> describeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest describeCertificateAuthorityAuditReportRequest)
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation.
describeCertificateAuthorityAuditReportRequest
- default CompletableFuture<DescribeCertificateAuthorityAuditReportResponse> describeCertificateAuthorityAuditReport(Consumer<DescribeCertificateAuthorityAuditReportRequest.Builder> describeCertificateAuthorityAuditReportRequest)
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation.
This is a convenience which creates an instance of the
DescribeCertificateAuthorityAuditReportRequest.Builder
avoiding the need to create one manually via
DescribeCertificateAuthorityAuditReportRequest.builder()
describeCertificateAuthorityAuditReportRequest
- A Consumer
that will call methods on
DescribeCertificateAuthorityAuditReportRequest.Builder
to create a request.default CompletableFuture<GetCertificateResponse> getCertificate(GetCertificateRequest getCertificateRequest)
Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report that contains information about all of the certificates issued and revoked by your private CA.
getCertificateRequest
- default CompletableFuture<GetCertificateResponse> getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest)
Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation 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 via GetCertificateRequest.builder()
getCertificateRequest
- A Consumer
that will call methods on GetCertificateRequest.Builder
to create a request.default CompletableFuture<GetCertificateAuthorityCertificateResponse> getCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest getCertificateAuthorityCertificateRequest)
Retrieves the certificate and certificate chain for your private certificate authority (CA). 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.
getCertificateAuthorityCertificateRequest
- default CompletableFuture<GetCertificateAuthorityCertificateResponse> getCertificateAuthorityCertificate(Consumer<GetCertificateAuthorityCertificateRequest.Builder> getCertificateAuthorityCertificateRequest)
Retrieves the certificate and certificate chain for your private certificate authority (CA). 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 via GetCertificateAuthorityCertificateRequest.builder()
getCertificateAuthorityCertificateRequest
- A Consumer
that will call methods on GetCertificateAuthorityCertificateRequest.Builder
to
create a request.default CompletableFuture<GetCertificateAuthorityCsrResponse> getCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest getCertificateAuthorityCsrRequest)
Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string.
getCertificateAuthorityCsrRequest
- default CompletableFuture<GetCertificateAuthorityCsrResponse> getCertificateAuthorityCsr(Consumer<GetCertificateAuthorityCsrRequest.Builder> getCertificateAuthorityCsrRequest)
Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate operation. 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 via GetCertificateAuthorityCsrRequest.builder()
getCertificateAuthorityCsrRequest
- A Consumer
that will call methods on GetCertificateAuthorityCsrRequest.Builder
to create a
request.default CompletableFuture<ImportCertificateAuthorityCertificateResponse> importCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest importCertificateAuthorityCertificateRequest)
Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Your certificate chain must not include the private CA certificate that you are importing.
Your on-premises CA certificate 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.
importCertificateAuthorityCertificateRequest
- default CompletableFuture<ImportCertificateAuthorityCertificateResponse> importCertificateAuthorityCertificate(Consumer<ImportCertificateAuthorityCertificateRequest.Builder> importCertificateAuthorityCertificateRequest)
Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Your certificate chain must not include the private CA certificate that you are importing.
Your on-premises CA certificate 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.
This is a convenience which creates an instance of the
ImportCertificateAuthorityCertificateRequest.Builder
avoiding the need to create one manually via
ImportCertificateAuthorityCertificateRequest.builder()
importCertificateAuthorityCertificateRequest
- A Consumer
that will call methods on ImportCertificateAuthorityCertificateRequest.Builder
to create a request.default CompletableFuture<IssueCertificateResponse> issueCertificate(IssueCertificateRequest issueCertificateRequest)
Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.
issueCertificateRequest
- default CompletableFuture<IssueCertificateResponse> issueCertificate(Consumer<IssueCertificateRequest.Builder> issueCertificateRequest)
Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.
This is a convenience which creates an instance of the IssueCertificateRequest.Builder
avoiding the need
to create one manually via IssueCertificateRequest.builder()
issueCertificateRequest
- A Consumer
that will call methods on IssueCertificateRequest.Builder
to create a request.default CompletableFuture<ListCertificateAuthoritiesResponse> listCertificateAuthorities(ListCertificateAuthoritiesRequest listCertificateAuthoritiesRequest)
Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
listCertificateAuthoritiesRequest
- NextToken
argument is not valid.
Use the token returned from your previous call to ListCertificateAuthorities.default CompletableFuture<ListCertificateAuthoritiesResponse> listCertificateAuthorities(Consumer<ListCertificateAuthoritiesRequest.Builder> listCertificateAuthoritiesRequest)
Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
This is a convenience which creates an instance of the ListCertificateAuthoritiesRequest.Builder
avoiding
the need to create one manually via ListCertificateAuthoritiesRequest.builder()
listCertificateAuthoritiesRequest
- A Consumer
that will call methods on ListCertificateAuthoritiesRequest.Builder
to create a
request.NextToken
argument is not valid.
Use the token returned from your previous call to ListCertificateAuthorities.default CompletableFuture<ListCertificateAuthoritiesResponse> listCertificateAuthorities()
Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
NextToken
argument is not valid.
Use the token returned from your previous call to ListCertificateAuthorities.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest)
Lists the tags, if any, that are associated with your private CA. 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 operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
listTagsRequest
- default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists the tags, if any, that are associated with your private CA. 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 operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
This is a convenience which creates an instance of the ListTagsRequest.Builder
avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest
- A Consumer
that will call methods on ListTagsRequest.Builder
to create a request.default CompletableFuture<RestoreCertificateAuthorityResponse> restoreCertificateAuthority(RestoreCertificateAuthorityRequest restoreCertificateAuthorityRequest)
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 operation. 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 the DELETED
state by
calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a
restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To
change its status to ACTIVE
, call the UpdateCertificateAuthority operation. If the private CA
was in the PENDING_CERTIFICATE
state at deletion, you must use the
ImportCertificateAuthorityCertificate operation 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.
restoreCertificateAuthorityRequest
- default CompletableFuture<RestoreCertificateAuthorityResponse> restoreCertificateAuthority(Consumer<RestoreCertificateAuthorityRequest.Builder> restoreCertificateAuthorityRequest)
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 operation. 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 the DELETED
state by
calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a
restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To
change its status to ACTIVE
, call the UpdateCertificateAuthority operation. If the private CA
was in the PENDING_CERTIFICATE
state at deletion, you must use the
ImportCertificateAuthorityCertificate operation 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 via RestoreCertificateAuthorityRequest.builder()
restoreCertificateAuthorityRequest
- A Consumer
that will call methods on RestoreCertificateAuthorityRequest.Builder
to create
a request.default CompletableFuture<RevokeCertificateResponse> revokeCertificate(RevokeCertificateRequest revokeCertificateRequest)
Revokes a certificate that you issued by calling the IssueCertificate operation. 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. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
revokeCertificateRequest
- default CompletableFuture<RevokeCertificateResponse> revokeCertificate(Consumer<RevokeCertificateRequest.Builder> revokeCertificateRequest)
Revokes a certificate that you issued by calling the IssueCertificate operation. 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. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
This is a convenience which creates an instance of the RevokeCertificateRequest.Builder
avoiding the need
to create one manually via RevokeCertificateRequest.builder()
revokeCertificateRequest
- A Consumer
that will call methods on RevokeCertificateRequest.Builder
to create a request.default CompletableFuture<TagCertificateAuthorityResponse> tagCertificateAuthority(TagCertificateAuthorityRequest tagCertificateAuthorityRequest)
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS 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 operation. Call the ListTags operation to see what tags are associated with your CA.
tagCertificateAuthorityRequest
- default CompletableFuture<TagCertificateAuthorityResponse> tagCertificateAuthority(Consumer<TagCertificateAuthorityRequest.Builder> tagCertificateAuthorityRequest)
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS 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 operation. Call the ListTags operation to see what tags are associated with your CA.
This is a convenience which creates an instance of the TagCertificateAuthorityRequest.Builder
avoiding
the need to create one manually via TagCertificateAuthorityRequest.builder()
tagCertificateAuthorityRequest
- A Consumer
that will call methods on TagCertificateAuthorityRequest.Builder
to create a
request.default CompletableFuture<UntagCertificateAuthorityResponse> untagCertificateAuthority(UntagCertificateAuthorityRequest untagCertificateAuthorityRequest)
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 operation, 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 operation to see what tags are associated with your CA.
untagCertificateAuthorityRequest
- default CompletableFuture<UntagCertificateAuthorityResponse> untagCertificateAuthority(Consumer<UntagCertificateAuthorityRequest.Builder> untagCertificateAuthorityRequest)
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 operation, 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 operation 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 via UntagCertificateAuthorityRequest.builder()
untagCertificateAuthorityRequest
- A Consumer
that will call methods on UntagCertificateAuthorityRequest.Builder
to create a
request.default CompletableFuture<UpdateCertificateAuthorityResponse> updateCertificateAuthority(UpdateCertificateAuthorityRequest updateCertificateAuthorityRequest)
Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
ACTIVE
or DISABLED
state before you can update it. You can disable a private CA that is
in the ACTIVE
state or make a CA that is in the DISABLED
state active again.
updateCertificateAuthorityRequest
- default CompletableFuture<UpdateCertificateAuthorityResponse> updateCertificateAuthority(Consumer<UpdateCertificateAuthorityRequest.Builder> updateCertificateAuthorityRequest)
Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the
ACTIVE
or DISABLED
state before you can update it. You can disable a private CA that is
in the ACTIVE
state or make a CA that is in the DISABLED
state active again.
This is a convenience which creates an instance of the UpdateCertificateAuthorityRequest.Builder
avoiding
the need to create one manually via UpdateCertificateAuthorityRequest.builder()
updateCertificateAuthorityRequest
- A Consumer
that will call methods on UpdateCertificateAuthorityRequest.Builder
to create a
request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.