Package software.amazon.awssdk.services.config.model

Class ConfigurationItem

    • Method Detail

      • version

        public final String version()

        The version number of the resource configuration.

        Returns:
        The version number of the resource configuration.

      • accountId

        public final String accountId()

        The 12-digit Amazon Web Services account ID associated with the resource.

        Returns:
        The 12-digit Amazon Web Services account ID associated with the resource.

      • configurationItemCaptureTime

        public final Instant configurationItemCaptureTime()

        The time when the configuration recording was initiated.

        Returns:
        The time when the configuration recording was initiated.

      • configurationItemStatus

        public final ConfigurationItemStatus configurationItemStatus()

        The configuration item status. The valid values are:

        • OK – The resource configuration has been updated

        • ResourceDiscovered – The resource was newly discovered

        • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

        • ResourceDeleted – The resource was deleted

        • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

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

        Returns:
        The configuration item status. The valid values are:

        • OK – The resource configuration has been updated

        • ResourceDiscovered – The resource was newly discovered

        • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

        • ResourceDeleted – The resource was deleted

        • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

        See Also:
        ConfigurationItemStatus

      • configurationItemStatusAsString

        public final String configurationItemStatusAsString()

        The configuration item status. The valid values are:

        • OK – The resource configuration has been updated

        • ResourceDiscovered – The resource was newly discovered

        • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

        • ResourceDeleted – The resource was deleted

        • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

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

        Returns:
        The configuration item status. The valid values are:

        • OK – The resource configuration has been updated

        • ResourceDiscovered – The resource was newly discovered

        • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

        • ResourceDeleted – The resource was deleted

        • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

        See Also:
        ConfigurationItemStatus

      • configurationStateId

        public final String configurationStateId()

        An identifier that indicates the ordering of the configuration items of a resource.

        Returns:
        An identifier that indicates the ordering of the configuration items of a resource.

      • configurationItemMD5Hash

        public final String configurationItemMD5Hash()

        Unique MD5 hash that represents the configuration item's state.

        You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

        Returns:
        Unique MD5 hash that represents the configuration item's state.

        You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

      • arn

        public final String arn()

        Amazon Resource Name (ARN) associated with the resource.

        Returns:
        Amazon Resource Name (ARN) associated with the resource.

      • resourceId

        public final String resourceId()

        The ID of the resource (for example, sg-xxxxxx).

        Returns:
        The ID of the resource (for example, sg-xxxxxx).

      • resourceName

        public final String resourceName()

        The custom name of the resource, if available.

        Returns:
        The custom name of the resource, if available.

      • awsRegion

        public final String awsRegion()

        The region where the resource resides.

        Returns:
        The region where the resource resides.

      • availabilityZone

        public final String availabilityZone()

        The Availability Zone associated with the resource.

        Returns:
        The Availability Zone associated with the resource.

      • resourceCreationTime

        public final Instant resourceCreationTime()

        The time stamp when the resource was created.

        Returns:
        The time stamp when the resource was created.

      • hasTags

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

      • tags

        public final Map<String,​String> tags()

        A mapping of key value tags associated with the resource.

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

        Returns:
        A mapping of key value tags associated with the resource.

      • hasRelatedEvents

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

      • relatedEvents

        public final List<String> relatedEvents()

        A list of CloudTrail event IDs.

        A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

        An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

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

        Returns:
        A list of CloudTrail event IDs.

        A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

        An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

      • hasRelationships

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

      • relationships

        public final List<Relationship> relationships()

        A list of related Amazon Web Services 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 hasRelationships() method.

        Returns:
        A list of related Amazon Web Services resources.

      • configuration

        public final String configuration()

        The description of the resource configuration.

        Returns:
        The description of the resource configuration.

      • hasSupplementaryConfiguration

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

      • supplementaryConfiguration

        public final Map<String,​String> supplementaryConfiguration()

        Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

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

        Returns:
        Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)