Class ServerCertificateScope

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.ServerCertificateScope
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ServerCertificateScope.Builder,ServerCertificateScope>
@Generated("software.amazon.awssdk:codegen") public final class ServerCertificateScope extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ServerCertificateScope.Builder,ServerCertificateScope>

Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.

See Also:

  • Method Details

    • hasSources

      public final boolean hasSources()
      For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sources

      public final List<Address> sources()

      The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSources() method.

      Returns:
      The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.

    • hasDestinations

      public final boolean hasDestinations()
      For responses, this returns true if the service returned a value for the Destinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destinations

      public final List<Address> destinations()

      The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinations() method.

      Returns:
      The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.

    • hasSourcePorts

      public final boolean hasSourcePorts()
      For responses, this returns true if the service returned a value for the SourcePorts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sourcePorts

      public final List<PortRange> sourcePorts()

      The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.

      You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourcePorts() method.

      Returns:
      The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.

      You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

    • hasDestinationPorts

      public final boolean hasDestinationPorts()
      For responses, this returns true if the service returned a value for the DestinationPorts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destinationPorts

      public final List<PortRange> destinationPorts()

      The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.

      You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationPorts() method.

      Returns:
      The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.

      You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.

    • hasProtocols

      public final boolean hasProtocols()
      For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • protocols

      public final List<Integer> protocols()

      The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

      Network Firewall currently supports only TCP.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.

      Returns:
      The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

      Network Firewall currently supports only TCP.

    • domainMatch

      public final DomainMatch domainMatch()

      The domains that this scope matches, based on the host name in the client's HTTP CONNECT request. Domain matching applies only to proxy mode firewalls. If you specify DomainMatch, you must set DeploymentMode to EXPLICIT_PROXY_ONLY. If you don't specify DomainMatch, the scope matches traffic by its source, destination, ports, and protocols only.

      Returns:
      The domains that this scope matches, based on the host name in the client's HTTP CONNECT request. Domain matching applies only to proxy mode firewalls. If you specify DomainMatch, you must set DeploymentMode to EXPLICIT_PROXY_ONLY. If you don't specify DomainMatch, the scope matches traffic by its source, destination, ports, and protocols only.

    • decryptionAction

      public final DecryptionAction decryptionAction()

      Whether the firewall decrypts traffic that matches this scope. You can choose from the following values:

      • DECRYPT - The firewall decrypts the traffic for inspection.

      • BYPASS - The firewall doesn't decrypt the traffic.

      If the service returns an enum value that is not available in the current SDK version, decryptionAction will return DecryptionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decryptionActionAsString().

      Returns:
      Whether the firewall decrypts traffic that matches this scope. You can choose from the following values:

      • DECRYPT - The firewall decrypts the traffic for inspection.

      • BYPASS - The firewall doesn't decrypt the traffic.

      See Also:

    • decryptionActionAsString

      public final String decryptionActionAsString()

      Whether the firewall decrypts traffic that matches this scope. You can choose from the following values:

      • DECRYPT - The firewall decrypts the traffic for inspection.

      • BYPASS - The firewall doesn't decrypt the traffic.

      If the service returns an enum value that is not available in the current SDK version, decryptionAction will return DecryptionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from decryptionActionAsString().

      Returns:
      Whether the firewall decrypts traffic that matches this scope. You can choose from the following values:

      • DECRYPT - The firewall decrypts the traffic for inspection.

      • BYPASS - The firewall doesn't decrypt the traffic.

      See Also:

    • deploymentMode

      public final TLSInspectionScopeDeploymentMode deploymentMode()

      The type of firewall that this scope applies to. If you don't specify a value, the scope applies to both types, the same as ALL. You can choose from the following values:

      • ALL - The scope applies to both transparent firewalls and proxy mode firewalls.

      • TRANSPARENT_FIREWALL_ONLY - The scope applies only to transparent firewalls.

      • EXPLICIT_PROXY_ONLY - The scope applies only to proxy mode firewalls. A scope that specifies DomainMatch must use this value.

      If the service returns an enum value that is not available in the current SDK version, deploymentMode will return TLSInspectionScopeDeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

      Returns:
      The type of firewall that this scope applies to. If you don't specify a value, the scope applies to both types, the same as ALL. You can choose from the following values:

      • ALL - The scope applies to both transparent firewalls and proxy mode firewalls.

      • TRANSPARENT_FIREWALL_ONLY - The scope applies only to transparent firewalls.

      • EXPLICIT_PROXY_ONLY - The scope applies only to proxy mode firewalls. A scope that specifies DomainMatch must use this value.

      See Also:

    • deploymentModeAsString

      public final String deploymentModeAsString()

      The type of firewall that this scope applies to. If you don't specify a value, the scope applies to both types, the same as ALL. You can choose from the following values:

      • ALL - The scope applies to both transparent firewalls and proxy mode firewalls.

      • TRANSPARENT_FIREWALL_ONLY - The scope applies only to transparent firewalls.

      • EXPLICIT_PROXY_ONLY - The scope applies only to proxy mode firewalls. A scope that specifies DomainMatch must use this value.

      If the service returns an enum value that is not available in the current SDK version, deploymentMode will return TLSInspectionScopeDeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().

      Returns:
      The type of firewall that this scope applies to. If you don't specify a value, the scope applies to both types, the same as ALL. You can choose from the following values:

      • ALL - The scope applies to both transparent firewalls and proxy mode firewalls.

      • TRANSPARENT_FIREWALL_ONLY - The scope applies only to transparent firewalls.

      • EXPLICIT_PROXY_ONLY - The scope applies only to proxy mode firewalls. A scope that specifies DomainMatch must use this value.

      See Also:

    • toBuilder

      public ServerCertificateScope.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ServerCertificateScope.Builder,ServerCertificateScope>
      Returns:
      a builder for type T

    • builder

      public static ServerCertificateScope.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ServerCertificateScope.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.