There are more AWS SDK examples available in the AWS Doc SDK Examples
The following code examples show how to create an item with TTL.
- SDK for Java 2.x
-
package com.amazon.samplelib.ttl; import com.amazon.samplelib.CodeSampleUtils; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.dynamodb.model.AttributeValue; import software.amazon.awssdk.services.dynamodb.model.DynamoDbException; import software.amazon.awssdk.services.dynamodb.model.PutItemRequest; import software.amazon.awssdk.services.dynamodb.model.PutItemResponse; import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException; import java.util.HashMap; import java.util.Map; import java.util.Optional; /** * Creates an item in a DynamoDB table with TTL attributes. * This class demonstrates how to add TTL expiration timestamps to DynamoDB items. */ public class CreateTTL { private static final String USAGE = """ Usage: <tableName> <primaryKey> <sortKey> <region> Where: tableName - The Amazon DynamoDB table being queried. primaryKey - The name of the primary key. Also known as the hash or partition key. sortKey - The name of the sort key. Also known as the range attribute. region (optional) - The AWS region that the Amazon DynamoDB table is located in. (Default: us-east-1) """; private static final int DAYS_TO_EXPIRE = 90; private static final int SECONDS_PER_DAY = 24 * 60 * 60; private static final String PRIMARY_KEY_ATTR = "primaryKey"; private static final String SORT_KEY_ATTR = "sortKey"; private static final String CREATION_DATE_ATTR = "creationDate"; private static final String EXPIRE_AT_ATTR = "expireAt"; private static final String SUCCESS_MESSAGE = "%s PutItem operation with TTL successful."; private static final String TABLE_NOT_FOUND_ERROR = "Error: The Amazon DynamoDB table \"%s\" can't be found."; private final DynamoDbClient dynamoDbClient; /** * Constructs a CreateTTL instance with the specified DynamoDB client. * * @param dynamoDbClient The DynamoDB client to use */ public CreateTTL(final DynamoDbClient dynamoDbClient) { this.dynamoDbClient = dynamoDbClient; } /** * Constructs a CreateTTL with a default DynamoDB client. */ public CreateTTL() { this.dynamoDbClient = null; } /** * Main method to demonstrate creating an item with TTL. * * @param args Command line arguments */ public static void main(final String[] args) { try { int result = new CreateTTL().processArgs(args); System.exit(result); } catch (Exception e) { System.err.println(e.getMessage()); System.exit(1); } } /** * Process command line arguments and create an item with TTL. * * @param args Command line arguments * @return 0 if successful, non-zero otherwise * @throws ResourceNotFoundException If the table doesn't exist * @throws DynamoDbException If an error occurs during the operation * @throws IllegalArgumentException If arguments are invalid */ public int processArgs(final String[] args) { // Argument validation (remove or replace this line when reusing this code) CodeSampleUtils.validateArgs(args, new int[] {3, 4}, USAGE); final String tableName = args[0]; final String primaryKey = args[1]; final String sortKey = args[2]; final Region region = Optional.ofNullable(args.length > 3 ? args[3] : null) .map(Region::of) .orElse(Region.US_EAST_1); try (DynamoDbClient ddb = dynamoDbClient != null ? dynamoDbClient : DynamoDbClient.builder().region(region).build()) { final CreateTTL createTTL = new CreateTTL(ddb); createTTL.createItemWithTTL(tableName, primaryKey, sortKey); return 0; } catch (Exception e) { throw e; } } /** * Creates an item in the specified table with TTL attributes. * * @param tableName The name of the table * @param primaryKeyValue The value for the primary key * @param sortKeyValue The value for the sort key * @return The response from the PutItem operation * @throws ResourceNotFoundException If the table doesn't exist * @throws DynamoDbException If an error occurs during the operation */ public PutItemResponse createItemWithTTL( final String tableName, final String primaryKeyValue, final String sortKeyValue) { // Get current time in epoch second format final long createDate = System.currentTimeMillis() / 1000; // Calculate expiration time 90 days from now in epoch second format final long expireDate = createDate + (DAYS_TO_EXPIRE * SECONDS_PER_DAY); final Map<String, AttributeValue> itemMap = new HashMap<>(); itemMap.put( PRIMARY_KEY_ATTR, AttributeValue.builder().s(primaryKeyValue).build()); itemMap.put(SORT_KEY_ATTR, AttributeValue.builder().s(sortKeyValue).build()); itemMap.put( CREATION_DATE_ATTR, AttributeValue.builder().n(String.valueOf(createDate)).build()); itemMap.put( EXPIRE_AT_ATTR, AttributeValue.builder().n(String.valueOf(expireDate)).build()); final PutItemRequest request = PutItemRequest.builder().tableName(tableName).item(itemMap).build(); try { final PutItemResponse response = dynamoDbClient.putItem(request); System.out.println(String.format(SUCCESS_MESSAGE, tableName)); return response; } catch (ResourceNotFoundException e) { System.err.format(TABLE_NOT_FOUND_ERROR, tableName); throw e; } catch (DynamoDbException e) { System.err.println(e.getMessage()); throw e; } } }
-
For API details, see PutItem in AWS SDK for Java 2.x API Reference.
-