Class CloudWatchLoggingConfiguration

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

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Enables CloudWatch logging.

      Returns:
      Enables CloudWatch logging.

    • logGroupName

      public final String logGroupName()

      The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

      Returns:
      The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

    • logStreamNamePrefix

      public final String logStreamNamePrefix()

      Prefix for the CloudWatch log stream name.

      Returns:
      Prefix for the CloudWatch log stream name.

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

      Returns:
      The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

    • hasLogTypes

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

    • logTypes

      public final Map<String,List<String>> logTypes()

      The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

      • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

      • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

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

      Returns:
      The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

      • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

      • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

    • toBuilder

      public CloudWatchLoggingConfiguration.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<CloudWatchLoggingConfiguration.Builder,CloudWatchLoggingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static CloudWatchLoggingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CloudWatchLoggingConfiguration.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.