Class S3LoggingConfiguration

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

Configuration for S3 logging behavior in EMR clusters. Defines how different types of logs are uploaded to S3 based on the specified upload policies for each log type.

See Also:

  • Method Details

    • logTypeUploadPolicy

      public final Map<LogType,LogUploadPolicyValue> logTypeUploadPolicy()

      A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy.

      Valid log types:

      • system-logs: EMR Daemon logs.

      • application-logs: Framework logs from Hadoop, Spark, Hive and other applications running on the cluster.

      • persistent-ui-logs: Logs required for persistent application UIs such as Spark History Server and Tez UI.

      Valid upload policies:

      • emr-managed: Standard behavior. Logs are uploaded to S3 bucket as configured in your LogUri, with certain logs retained by the service for operational support and troubleshooting purposes.

      • on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. This requires you to specify a LogUri when creating the cluster. Persistent-ui-logs cannot have on-customer-s3only policy. Allowed policies for persistent-ui-logs are emr-managed and disabled.

      • disabled: No S3 upload for this log type.

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

      Returns:
      A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy.

      Valid log types:

      • system-logs: EMR Daemon logs.

      • application-logs: Framework logs from Hadoop, Spark, Hive and other applications running on the cluster.

      • persistent-ui-logs: Logs required for persistent application UIs such as Spark History Server and Tez UI.

      Valid upload policies:

      • emr-managed: Standard behavior. Logs are uploaded to S3 bucket as configured in your LogUri, with certain logs retained by the service for operational support and troubleshooting purposes.

      • on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. This requires you to specify a LogUri when creating the cluster. Persistent-ui-logs cannot have on-customer-s3only policy. Allowed policies for persistent-ui-logs are emr-managed and disabled.

      • disabled: No S3 upload for this log type.

    • hasLogTypeUploadPolicy

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

    • logTypeUploadPolicyAsStrings

      public final Map<String,String> logTypeUploadPolicyAsStrings()

      A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy.

      Valid log types:

      • system-logs: EMR Daemon logs.

      • application-logs: Framework logs from Hadoop, Spark, Hive and other applications running on the cluster.

      • persistent-ui-logs: Logs required for persistent application UIs such as Spark History Server and Tez UI.

      Valid upload policies:

      • emr-managed: Standard behavior. Logs are uploaded to S3 bucket as configured in your LogUri, with certain logs retained by the service for operational support and troubleshooting purposes.

      • on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. This requires you to specify a LogUri when creating the cluster. Persistent-ui-logs cannot have on-customer-s3only policy. Allowed policies for persistent-ui-logs are emr-managed and disabled.

      • disabled: No S3 upload for this log type.

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

      Returns:
      A map that specifies the upload policy for each log type. The key is the log type, and the value is the upload policy.

      Valid log types:

      • system-logs: EMR Daemon logs.

      • application-logs: Framework logs from Hadoop, Spark, Hive and other applications running on the cluster.

      • persistent-ui-logs: Logs required for persistent application UIs such as Spark History Server and Tez UI.

      Valid upload policies:

      • emr-managed: Standard behavior. Logs are uploaded to S3 bucket as configured in your LogUri, with certain logs retained by the service for operational support and troubleshooting purposes.

      • on-customer-s3only: Logs are uploaded only to the customer-specified S3 bucket. This requires you to specify a LogUri when creating the cluster. Persistent-ui-logs cannot have on-customer-s3only policy. Allowed policies for persistent-ui-logs are emr-managed and disabled.

      • disabled: No S3 upload for this log type.

    • toBuilder

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

    • builder

      public static S3LoggingConfiguration.Builder builder()

    • serializableBuilderClass

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