ServerCertificateConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.networkfirewall.model.ServerCertificateConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServerCertificateConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configures the Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide.

If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServerCertificateConfiguration()

Constructors
Constructor and Description
`ServerCertificateConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServerCertificateConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCertificateAuthorityArn()` The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
`CheckCertificateRevocationStatusActions`	`getCheckCertificateRevocationStatus()` When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.
`List<ServerCertificateScope>`	`getScopes()` A list of scopes.
`List<ServerCertificate>`	`getServerCertificates()` The list of server certificates to use for inbound SSL/TLS inspection.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCertificateAuthorityArn(String certificateAuthorityArn)` The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
`void`	`setCheckCertificateRevocationStatus(CheckCertificateRevocationStatusActions checkCertificateRevocationStatus)` When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.
`void`	`setScopes(Collection<ServerCertificateScope> scopes)` A list of scopes.
`void`	`setServerCertificates(Collection<ServerCertificate> serverCertificates)` The list of server certificates to use for inbound SSL/TLS inspection.
`String`	`toString()` Returns a string representation of this object.
`ServerCertificateConfiguration`	`withCertificateAuthorityArn(String certificateAuthorityArn)` The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
`ServerCertificateConfiguration`	`withCheckCertificateRevocationStatus(CheckCertificateRevocationStatusActions checkCertificateRevocationStatus)` When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.
`ServerCertificateConfiguration`	`withScopes(Collection<ServerCertificateScope> scopes)` A list of scopes.
`ServerCertificateConfiguration`	`withScopes(ServerCertificateScope... scopes)` A list of scopes.
`ServerCertificateConfiguration`	`withServerCertificates(Collection<ServerCertificate> serverCertificates)` The list of server certificates to use for inbound SSL/TLS inspection.
`ServerCertificateConfiguration`	`withServerCertificates(ServerCertificate... serverCertificates)` The list of server certificates to use for inbound SSL/TLS inspection.

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

- Constructor Detail
  - ServerCertificateConfiguration
```
public ServerCertificateConfiguration()
```
- Method Detail
  - getServerCertificates
```
public List<ServerCertificate> getServerCertificates()
```
    The list of server certificates to use for inbound SSL/TLS inspection.
    
    Returns:
    
    The list of server certificates to use for inbound SSL/TLS inspection.
  - setServerCertificates
```
public void setServerCertificates(Collection<ServerCertificate> serverCertificates)
```
    The list of server certificates to use for inbound SSL/TLS inspection.
    
    Parameters:
    
    serverCertificates - The list of server certificates to use for inbound SSL/TLS inspection.
  - withServerCertificates
```
public ServerCertificateConfiguration withServerCertificates(ServerCertificate... serverCertificates)
```
    The list of server certificates to use for inbound SSL/TLS inspection.
    
    NOTE: This method appends the values to the existing list (if any). Use setServerCertificates(java.util.Collection) or withServerCertificates(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    serverCertificates - The list of server certificates to use for inbound SSL/TLS inspection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withServerCertificates
```
public ServerCertificateConfiguration withServerCertificates(Collection<ServerCertificate> serverCertificates)
```
    The list of server certificates to use for inbound SSL/TLS inspection.
    
    Parameters:
    
    serverCertificates - The list of server certificates to use for inbound SSL/TLS inspection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getScopes
```
public List<ServerCertificateScope> getScopes()
```
    A list of scopes.
    
    Returns:
    
    A list of scopes.
  - setScopes
```
public void setScopes(Collection<ServerCertificateScope> scopes)
```
    A list of scopes.
    
    Parameters:
    
    scopes - A list of scopes.
  - withScopes
```
public ServerCertificateConfiguration withScopes(ServerCertificateScope... scopes)
```
    A list of scopes.
    
    NOTE: This method appends the values to the existing list (if any). Use setScopes(java.util.Collection) or withScopes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    scopes - A list of scopes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withScopes
```
public ServerCertificateConfiguration withScopes(Collection<ServerCertificateScope> scopes)
```
    A list of scopes.
    
    Parameters:
    
    scopes - A list of scopes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateAuthorityArn
```
public void setCertificateAuthorityArn(String certificateAuthorityArn)
```
    The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    - You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    - You can't use certificates issued by Private Certificate Authority.
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
    Parameters:
    certificateAuthorityArn - The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    
    You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    
    You can't use certificates issued by Private Certificate Authority.
    
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
  - getCertificateAuthorityArn
```
public String getCertificateAuthorityArn()
```
    The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    - You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    - You can't use certificates issued by Private Certificate Authority.
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
    Returns:
    The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    
    You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    
    You can't use certificates issued by Private Certificate Authority.
    
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
  - withCertificateAuthorityArn
```
public ServerCertificateConfiguration withCertificateAuthorityArn(String certificateAuthorityArn)
```
    The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    - You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    - You can't use certificates issued by Private Certificate Authority.
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
    Parameters:
    certificateAuthorityArn - The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within Certificate Manager (ACM) to use for outbound SSL/TLS inspection.
    
    The following limitations apply:
    
    You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM.
    
    You can't use certificates issued by Private Certificate Authority.
    
    For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the Network Firewall Developer Guide.
    
    For information about working with certificates in ACM, see Importing certificates in the Certificate Manager User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCheckCertificateRevocationStatus
```
public void setCheckCertificateRevocationStatus(CheckCertificateRevocationStatusActions checkCertificateRevocationStatus)
```
    When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
    
    Parameters:
    
    checkCertificateRevocationStatus - When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
  - getCheckCertificateRevocationStatus
```
public CheckCertificateRevocationStatusActions getCheckCertificateRevocationStatus()
```
    When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
    
    Returns:
    
    When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
  - withCheckCertificateRevocationStatus
```
public ServerCertificateConfiguration withCheckCertificateRevocationStatus(CheckCertificateRevocationStatusActions checkCertificateRevocationStatus)
```
    When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
    
    Parameters:
    
    checkCertificateRevocationStatus - When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 ServerCertificateConfiguration 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.

AWS SDK for Java 1.x API Reference - 1.12.780

Class ServerCertificateConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerCertificateConfiguration

Method Detail

getServerCertificates

setServerCertificates

withServerCertificates

withServerCertificates

getScopes

setScopes

withScopes

withScopes

setCertificateAuthorityArn

getCertificateAuthorityArn

withCertificateAuthorityArn

setCheckCertificateRevocationStatus

getCheckCertificateRevocationStatus

withCheckCertificateRevocationStatus

toString

equals

hashCode

clone

marshall