Class ConfigurationRecorderSummary

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

A summary of a configuration recorder, including the arn, name, servicePrincipal, recordingScope, and provider.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the configuration recorder.

      Returns:
      The Amazon Resource Name (ARN) of the configuration recorder.

    • name

      public final String name()

      The name of the configuration recorder.

      Returns:
      The name of the configuration recorder.

    • servicePrincipal

      public final String servicePrincipal()

      For service-linked configuration recorders, indicates which Amazon Web Services service the configuration recorder is linked to.

      Returns:
      For service-linked configuration recorders, indicates which Amazon Web Services service the configuration recorder is linked to.

    • recordingScope

      public final RecordingScope recordingScope()

      Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free (INTERNAL) or if you are charged a service fee for recording (PAID).

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

      Returns:
      Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free ( INTERNAL) or if you are charged a service fee for recording (PAID).
      See Also:

    • recordingScopeAsString

      public final String recordingScopeAsString()

      Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free (INTERNAL) or if you are charged a service fee for recording (PAID).

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

      Returns:
      Indicates whether the ConfigurationItems in scope for the configuration recorder are recorded for free ( INTERNAL) or if you are charged a service fee for recording (PAID).
      See Also:

    • provider

      public final Provider provider()

      For service-linked configuration recorders that record resources from a third-party cloud service provider, indicates the cloud service provider. Currently, AZURE is supported.

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

      Returns:
      For service-linked configuration recorders that record resources from a third-party cloud service provider, indicates the cloud service provider. Currently, AZURE is supported.
      See Also:

    • providerAsString

      public final String providerAsString()

      For service-linked configuration recorders that record resources from a third-party cloud service provider, indicates the cloud service provider. Currently, AZURE is supported.

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

      Returns:
      For service-linked configuration recorders that record resources from a third-party cloud service provider, indicates the cloud service provider. Currently, AZURE is supported.
      See Also:

    • toBuilder

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

    • builder

      public static ConfigurationRecorderSummary.Builder builder()

    • serializableBuilderClass

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