[ aws . acm ]

update-certificate-options

Description

Updates 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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-certificate-options
--certificate-arn <value>
--options <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--certificate-arn (string)

ARN of the requested certificate to update. This must be of the form:

``arn:aws:acm:us-east-1:account :certificate/12345678-1234-1234-1234-123456789012 ``

--options (structure)

Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.

CertificateTransparencyLoggingPreference -> (string)

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .

Shorthand Syntax:

CertificateTransparencyLoggingPreference=string

JSON Syntax:

{
  "CertificateTransparencyLoggingPreference": "ENABLED"|"DISABLED"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To update the certificate options

The following update-certificate-options command opts out of certificate transparency logging:

aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED

Output

None