ClientCertificate (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.ClientCertificate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClientCertificate
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.

Use Client-Side Certificate

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClientCertificate()

Constructors
Constructor and Description
`ClientCertificate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientCertificate`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClientCertificateId()` The identifier of the client certificate.
`Date`	`getCreatedDate()` The timestamp when the client certificate was created.
`String`	`getDescription()` The description of the client certificate.
`Date`	`getExpirationDate()` The timestamp when the client certificate will expire.
`String`	`getPemEncodedCertificate()` The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClientCertificateId(String clientCertificateId)` The identifier of the client certificate.
`void`	`setCreatedDate(Date createdDate)` The timestamp when the client certificate was created.
`void`	`setDescription(String description)` The description of the client certificate.
`void`	`setExpirationDate(Date expirationDate)` The timestamp when the client certificate will expire.
`void`	`setPemEncodedCertificate(String pemEncodedCertificate)` The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ClientCertificate`	`withClientCertificateId(String clientCertificateId)` The identifier of the client certificate.
`ClientCertificate`	`withCreatedDate(Date createdDate)` The timestamp when the client certificate was created.
`ClientCertificate`	`withDescription(String description)` The description of the client certificate.
`ClientCertificate`	`withExpirationDate(Date expirationDate)` The timestamp when the client certificate will expire.
`ClientCertificate`	`withPemEncodedCertificate(String pemEncodedCertificate)` The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClientCertificate
```
public ClientCertificate()
```
- Method Detail
  - setClientCertificateId
```
public void setClientCertificateId(String clientCertificateId)
```
    The identifier of the client certificate.
    
    Parameters:
    
    clientCertificateId - The identifier of the client certificate.
  - getClientCertificateId
```
public String getClientCertificateId()
```
    The identifier of the client certificate.
    
    Returns:
    
    The identifier of the client certificate.
  - withClientCertificateId
```
public ClientCertificate withClientCertificateId(String clientCertificateId)
```
    The identifier of the client certificate.
    
    Parameters:
    
    clientCertificateId - The identifier of the client certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the client certificate.
    
    Parameters:
    
    description - The description of the client certificate.
  - getDescription
```
public String getDescription()
```
    The description of the client certificate.
    
    Returns:
    
    The description of the client certificate.
  - withDescription
```
public ClientCertificate withDescription(String description)
```
    The description of the client certificate.
    
    Parameters:
    
    description - The description of the client certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPemEncodedCertificate
```
public void setPemEncodedCertificate(String pemEncodedCertificate)
```
    The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    
    Parameters:
    
    pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
  - getPemEncodedCertificate
```
public String getPemEncodedCertificate()
```
    The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    
    Returns:
    
    The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
  - withPemEncodedCertificate
```
public ClientCertificate withPemEncodedCertificate(String pemEncodedCertificate)
```
    The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    
    Parameters:
    
    pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The timestamp when the client certificate was created.
    
    Parameters:
    
    createdDate - The timestamp when the client certificate was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The timestamp when the client certificate was created.
    
    Returns:
    
    The timestamp when the client certificate was created.
  - withCreatedDate
```
public ClientCertificate withCreatedDate(Date createdDate)
```
    The timestamp when the client certificate was created.
    
    Parameters:
    
    createdDate - The timestamp when the client certificate was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpirationDate
```
public void setExpirationDate(Date expirationDate)
```
    The timestamp when the client certificate will expire.
    
    Parameters:
    
    expirationDate - The timestamp when the client certificate will expire.
  - getExpirationDate
```
public Date getExpirationDate()
```
    The timestamp when the client certificate will expire.
    
    Returns:
    
    The timestamp when the client certificate will expire.
  - withExpirationDate
```
public ClientCertificate withExpirationDate(Date expirationDate)
```
    The timestamp when the client certificate will expire.
    
    Parameters:
    
    expirationDate - The timestamp when the client certificate will expire.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ClientCertificate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ClientCertificate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientCertificate

Method Detail

setClientCertificateId

getClientCertificateId

withClientCertificateId

setDescription

getDescription

withDescription

setPemEncodedCertificate

getPemEncodedCertificate

withPemEncodedCertificate

setCreatedDate

getCreatedDate

withCreatedDate

setExpirationDate

getExpirationDate

withExpirationDate

toString

equals

hashCode

clone

marshall