[ aws . apigateway ]

generate-client-certificate

Description

Generates a ClientCertificate resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  generate-client-certificate
[--description <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string)

The description of the ClientCertificate.

--tags (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a Client-Side SSL Certificate

Command:

aws apigateway generate-client-certificate --description 'My First Client Certificate'

Output

clientCertificateId -> (string)

The identifier of the client certificate.

description -> (string)

The description of the client certificate.

pemEncodedCertificate -> (string)

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

createdDate -> (timestamp)

The timestamp when the client certificate was created.

expirationDate -> (timestamp)

The timestamp when the client certificate will expire.

tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)