Class RecordingMode

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

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

See Also:

  • Method Details

    • recordingFrequency

      public final RecordingFrequency recordingFrequency()

      The default recording frequency that Config uses to record configuration changes.

      Daily recording cannot be specified for the following resource types:

      • AWS::Config::ResourceCompliance

      • AWS::Config::ConformancePackCompliance

      • AWS::Config::ConfigurationRecorder

      For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

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

      Returns:
      The default recording frequency that Config uses to record configuration changes.

      Daily recording cannot be specified for the following resource types:

      • AWS::Config::ResourceCompliance

      • AWS::Config::ConformancePackCompliance

      • AWS::Config::ConfigurationRecorder

      For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

      See Also:

    • recordingFrequencyAsString

      public final String recordingFrequencyAsString()

      The default recording frequency that Config uses to record configuration changes.

      Daily recording cannot be specified for the following resource types:

      • AWS::Config::ResourceCompliance

      • AWS::Config::ConformancePackCompliance

      • AWS::Config::ConfigurationRecorder

      For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

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

      Returns:
      The default recording frequency that Config uses to record configuration changes.

      Daily recording cannot be specified for the following resource types:

      • AWS::Config::ResourceCompliance

      • AWS::Config::ConformancePackCompliance

      • AWS::Config::ConfigurationRecorder

      For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

      See Also:

    • hasRecordingModeOverrides

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

    • recordingModeOverrides

      public final List<RecordingModeOverride> recordingModeOverrides()

      An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description, the new recordingFrequency, and an array of resourceTypes to override.

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

      Returns:
      An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description, the new recordingFrequency, and an array of resourceTypes to override.

    • toBuilder

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

    • builder

      public static RecordingMode.Builder builder()

    • serializableBuilderClass

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