Package software.amazon.awssdk.services.cloudformation.model

Class ResourceIdentifierSummary

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

Describes the target resources of a specific type in your import template (for example, all AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources of that type.

See Also:

  • Method Details

    • resourceType

      public final String resourceType()

      The template resource type of the target resources, such as AWS::S3::Bucket.

      Returns:
      The template resource type of the target resources, such as AWS::S3::Bucket.

    • hasLogicalResourceIds

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

    • logicalResourceIds

      public final List<String> logicalResourceIds()

      The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

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

      Returns:
      The logical IDs of the target resources of the specified ResourceType, as defined in the import template.

    • hasResourceIdentifiers

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

    • resourceIdentifiers

      public final List<String> resourceIdentifiers()

      The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

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

      Returns:
      The resource properties you can provide during the import to identify your target resources. For example, BucketName is a possible identifier property for AWS::S3::Bucket resources.

    • toBuilder

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

    • builder

      public static ResourceIdentifierSummary.Builder builder()

    • serializableBuilderClass

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