MDAA TS Docs
    Preparing search index...

    Interface M2MApiProps

    REST API configuration for machine-to-machine data lake access. Deploys API Gateway with Cognito client credentials auth, WAF WebACL with CIDR-based IP filtering, and Lambda integration for S3 data operations. A default WAF is always generated; additional WAFs can be attached via wafArns.

    Use cases: Automated data lake ingestion; Service-to-service data operations; Programmatic S3 access via REST API

    AWS: API Gateway REST API, Cognito User Pool, WAF WebACL, Lambda integration

    Validation: adminRoles, targetBucketName, targetPrefix, allowedCidrs, and concurrencyLimit required

    interface M2MApiProps {
        adminRoles: MdaaRoleRef[];
        allowedCidrs: string[];
        appClients?: NamedAppClientProps;
        concurrencyLimit: number;
        eventMetadataMappings?: { [dest: string]: string };
        integrationLambdaRoleArn?: string;
        kmsKeyArn?: string;
        metadataTargetPrefix?: string;
        requestParameters?: { [paramName: string]: boolean };
        setAccountCloudWatchRole?: boolean;
        stageName?: string;
        targetBucketName: string;
        targetPrefix: string;
        wafArns?: { [wafname: string]: string };
    }
    Index

    Properties

    adminRoles allowedCidrs appClients? concurrencyLimit eventMetadataMappings? integrationLambdaRoleArn? kmsKeyArn? metadataTargetPrefix? requestParameters? setAccountCloudWatchRole? stageName? targetBucketName targetPrefix wafArns?

    Properties

    adminRoles: MdaaRoleRef[]

    Roles which will be provided Admin access to the KMS key, and KeyPair secrets.

    allowedCidrs: string[]

    IPv4 CIDR blocks permitted to access the API. All other IPs are denied by the WAF WebACL IP set rule.

    Use cases: Corporate network restrictions; IP-based API access control

    AWS: WAF WebACL IP set for API Gateway access filtering

    Validation: Required; array of valid CIDR blocks (e.g. 10.0.0.0/8)

    appClients?: NamedAppClientProps

    List of Cognito app clients to be created.

    concurrencyLimit: number

    Reserved concurrency limit for the API integration Lambda function. Prevents resource exhaustion and ensures predictable API performance.

    Use cases: API throttling; Cost control; Predictable Lambda scaling

    AWS: Lambda reserved concurrency for API Gateway integration

    Validation: Required; positive integer

    eventMetadataMappings?: { [dest: string]: string }

    Specified fields will be mapped from the request into the metadata persisted in S3 for each upload request. The key is the destination key in the metadata, and the value is the event source key in dot notation such as "requestContext.requestTime".

    integrationLambdaRoleArn?: string

    If specified, the integration Lambda function will run as this role. If not specified, one will be generated

    kmsKeyArn?: string

    Specific key to use to encrypt CloudWatch logs. If not specifed, one will be created.

    metadataTargetPrefix?: string

    Identifies the target prefix for metadata within the bucket. If not specified, will default to targetPrefix.

    requestParameters?: { [paramName: string]: boolean }

    Map of accepted request parameter names to boolean indicating if they are required. If specified, API gateway will validate that: 1) each provided parameter is accepted; and 2) all required parameters have been provided.

    setAccountCloudWatchRole?: boolean

    If true (default false), the API Gateway Cloudwatch role will be set at the account/region level. This should be done only once per account/region.

    stageName?: string

    API Gateway deployment stage name (e.g. dev, staging, prod).

    Use cases: Environment separation; Multi-stage API deployment

    AWS: API Gateway deployment stage

    Validation: Optional; valid API Gateway stage name

    prod
    targetBucketName: string

    S3 bucket name where API operations read/write data.

    Use cases: Data lake target for API-driven ingestion and retrieval

    AWS: S3 bucket for Lambda integration data operations

    Validation: Required; must be existing S3 bucket name

    targetPrefix: string

    Required. Identifies the target prefix within the bucket

    wafArns?: { [wafname: string]: string }

    Arns of WAF to be applied to API.

    Settings

    Member Visibility

    On This Page

    Properties