Package software.amazon.awssdk.services.rds.model

Class CloudwatchLogsExportConfiguration

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

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.

For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

See Also:

  • Method Details

    • hasEnableLogTypes

      public final boolean hasEnableLogTypes()
      For responses, this returns true if the service returned a value for the EnableLogTypes 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.

    • enableLogTypes

      public final List<String> enableLogTypes()

      The list of log types to enable.

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      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 hasEnableLogTypes() method.

      Returns:
      The list of log types to enable.

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

    • hasDisableLogTypes

      public final boolean hasDisableLogTypes()
      For responses, this returns true if the service returned a value for the DisableLogTypes 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.

    • disableLogTypes

      public final List<String> disableLogTypes()

      The list of log types to disable.

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

      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 hasDisableLogTypes() method.

      Returns:
      The list of log types to disable.

      The following values are valid for each DB engine:

      • Aurora MySQL - audit | error | general | slowquery

      • Aurora PostgreSQL - postgresql

      • RDS for MySQL - error | general | slowquery

      • RDS for PostgreSQL - postgresql | upgrade

    • toBuilder

      public CloudwatchLogsExportConfiguration.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CloudwatchLogsExportConfiguration.Builder,CloudwatchLogsExportConfiguration>

    • builder

      public static CloudwatchLogsExportConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CloudwatchLogsExportConfiguration.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo