@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCertificateManager extends Object implements AWSCertificateManager
AWSCertificateManager. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AddTagsToCertificateResult |
addTagsToCertificate(AddTagsToCertificateRequest request)
Adds one or more tags to an ACM certificate.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes a certificate and its associated private key.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest request)
Returns detailed metadata about the specified ACM certificate.
|
ExportCertificateResult |
exportCertificate(ExportCertificateRequest request)
Exports a certificate for use anywhere.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCertificateResult |
getCertificate(GetCertificateRequest request)
Retrieves a certificate specified by an ARN and its certificate chain .
|
ImportCertificateResult |
importCertificate(ImportCertificateRequest request)
Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest request)
Retrieves a list of certificate ARNs and domain names.
|
ListTagsForCertificateResult |
listTagsForCertificate(ListTagsForCertificateRequest request)
Lists the tags that have been applied to the ACM certificate.
|
RemoveTagsFromCertificateResult |
removeTagsFromCertificate(RemoveTagsFromCertificateRequest request)
Remove one or more tags from an ACM certificate.
|
RequestCertificateResult |
requestCertificate(RequestCertificateRequest request)
Requests an ACM certificate for use with other AWS services.
|
ResendValidationEmailResult |
resendValidationEmail(ResendValidationEmailRequest request)
Resends the email that requests domain ownership validation.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://acm.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSCertificateManager.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
UpdateCertificateOptionsResult |
updateCertificateOptions(UpdateCertificateOptionsRequest request)
Updates a certificate.
|
public void setEndpoint(String endpoint)
AWSCertificateManager
Callers can pass in just the endpoint (ex: "acm.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://acm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSCertificateManagerendpoint - The endpoint (ex: "acm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://acm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSCertificateManagerAWSCertificateManager.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSCertificateManagerregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AddTagsToCertificateResult addTagsToCertificate(AddTagsToCertificateRequest request)
AWSCertificateManager
Adds one or more tags to an ACM certificate. 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
certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.
To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
addTagsToCertificate in interface AWSCertificateManagerpublic DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSCertificateManagerDeletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
deleteCertificate in interface AWSCertificateManagerpublic DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
AWSCertificateManagerReturns detailed metadata about the specified ACM certificate.
describeCertificate in interface AWSCertificateManagerpublic ExportCertificateResult exportCertificate(ExportCertificateRequest request)
AWSCertificateManagerExports a certificate for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
exportCertificate in interface AWSCertificateManagerpublic GetCertificateResult getCertificate(GetCertificateRequest request)
AWSCertificateManagerRetrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.
getCertificate in interface AWSCertificateManagerpublic ImportCertificateResult importCertificate(ImportCertificateRequest request)
AWSCertificateManagerImports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you
want to replace a previously imported certificate.
When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, the
certificate chain, and the private key by their file names preceded by file://. For example, you can
specify a certificate saved in the C:\temp folder as
file://C:\temp\certificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include
these arguments as BLOBs.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificate in interface AWSCertificateManagerpublic ListCertificatesResult listCertificates(ListCertificatesRequest request)
AWSCertificateManagerRetrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.
listCertificates in interface AWSCertificateManagerpublic ListTagsForCertificateResult listTagsForCertificate(ListTagsForCertificateRequest request)
AWSCertificateManagerLists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
listTagsForCertificate in interface AWSCertificateManagerpublic RemoveTagsFromCertificateResult removeTagsFromCertificate(RemoveTagsFromCertificateRequest request)
AWSCertificateManagerRemove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
removeTagsFromCertificate in interface AWSCertificateManagerpublic RequestCertificateResult requestCertificate(RequestCertificateRequest request)
AWSCertificateManager
Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify the
fully qualified domain name (FQDN) for your site in the DomainName parameter. You can also specify
additional FQDNs in the SubjectAlternativeNames parameter.
Each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation.
If you choose email validation, email is sent to the domain owner to request approval to issue the certificate.
Email is sent to three registered contact addresses in the WHOIS database and to five common system
administration addresses formed from the DomainName you enter or the optional
ValidationDomain parameter. For more information, see Validate with Email.
After receiving approval from the domain owner, the ACM certificate is issued.
requestCertificate in interface AWSCertificateManagerpublic ResendValidationEmailResult resendValidationEmail(ResendValidationEmailRequest request)
AWSCertificateManagerResends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.
resendValidationEmail in interface AWSCertificateManagerpublic UpdateCertificateOptionsResult updateCertificateOptions(UpdateCertificateOptionsRequest request)
AWSCertificateManagerUpdates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.
updateCertificateOptions in interface AWSCertificateManagerpublic void shutdown()
AWSCertificateManagershutdown in interface AWSCertificateManagerpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCertificateManagerResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSCertificateManagerrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.