Class ModuleInfo

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

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

For more information about modules, see Create reusable resource configurations that can be included across templates with CloudFormation modules in the CloudFormation User Guide.

See Also:

  • Method Details

    • typeHierarchy

      public final String typeHierarchy()

      A concatenated list of the module type or types that contains the resource. Module types are listed starting with the inner-most nested module, and separated by /.

      In the following example, the resource was created from a module of type AWS::First::Example::MODULE , that's nested inside a parent module of type AWS::Second::Example::MODULE.

      AWS::First::Example::MODULE/AWS::Second::Example::MODULE

      Returns:
      A concatenated list of the module type or types that contains the resource. Module types are listed starting with the inner-most nested module, and separated by /.

      In the following example, the resource was created from a module of type AWS::First::Example::MODULE, that's nested inside a parent module of type AWS::Second::Example::MODULE.

      AWS::First::Example::MODULE/AWS::Second::Example::MODULE

    • logicalIdHierarchy

      public final String logicalIdHierarchy()

      A concatenated list of the logical IDs of the module or modules that contains the resource. Modules are listed starting with the inner-most nested module, and separated by /.

      In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.

      moduleA/moduleB

      For more information, see Reference module resources in CloudFormation templates in the CloudFormation User Guide.

      Returns:
      A concatenated list of the logical IDs of the module or modules that contains the resource. Modules are listed starting with the inner-most nested module, and separated by /.

      In the following example, the resource was created from a module, moduleA, that's nested inside a parent module, moduleB.

      moduleA/moduleB

      For more information, see Reference module resources in CloudFormation templates in the CloudFormation User Guide.

    • toBuilder

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

    • builder

      public static ModuleInfo.Builder builder()

    • serializableBuilderClass

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