GradientEdge CDK Utils
    Preparing search index...

    Interface RestApiLambdaProps

    interface RestApiLambdaProps {
        analyticsReporting?: boolean;
        apiRootPaths?: string[];
        apiSubDomain: string;
        crossRegionReferences?: boolean;
        debug?: boolean;
        defaultReservedLambdaConcurrentExecutions?: number;
        defaultTracing?: Tracing;
        description?: string;
        domainName: string;
        env?: Environment;
        excludeAccountNumberForBuckets?: boolean;
        excludeDomainNameForBuckets?: boolean;
        extraContexts?: string[];
        globalPrefix?: string;
        globalSuffix?: string;
        logLevel: string;
        logRetention?: RetentionDays;
        name: string;
        nodeEnv: string;
        nodejsRuntime?: Runtime;
        notificationArns?: string[];
        permissionsBoundary?: PermissionsBoundary;
        propertyInjectors?: IPropertyInjector[];
        region: string;
        regionContextPath?: string;
        resourceNameOptions?: { [key: string]: ResourceNameFormatterProps };
        resourcePrefix?: string;
        resourceProjectIdentifier?: string;
        resourceSuffix?: string;
        restApi: LambdaRestApiProps;
        restApiCertificate: AcmProps;
        restApiHandler: string;
        restApiLambda: LambdaProps;
        restApiLambdaLayerSources?: AssetCode[];
        restApiSource: AssetCode;
        skipStageForARecords?: boolean;
        stackName?: string;
        stage: string;
        stageContextPath?: string;
        stageRegionContextPath?: string;
        subDomain?: string;
        suppressTemplateIndentation?: boolean;
        synthesizer?: IStackSynthesizer;
        tags?: { [key: string]: string };
        terminationProtection?: boolean;
        timezone: string;
        useExistingHostedZone: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    analyticsReporting? apiRootPaths? apiSubDomain crossRegionReferences? debug? defaultReservedLambdaConcurrentExecutions? defaultTracing? description? domainName env? excludeAccountNumberForBuckets? excludeDomainNameForBuckets? extraContexts? globalPrefix? globalSuffix? logLevel logRetention? name nodeEnv nodejsRuntime? notificationArns? permissionsBoundary? propertyInjectors? region regionContextPath? resourceNameOptions? resourcePrefix? resourceProjectIdentifier? resourceSuffix? restApi restApiCertificate restApiHandler restApiLambda restApiLambdaLayerSources? restApiSource skipStageForARecords? stackName? stage stageContextPath? stageRegionContextPath? subDomain? suppressTemplateIndentation? synthesizer? tags? terminationProtection? timezone useExistingHostedZone

    Properties

    analyticsReporting?: boolean

    Include runtime versioning information in this Stack

    analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

    apiRootPaths?: string[]

    Additional API root paths for base path mappings

    apiSubDomain: string

    The subdomain for the API Gateway custom domain

    crossRegionReferences?: boolean

    Enable this flag to allow native cross region stack references.

    Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

    This feature is currently experimental

    false
    debug?: boolean

    Enable debug logging output

    defaultReservedLambdaConcurrentExecutions?: number

    The default reserved concurrent executions for Lambda functions

    defaultTracing?: Tracing

    The default tracing configuration for Lambda functions

    description?: string

    A description of the stack.

    - No description.
    domainName: string

    The root domain name for the deployment

    env?: Environment

    The AWS environment (account/region) where this stack will be deployed.

    Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

    If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

    If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

    // Use a concrete account and region to deploy this stack to:
    // `.account` and `.region` will simply return these values.
    new Stack(app, 'Stack1', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      },
    });

    // Use the CLI's current credentials to determine the target environment:
    // `.account` and `.region` will reflect the account+region the CLI
    // is configured to use (based on the user CLI credentials)
    new Stack(app, 'Stack2', {
      env: {
        account: process.env.CDK_DEFAULT_ACCOUNT,
        region: process.env.CDK_DEFAULT_REGION
      },
    });

    // Define multiple stacks stage associated with an environment
    const myStage = new Stage(app, 'MyStage', {
      env: {
        account: '123456789012',
        region: 'us-east-1'
      }
    });

    // both of these stacks will use the stage's account/region:
    // `.account` and `.region` will resolve to the concrete values as above
    new MyStack(myStage, 'Stack1');
    new YourStack(myStage, 'Stack2');

    // Define an environment-agnostic stack:
    // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
    // which will only resolve to actual values by CloudFormation during deployment.
    new MyStack(app, 'Stack1');
    • The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.
    excludeAccountNumberForBuckets?: boolean

    Whether to exclude the account number from S3 bucket names

    excludeDomainNameForBuckets?: boolean

    Whether to exclude the domain name from S3 bucket names

    extraContexts?: string[]

    Additional CDK context file paths to load

    globalPrefix?: string

    Global prefix prepended to all resource names

    globalSuffix?: string

    Global suffix appended to all resource names

    logLevel: string

    The application log level

    logRetention?: RetentionDays

    The log retention period for CloudWatch log groups

    name: string

    The name identifier for the stack or construct

    nodeEnv: string

    The Node.js environment (e.g. development, production)

    nodejsRuntime?: Runtime

    The Node.js runtime version for Lambda functions

    notificationArns?: string[]

    SNS Topic ARNs that will receive stack events.

    - no notification arns.
    permissionsBoundary?: PermissionsBoundary

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

    - no permissions boundary is applied
    propertyInjectors?: IPropertyInjector[]

    A list of IPropertyInjector attached to this Stack.

    - no PropertyInjectors
    region: string

    The AWS region for resource deployment

    regionContextPath?: string

    The relative path to region-specific context files

    resourceNameOptions?: { [key: string]: ResourceNameFormatterProps }

    Per-service resource name formatting options

    resourcePrefix?: string

    Default prefix for resource names

    resourceProjectIdentifier?: string

    Optional project identifier used in resource naming

    resourceSuffix?: string

    Default suffix for resource names

    restApi: LambdaRestApiProps

    The API Gateway REST API configuration

    restApiCertificate: AcmProps

    The SSL/TLS certificate configuration

    restApiHandler: string

    The Lambda handler entry point

    restApiLambda: LambdaProps

    The Lambda function configuration

    restApiLambdaLayerSources?: AssetCode[]

    The source code assets for Lambda layers

    restApiSource: AssetCode

    The Lambda function source code asset

    skipStageForARecords?: boolean

    Whether to omit the stage prefix for Route53 A records

    stackName?: string

    Name to deploy the stack with

    - Derived from construct path.
    stage: string

    The deployment stage (e.g. dev, tst, uat, prd)

    stageContextPath?: string

    The relative path to stage-specific context files

    stageRegionContextPath?: string

    The relative path to stage-region-specific context files

    subDomain?: string

    The subdomain prefix for the deployment

    suppressTemplateIndentation?: boolean

    Enable this flag to suppress indentation in generated CloudFormation templates.

    If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

    • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.
    synthesizer?: IStackSynthesizer

    Synthesis method to use while deploying this stack

    The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

    If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

    • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.
    tags?: { [key: string]: string }

    Tags that will be applied to the Stack

    These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.

    However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.

    {}
    terminationProtection?: boolean

    Whether to enable termination protection for this stack.

    false
    timezone: string

    The timezone for the application

    useExistingHostedZone: boolean

    Whether to look up an existing hosted zone instead of creating one

    Settings

    Member Visibility

    On This Page

    Properties