Utilizzare UpdateTimeToLive con un SDK AWS o una CLI - Amazon DynamoDB

Utilizzare UpdateTimeToLive con un SDK AWS o una CLI

Gli esempi di codice seguenti mostrano come utilizzare UpdateTimeToLive.

Gli esempi di operazioni sono estratti di codice da programmi più grandi e devono essere eseguiti nel contesto. È possibile visualizzare questa operazione nel contesto nel seguente esempio di codice:

CLI
AWS CLI

Per aggiornare le impostazioni del Time to Live in una tabella

Nell’esempio seguente update-time-to-live abilita le impostazioni del Time to Live nella tabella specificata.

aws dynamodb update-time-to-live \ --table-name MusicCollection \ --time-to-live-specification Enabled=true,AttributeName=ttl

Output:

{ "TimeToLiveSpecification": { "Enabled": true, "AttributeName": "ttl" } }

Per ulteriori informazioni, consulta Time to Live nella Guida per gli sviluppatori di Amazon DynamoDB.

  • Per informazioni dettagliate sull’API, consulta UpdateTimeToLive nella documentazione di riferimento dei comandi della AWS CLI.

Java
SDK per Java 2.x

Per abilitare il TTL in una tabella DynamoDB esistente con AWS SDK for Java 2.x.

import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.dynamodb.model.DynamoDbException; import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException; import software.amazon.awssdk.services.dynamodb.model.TimeToLiveSpecification; import software.amazon.awssdk.services.dynamodb.model.UpdateTimeToLiveRequest; import software.amazon.awssdk.services.dynamodb.model.UpdateTimeToLiveResponse; import java.util.logging.Level; import java.util.logging.Logger; public UpdateTimeToLiveResponse enableTTL(final String tableName, final String attributeName, final Region region) { final TimeToLiveSpecification ttlSpec = TimeToLiveSpecification.builder() .attributeName(attributeName) .enabled(true) .build(); final UpdateTimeToLiveRequest request = UpdateTimeToLiveRequest.builder() .tableName(tableName) .timeToLiveSpecification(ttlSpec) .build(); try (DynamoDbClient ddb = dynamoDbClient != null ? dynamoDbClient : DynamoDbClient.builder().region(region).build()) { return ddb.updateTimeToLive(request); } catch (ResourceNotFoundException e) { System.err.format(TABLE_NOT_FOUND_ERROR, tableName); throw e; } catch (DynamoDbException e) { System.err.println(e.getMessage()); throw e; } }

Per disabilitare il TTL in una tabella DynamoDB esistente con AWS SDK for Java 2.x.

import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.dynamodb.DynamoDbClient; import software.amazon.awssdk.services.dynamodb.model.DynamoDbException; import software.amazon.awssdk.services.dynamodb.model.ResourceNotFoundException; import software.amazon.awssdk.services.dynamodb.model.TimeToLiveSpecification; import software.amazon.awssdk.services.dynamodb.model.UpdateTimeToLiveRequest; import software.amazon.awssdk.services.dynamodb.model.UpdateTimeToLiveResponse; import java.util.logging.Level; import java.util.logging.Logger; public UpdateTimeToLiveResponse disableTTL( final String tableName, final String attributeName, final Region region) { final TimeToLiveSpecification ttlSpec = TimeToLiveSpecification.builder() .attributeName(attributeName) .enabled(false) .build(); final UpdateTimeToLiveRequest request = UpdateTimeToLiveRequest.builder() .tableName(tableName) .timeToLiveSpecification(ttlSpec) .build(); try (DynamoDbClient ddb = dynamoDbClient != null ? dynamoDbClient : DynamoDbClient.builder().region(region).build()) { return ddb.updateTimeToLive(request); } catch (ResourceNotFoundException e) { System.err.format(TABLE_NOT_FOUND_ERROR, tableName); throw e; } catch (DynamoDbException e) { System.err.println(e.getMessage()); throw e; } }
  • Per informazioni dettagliate sull’API, consulta UpdateTimeToLive nella documentazione di riferimento dell’API AWS SDK for Java 2.x.

JavaScript
SDK per JavaScript (v3)

Per abilitare il TTL in una tabella DynamoDB esistente.

import { DynamoDBClient, UpdateTimeToLiveCommand } from "@aws-sdk/client-dynamodb"; export const enableTTL = async (tableName, ttlAttribute, region = 'us-east-1') => { const client = new DynamoDBClient({ region: region, endpoint: `https://dynamodb.${region}.amazonaws.com` }); const params = { TableName: tableName, TimeToLiveSpecification: { Enabled: true, AttributeName: ttlAttribute } }; try { const response = await client.send(new UpdateTimeToLiveCommand(params)); if (response.$metadata.httpStatusCode === 200) { console.log(`TTL enabled successfully for table ${tableName}, using attribute name ${ttlAttribute}.`); } else { console.log(`Failed to enable TTL for table ${tableName}, response object: ${response}`); } return response; } catch (e) { console.error(`Error enabling TTL: ${e}`); throw e; } }; // Example usage (commented out for testing) // enableTTL('ExampleTable', 'exampleTtlAttribute');

Per disabilitare il TTL in una tabella DynamoDB esistente.

import { DynamoDBClient, UpdateTimeToLiveCommand } from "@aws-sdk/client-dynamodb"; export const disableTTL = async (tableName, ttlAttribute, region = 'us-east-1') => { const client = new DynamoDBClient({ region: region, endpoint: `https://dynamodb.${region}.amazonaws.com` }); const params = { TableName: tableName, TimeToLiveSpecification: { Enabled: false, AttributeName: ttlAttribute } }; try { const response = await client.send(new UpdateTimeToLiveCommand(params)); if (response.$metadata.httpStatusCode === 200) { console.log(`TTL disabled successfully for table ${tableName}, using attribute name ${ttlAttribute}.`); } else { console.log(`Failed to disable TTL for table ${tableName}, response object: ${response}`); } return response; } catch (e) { console.error(`Error disabling TTL: ${e}`); throw e; } }; // Example usage (commented out for testing) // disableTTL('ExampleTable', 'exampleTtlAttribute');
  • Per informazioni dettagliate sull’API, consulta UpdateTimeToLive nella documentazione di riferimento dell’API AWS SDK per JavaScript.

Python
SDK per Python (Boto3)

Per abilitare il TTL in una tabella DynamoDB esistente.

import boto3 def enable_ttl(table_name, ttl_attribute_name): """ Enables TTL on DynamoDB table for a given attribute name on success, returns a status code of 200 on error, throws an exception :param table_name: Name of the DynamoDB table :param ttl_attribute_name: The name of the TTL attribute being provided to the table. """ try: dynamodb = boto3.client("dynamodb") # Enable TTL on an existing DynamoDB table response = dynamodb.update_time_to_live( TableName=table_name, TimeToLiveSpecification={"Enabled": True, "AttributeName": ttl_attribute_name}, ) # In the returned response, check for a successful status code. if response["ResponseMetadata"]["HTTPStatusCode"] == 200: print("TTL has been enabled successfully.") else: print( f"Failed to enable TTL, status code {response['ResponseMetadata']['HTTPStatusCode']}" ) return response except Exception as ex: print("Couldn't enable TTL in table %s. Here's why: %s" % (table_name, ex)) raise # your values enable_ttl("your-table-name", "expireAt")

Per disabilitare il TTL in una tabella DynamoDB esistente.

import boto3 def disable_ttl(table_name, ttl_attribute_name): """ Disables TTL on DynamoDB table for a given attribute name on success, returns a status code of 200 on error, throws an exception :param table_name: Name of the DynamoDB table being modified :param ttl_attribute_name: The name of the TTL attribute being provided to the table. """ try: dynamodb = boto3.client("dynamodb") # Enable TTL on an existing DynamoDB table response = dynamodb.update_time_to_live( TableName=table_name, TimeToLiveSpecification={"Enabled": False, "AttributeName": ttl_attribute_name}, ) # In the returned response, check for a successful status code. if response["ResponseMetadata"]["HTTPStatusCode"] == 200: print("TTL has been disabled successfully.") else: print( f"Failed to disable TTL, status code {response['ResponseMetadata']['HTTPStatusCode']}" ) except Exception as ex: print("Couldn't disable TTL in table %s. Here's why: %s" % (table_name, ex)) raise # your values disable_ttl("your-table-name", "expireAt")
  • Per informazioni dettagliate sull’API, consulta UpdateTimeToLive nella documentazione di riferimento dell’API AWS SDK per Python (Boto3).

Per un elenco completo delle guide per gli sviluppatori di SDK AWS ed esempi di codice, consulta la sezione Utilizzo di DynamoDB con un SDK AWS. Questo argomento include anche informazioni su come iniziare e dettagli sulle versioni precedenti dell'SDK.