aws-cdk-lib/aws-appsync/lib/appsync-common.d.ts

Version 2 of the AWS Cloud Development Kit library

import { EventApiBase } from './eventapi';
import { ICertificate } from '../../aws-certificatemanager';
import { IRole } from '../../aws-iam';
import { RetentionDays } from '../../aws-logs';
/**
 * A class used to generate resource arns for AppSync Event APIs
 */
export declare class AppSyncEventResource {
    /**
     * Generate a resource for the calling API
     */
    static forAPI(): AppSyncEventResource;
    /**
     * Generate the resource names given a channel namespace
     *
     * @param channelNamespace The channel namespace that needs to be allowed
     *
     * Example: ofChannelNamespace('default')
     */
    static ofChannelNamespace(channelNamespace: string): AppSyncEventResource;
    /**
     * Generate the resource names that accepts all types: `*`
     */
    static all(): AppSyncEventResource;
    /**
     * Generate the resource names that accepts all channel namespaces: `*`
     */
    static allChannelNamespaces(): AppSyncEventResource;
    private arns;
    private constructor();
    /**
     * Return the Resource ARN
     *
     * @param api The AppSync API to give permissions
     */
    resourceArns(api: EventApiBase): string[];
}
/**
 * log-level for fields in AppSync
 */
export declare enum AppSyncFieldLogLevel {
    /**
     * Resolver logging is disabled
     */
    NONE = "NONE",
    /**
     * Only Error messages appear in logs
     */
    ERROR = "ERROR",
    /**
     * Info and Error messages appear in logs
     */
    INFO = "INFO",
    /**
     * Debug, Info, and Error messages, appear in logs
     */
    DEBUG = "DEBUG",
    /**
     * All messages (Debug, Error, Info, and Trace) appear in logs
     */
    ALL = "ALL"
}
/**
 * Logging configuration for AppSync
 */
export interface AppSyncLogConfig {
    /**
     * exclude verbose content
     *
     * @default false
     */
    readonly excludeVerboseContent?: boolean;
    /**
     * log level for fields
     *
     * @default - Use AppSync default
     */
    readonly fieldLogLevel?: AppSyncFieldLogLevel;
    /**
     * The role for CloudWatch Logs
     *
     * @default - None
     */
    readonly role?: IRole;
    /**
     * The number of days log events are kept in CloudWatch Logs.
     * By default AppSync keeps the logs infinitely. When updating this property,
     * unsetting it doesn't remove the log retention policy.
     * To remove the retention policy, set the value to `INFINITE`
     *
     * @default RetentionDays.INFINITE
     */
    readonly retention?: RetentionDays;
}
/**
 * Domain name configuration for AppSync
 */
export interface AppSyncDomainOptions {
    /**
     * The certificate to use with the domain name.
     */
    readonly certificate: ICertificate;
    /**
     * The actual domain name. For example, `api.example.com`.
     */
    readonly domainName: string;
}