@aws-amplify/graphql-api-construct/lib/amplify-dynamodb-table-wrapper.d.ts

AppSync GraphQL Api Construct using Amplify GraphQL Transformer.

import { CfnResource, RemovalPolicy } from 'aws-cdk-lib';
import { BillingMode, StreamViewType } from 'aws-cdk-lib/aws-dynamodb';
/**
 * Shape for TTL config.
 */
export interface TimeToLiveSpecification {
    /**
     * Boolean determining if the ttl is enabled or not.
     */
    readonly enabled: boolean;
    /**
     * Attribute name to apply to the ttl spec.
     */
    readonly attributeName?: string;
}
/**
 * Reference to PointInTimeRecovey Specification
 * for continuous backups
 */
export interface PointInTimeRecoverySpecification {
    /**
     * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
     */
    readonly pointInTimeRecoveryEnabled: boolean;
    /**
     * The number of preceding days for which continuous backups are taken and maintained.
     * Your table data is only recoverable to any point-in-time from within the configured recovery period.
     * If no value is provided, the value will default to 35.
     */
    readonly recoveryPeriodInDays?: number;
}
/**
 * Wrapper for provisioned throughput config in DDB.
 */
export interface ProvisionedThroughput {
    /**
     * The read capacity units on the table or index.
     */
    readonly readCapacityUnits: number;
    /**
     * The write capacity units on the table or index.
     */
    readonly writeCapacityUnits: number;
}
/**
 * Server Side Encryption Type Values
 * - `KMS` - Server-side encryption that uses AWS KMS. The key is stored in your account and is managed by KMS (AWS KMS charges apply).
 */
export declare enum SSEType {
    KMS = "KMS"
}
/**
 * Represents the settings used to enable server-side encryption.
 */
export interface SSESpecification {
    /**
     * Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key.
     * If enabled (true), server-side encryption type is set to `KMS` and an AWS managed key is used ( AWS KMS charges apply).
     * If disabled (false) or not specified, server-side encryption is set to AWS owned key.
     */
    readonly sseEnabled: boolean;
    /**
     * The AWS KMS key that should be used for the AWS KMS encryption.
     * To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide
     * this parameter if the key is different from the default DynamoDB key `alias/aws/dynamodb` .
     */
    readonly kmsMasterKeyId?: string;
    /**
     * Server-side encryption type. The only supported value is:
     * `KMS` Server-side encryption that uses AWS Key Management Service.
     *   The key is stored in your account and is managed by AWS KMS ( AWS KMS charges apply).
     */
    readonly sseType?: SSEType;
}
/**
 * Represents the DynamoDB Streams configuration for a table in DynamoDB.
 */
export interface StreamSpecification {
    /**
     * When an item in the table is modified, `StreamViewType` determines what information is written to the stream for this table.
     * Valid values for `StreamViewType` are:
     * - `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
     * - `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
     * - `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
     * - `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
     */
    readonly streamViewType: StreamViewType;
}
/**
 * Wrapper class around Custom::AmplifyDynamoDBTable custom resource, to simplify
 * the override experience a bit. This is NOT a construct, just an easier way to access
 * the generated construct.
 * This is a wrapper intended to mimic the `aws_cdk_lib.aws_dynamodb.Table` functionality more-or-less.
 * Notable differences is the addition of TKTK properties, to account for the fact that they're constructor props
 * in the CDK construct, as well as the removal of all from*, grant*, and metric* methods implemented by Table.
 */
export declare class AmplifyDynamoDbTableWrapper {
    private readonly resource;
    /**
     * Return true and perform type narrowing if a given input appears to be capable of
     * @param x the object to check.
     * @returns whether or not the resource is an underlying amplify dynamodb table resource.
     */
    static isAmplifyDynamoDbTableResource(x: any): x is CfnResource;
    /**
     * Create the wrapper given an underlying CfnResource that is an instance of Custom::AmplifyDynamoDBTable.
     * @param resource the Cfn resource.
     */
    constructor(resource: CfnResource);
    /**
     * Set the deletion policy of the resource based on the removal policy specified.
     * @param policy removal policy to set
     */
    applyRemovalPolicy(policy: RemovalPolicy): void;
    /**
     * Specify how you are charged for read and write throughput and how you manage capacity.
     */
    set billingMode(billingMode: BillingMode);
    /**
     * The name of TTL attribute.
     */
    set timeToLiveAttribute(timeToLiveSpecification: TimeToLiveSpecification);
    /**
     * Whether point-in-time recovery is enabled.
     */
    set pointInTimeRecoveryEnabled(pointInTimeRecoveryEnabled: boolean);
    /**
     * Whether point-in-time recovery is enabled
     * and recoveryPeriodInDays is set.
     */
    set pointInTimeRecoverySpecification(pointInTimeRecoverySpecification: PointInTimeRecoverySpecification);
    /**
     * Update the provisioned throughput for the base table.
     */
    set provisionedThroughput(provisionedThroughput: ProvisionedThroughput);
    /**
     * Set the provisionedThroughtput for a specified GSI by name.
     * @param indexName the index to specify a provisionedThroughput config for
     * @param provisionedThroughput the config to set
     */
    setGlobalSecondaryIndexProvisionedThroughput(indexName: string, provisionedThroughput: ProvisionedThroughput): void;
    /**
     * Set the ddb stream specification on the table.
     */
    set streamSpecification(streamSpecification: StreamSpecification);
    /**
     * Set the ddb server-side encryption specification on the table.
     */
    set sseSpecification(sseSpecification: SSESpecification);
    /**
     * Set table deletion protection.
     */
    set deletionProtectionEnabled(deletionProtectionEnabled: boolean);
}