GradientEdge CDK Utils
    Preparing search index...

    Class ApiToAnyTarget

    Provides a construct to create and deploy a shallow API Gateway

    import { ApiToAnyTarget, ApiToAnyTargetProps } '@gradientedge/cdk-utils'
    import { Construct } from 'constructs'

    class CustomConstruct extends ApiToAnyTarget {
      constructor(parent: Construct, id: string, props: ApiToAnyTargetProps) {
        super(parent, id, props)
        this.props = props
        this.id = id
        this.initResources()
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    acmManager apiManager apiResource apiToAnyTargetRestApi appConfigManager applicationSecrets cloudFrontManager cloudTrailManager cloudWatchManager codeBuildManager dynamodbManager ecrManager ecsManager efsManager eksManager elasticacheManager eventManager eventTargetManager evidentlyManager fullyQualifiedDomainName iamManager id kmsManager lambdaManager logManager node props resourceNameFormatter route53Manager s3Manager secretsManager sfnManager snsManager sqsManager ssmManager vpcManager wafManager

    Methods

    addCfnOutput createApiBasePathMapping createApiDomain createApiRouteAssets createApiToAnyTargetResource createApiToAnyTargetRestApi determineFullyQualifiedDomain initResources isDevelopmentStage isProductionStage isTestStage isUatStage resolveCertificate resolveHostedZone resolveSecrets toString with isConstruct

    Constructors

    Properties

    acmManager: AcmManager

    Manager for AWS Certificate Manager operations

    apiManager: ApiManager

    Manager for API Gateway operations

    apiResource: string

    The default API resource path name

    apiToAnyTargetRestApi: ApiToAnyTargetRestApiType

    The REST API resources (api, integration, domain, etc.)

    appConfigManager: AppConfigManager

    Manager for AWS AppConfig operations

    applicationSecrets: ISecret[]

    The resolved application secrets from SecretsManager

    cloudFrontManager: CloudFrontManager

    Manager for CloudFront distribution operations

    cloudTrailManager: CloudTrailManager

    Manager for CloudTrail operations

    cloudWatchManager: CloudWatchManager

    Manager for CloudWatch operations

    codeBuildManager: CodeBuildManager

    Manager for AWS CodeBuild operations

    dynamodbManager: DynamodbManager

    Manager for DynamoDB operations

    ecrManager: EcrManager

    Manager for Elastic Container Registry operations

    ecsManager: EcsManager

    Manager for Elastic Container Service operations

    efsManager: EfsManager

    Manager for Elastic File System operations

    eksManager: EksManager

    Manager for Elastic Kubernetes Service operations

    elasticacheManager: ElastiCacheManager

    Manager for ElastiCache operations

    eventManager: EventManager

    Manager for EventBridge operations

    eventTargetManager: EventTargetManager

    Manager for EventBridge target operations

    evidentlyManager: EvidentlyManager

    Manager for CloudWatch Evidently operations

    fullyQualifiedDomainName: string

    The fully qualified domain name resolved from domainName and subDomain

    iamManager: IamManager

    Manager for IAM operations

    id: string

    The scoped id of this construct

    kmsManager: KmsManager

    Manager for KMS operations

    lambdaManager: LambdaManager

    Manager for Lambda operations

    logManager: LogManager

    Manager for CloudWatch Logs operations

    node: Node

    The tree node.

    props: ApiToAnyTargetProps

    The API to any target properties

    resourceNameFormatter: ResourceNameFormatter

    Utility for formatting resource names with prefix/suffix conventions

    route53Manager: Route53Manager

    Manager for Route53 operations

    s3Manager: S3Manager

    Manager for S3 operations

    secretsManager: SecretsManager

    Manager for Secrets Manager operations

    sfnManager: SfnManager

    Manager for Step Functions operations

    snsManager: SnsManager

    Manager for SNS operations

    sqsManager: SqsManager

    Manager for SQS operations

    ssmManager: SsmManager

    Manager for Systems Manager operations

    vpcManager: VpcManager

    Manager for VPC operations

    wafManager: WafManager

    Manager for WAF operations

    Methods

    • Parameters

      • id: string

        scoped id of the resource

      • value: string

        the value of the exported output

      • Optionaldescription: string

        optional description for the output

      • overrideId: boolean = true

        Flag which indicates whether to override the default logical id of the output

      Returns CfnOutput

    • Returns a string representation of this construct.

      Returns string

    • Applies one or more mixins to this construct.

      Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

      Parameters

      • ...mixins: IMixin[]

        The mixins to apply

      Returns IConstruct

      This construct for chaining

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods