Class: Aws::ACMPCA::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ACMPCA::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-acmpca/client.rb
Overview
An API client for ACMPCA. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ACMPCA::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_certificate_authority(params = {}) ⇒ Types::CreateCertificateAuthorityResponse
Creates a root or subordinate private certificate authority (CA).
-
#create_certificate_authority_audit_report(params = {}) ⇒ Types::CreateCertificateAuthorityAuditReportResponse
Creates an audit report that lists every time that your CA private key is used.
-
#create_permission(params = {}) ⇒ Struct
Grants one or more permissions on a private CA to the Certificate Manager (ACM) service principal (‘acm.amazonaws.com`).
-
#delete_certificate_authority(params = {}) ⇒ Struct
Deletes a private certificate authority (CA).
-
#delete_permission(params = {}) ⇒ Struct
Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
-
#delete_policy(params = {}) ⇒ Struct
Deletes the resource-based policy attached to a private CA.
-
#describe_certificate_authority(params = {}) ⇒ Types::DescribeCertificateAuthorityResponse
Lists information about your private certificate authority (CA) or one that has been shared with you.
-
#describe_certificate_authority_audit_report(params = {}) ⇒ Types::DescribeCertificateAuthorityAuditReportResponse
Lists information about a specific audit report created by calling the [CreateCertificateAuthorityAuditReport] action.
-
#get_certificate(params = {}) ⇒ Types::GetCertificateResponse
Retrieves a certificate from your private CA or one that has been shared with you.
-
#get_certificate_authority_certificate(params = {}) ⇒ Types::GetCertificateAuthorityCertificateResponse
Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you.
-
#get_certificate_authority_csr(params = {}) ⇒ Types::GetCertificateAuthorityCsrResponse
Retrieves the certificate signing request (CSR) for your private certificate authority (CA).
-
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
Retrieves the resource-based policy attached to a private CA.
-
#import_certificate_authority_certificate(params = {}) ⇒ Struct
Imports a signed private CA certificate into Amazon Web Services Private CA.
-
#issue_certificate(params = {}) ⇒ Types::IssueCertificateResponse
Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate.
-
#list_certificate_authorities(params = {}) ⇒ Types::ListCertificateAuthoritiesResponse
Lists the private certificate authorities that you created by using the [CreateCertificateAuthority] action.
-
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com).
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists the tags, if any, that are associated with your private CA or one that has been shared with you.
-
#put_policy(params = {}) ⇒ Struct
Attaches a resource-based policy to a private CA.
-
#restore_certificate_authority(params = {}) ⇒ Struct
Restores a certificate authority (CA) that is in the ‘DELETED` state.
-
#revoke_certificate(params = {}) ⇒ Struct
Revokes a certificate that was issued inside Amazon Web Services Private CA.
-
#tag_certificate_authority(params = {}) ⇒ Struct
Adds one or more tags to your private CA.
-
#untag_certificate_authority(params = {}) ⇒ Struct
Remove one or more tags from your private CA.
-
#update_certificate_authority(params = {}) ⇒ Struct
Updates the status or configuration of a private certificate authority (CA).
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'lib/aws-sdk-acmpca/client.rb', line 419 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2754 2755 2756 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2754 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2757 2758 2759 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2757 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2615 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-acmpca' context[:gem_version] = '1.66.0' Seahorse::Client::Request.new(handlers, context) end |
#create_certificate_authority(params = {}) ⇒ Types::CreateCertificateAuthorityResponse
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.
<note markdown=“1”> 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].
</note>
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see [Encrypting Your CRLs].
[1]: docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies [2]: docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption
678 679 680 681 |
# File 'lib/aws-sdk-acmpca/client.rb', line 678 def (params = {}, = {}) req = build_request(:create_certificate_authority, params) req.send_request() end |
#create_certificate_authority_audit_report(params = {}) ⇒ Types::CreateCertificateAuthorityAuditReportResponse
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.
<note markdown=“1”> 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].
</note>
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].
<note markdown=“1”> You can generate a maximum of one report every 30 minutes.
</note>
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html [3]: docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies [4]: docs.aws.amazon.com/privateca/latest/userguide/PcaAuditReport.html#audit-report-encryption
747 748 749 750 |
# File 'lib/aws-sdk-acmpca/client.rb', line 747 def (params = {}, = {}) req = build_request(:create_certificate_authority_audit_report, params) req.send_request() end |
#create_permission(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html [3]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
823 824 825 826 |
# File 'lib/aws-sdk-acmpca/client.rb', line 823 def (params = {}, = {}) req = build_request(:create_permission, params) req.send_request() end |
#delete_certificate_authority(params = {}) ⇒ Struct
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.
<note markdown=“1”> Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
</note>
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 is ‘PENDING_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 the ‘PermanentDeletionTimeInDays` 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 the `DELETED` state. To restore an eligible CA, call the
- RestoreCertificateAuthority][5
-
action.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html [3]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html [4]: docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html [5]: docs.aws.amazon.com/privateca/latest/APIReference/API_RestoreCertificateAuthority.html
895 896 897 898 |
# File 'lib/aws-sdk-acmpca/client.rb', line 895 def (params = {}, = {}) req = build_request(:delete_certificate_authority, params) req.send_request() end |
#delete_permission(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListPermissions.html [3]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
969 970 971 972 |
# File 'lib/aws-sdk-acmpca/client.rb', line 969 def (params = {}, = {}) req = build_request(:delete_permission, params) req.send_request() end |
#delete_policy(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html [3]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html [4]: docs.aws.amazon.com/acm/latest/userguide/acm-slr.html [5]: docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html
1040 1041 1042 1043 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1040 def delete_policy(params = {}, = {}) req = build_request(:delete_policy, params) req.send_request() end |
#describe_certificate_authority(params = {}) ⇒ Types::DescribeCertificateAuthorityResponse
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.
1179 1180 1181 1182 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1179 def (params = {}, = {}) req = build_request(:describe_certificate_authority, params) req.send_request() end |
#describe_certificate_authority_audit_report(params = {}) ⇒ Types::DescribeCertificateAuthorityAuditReportResponse
Lists information about a specific audit report created by calling the
- CreateCertificateAuthorityAuditReport][1
-
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.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html [3]: docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* audit_report_created
1241 1242 1243 1244 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1241 def (params = {}, = {}) req = build_request(:describe_certificate_authority_audit_report, params) req.send_request() end |
#get_certificate(params = {}) ⇒ Types::GetCertificateResponse
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][2
-
action to create a report
that contains information about all of the certificates issued and revoked by your private CA.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* certificate_issued
1305 1306 1307 1308 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1305 def get_certificate(params = {}, = {}) req = build_request(:get_certificate, params) req.send_request() end |
#get_certificate_authority_certificate(params = {}) ⇒ Types::GetCertificateAuthorityCertificateResponse
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.
1343 1344 1345 1346 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1343 def (params = {}, = {}) req = build_request(:get_certificate_authority_certificate, params) req.send_request() end |
#get_certificate_authority_csr(params = {}) ⇒ Types::GetCertificateAuthorityCsrResponse
Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the
- CreateCertificateAuthority][1
-
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.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* certificate_authority_csr_created
1395 1396 1397 1398 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1395 def (params = {}, = {}) req = build_request(:get_certificate_authority_csr, params) req.send_request() end |
#get_policy(params = {}) ⇒ Types::GetPolicyResponse
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].
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_PutPolicy.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html [3]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html [4]: docs.aws.amazon.com/acm/latest/userguide/acm-slr.html [5]: docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html
1459 1460 1461 1462 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1459 def get_policy(params = {}, = {}) req = build_request(:get_policy, params) req.send_request() end |
#import_certificate_authority_certificate(params = {}) ⇒ Struct
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][1
-
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
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCsr.html
1604 1605 1606 1607 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1604 def (params = {}, = {}) req = build_request(:import_certificate_authority_certificate, params) req.send_request() end |
#issue_certificate(params = {}) ⇒ Types::IssueCertificateResponse
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.
<note markdown=“1”> You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using Amazon Web Services Private CA.
</note>
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html
1892 1893 1894 1895 |
# File 'lib/aws-sdk-acmpca/client.rb', line 1892 def issue_certificate(params = {}, = {}) req = build_request(:issue_certificate, params) req.send_request() end |
#list_certificate_authorities(params = {}) ⇒ Types::ListCertificateAuthoritiesResponse
Lists the private certificate authorities that you created by using the [CreateCertificateAuthority] action.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2026 2027 2028 2029 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2026 def (params = {}, = {}) req = build_request(:list_certificate_authorities, params) req.send_request() end |
#list_permissions(params = {}) ⇒ Types::ListPermissionsResponse
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].
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreatePermission.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePermission.html [3]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2118 2119 2120 2121 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2118 def (params = {}, = {}) req = build_request(:list_permissions, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
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.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2184 2185 2186 2187 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2184 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#put_policy(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/privateca/latest/userguide/pca-ram.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_GetPolicy.html [3]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeletePolicy.html [4]: docs.aws.amazon.com/privateca/latest/userguide/pca-rbp.html [5]: docs.aws.amazon.com/acm/latest/userguide/acm-slr.html
2263 2264 2265 2266 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2263 def put_policy(params = {}, = {}) req = build_request(:put_policy, params) req.send_request() end |
#restore_certificate_authority(params = {}) ⇒ Struct
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][1
-
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 the ‘DELETED` state by calling the
- DescribeCertificateAuthority][2
actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ‘ACTIVE`, call the [UpdateCertificateAuthority] action. If the private CA was in the `PENDING_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.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_DeleteCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_DescribeCertificateAuthority.html [3]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListCertificateAuthorities.html [4]: docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html [5]: docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html
2317 2318 2319 2320 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2317 def (params = {}, = {}) req = build_request(:restore_certificate_authority, params) req.send_request() end |
#revoke_certificate(params = {}) ⇒ Struct
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` and `MisconfiguredCRLBucket`. For more information, see [Supported CloudWatch Metrics].
<note markdown=“1”> 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].
</note>
Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see [CreateCertificateAuthorityAuditReport].
<note markdown=“1”> You cannot revoke a root CA self-signed certificate.
</note>
[1]: docs.aws.amazon.com/privateca/latest/userguide/PcaCloudWatch.html [2]: docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies [3]: docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html
2400 2401 2402 2403 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2400 def revoke_certificate(params = {}, = {}) req = build_request(:revoke_certificate, params) req.send_request() end |
#tag_certificate_authority(params = {}) ⇒ Struct
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.
<note markdown=“1”> 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].
</note>
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html [3]: docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca
2462 2463 2464 2465 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2462 def (params = {}, = {}) req = build_request(:tag_certificate_authority, params) req.send_request() end |
#untag_certificate_authority(params = {}) ⇒ Struct
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][2
-
action to see
what tags are associated with your CA.
[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html
2512 2513 2514 2515 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2512 def (params = {}, = {}) req = build_request(:untag_certificate_authority, params) req.send_request() end |
#update_certificate_authority(params = {}) ⇒ Struct
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.
<note markdown=“1”> 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].
</note>
[1]: docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies
2606 2607 2608 2609 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2606 def (params = {}, = {}) req = build_request(:update_certificate_authority, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ——————————— | —————————————————- | ——– | ————- | | audit_report_created | #describe_certificate_authority_audit_report | 3 | 60 | | certificate_authority_csr_created | #get_certificate_authority_csr | 3 | 60 | | certificate_issued | #get_certificate | 1 | 60 |
2718 2719 2720 2721 2722 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2718 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2726 2727 2728 |
# File 'lib/aws-sdk-acmpca/client.rb', line 2726 def waiter_names waiters.keys end |