Class OffsetDateTimeAsStringAttributeConverter

java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.OffsetDateTimeAsStringAttributeConverter
All Implemented Interfaces:
AttributeConverter<OffsetDateTime>

@ThreadSafe @Immutable public final class OffsetDateTimeAsStringAttributeConverter extends Object implements AttributeConverter<OffsetDateTime>
A converter between OffsetDateTime and AttributeValue.

This stores values in DynamoDB as a string.

Values are stored in ISO-8601 format, with nanosecond precision. If the offset has seconds then they will also be included, even though this is not part of the ISO-8601 standard. For full ISO-8601 compliance, ensure your OffsetDateTimes do not have offsets at the precision level of seconds.

Examples:

  • OffsetDateTime.MIN is stored as an AttributeValue with the String "-999999999-01-01T00:00+18:00"
  • OffsetDateTime.MAX is stored as an AttributeValue with the String "+999999999-12-31T23:59:59.999999999-18:00"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).plusSeconds(1) is stored as an AttributeValue with the String "1970-01-01T00:00:01Z"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).minusSeconds(1) is stored as an AttributeValue with the String "1969-12-31T23:59:59Z"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).plusMillis(1) is stored as an AttributeValue with the String "1970-01-01T00:00:00.001Z"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).minusMillis(1) is stored as an AttributeValue with the String "1969-12-31T23:59:59.999Z"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).plusNanos(1) is stored as an AttributeValue with the String "1970-01-01T00:00:00.000000001Z"
  • Instant.EPOCH.atOffset(ZoneOffset.UTC).minusNanos(1) is stored as an AttributeValue with the String "1969-12-31T23:59:59.999999999Z"
See OffsetDateTime for more details on the serialization format.

This converter can read any values written by itself or InstantAsStringAttributeConverter, and values without a time zone named written byZonedDateTimeAsStringAttributeConverter. Values written by Instant converters are treated as if they are in the UTC time zone (and an offset of 0 seconds will be returned).

This serialization is lexicographically orderable when the year is not negative.

This can be created via create().