@aws-amplify/amplify-category-api/API.md

Amplify CLI API Category Plugin

## API Report File for "@aws-amplify/amplify-category-api"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { $TSContext } from '@aws-amplify/amplify-cli-core';
import * as cdk from 'aws-cdk-lib';
import * as cloudmap from 'aws-cdk-lib/aws-servicediscovery';
import { Construct } from 'constructs';
import { DeploymentResources as DeploymentResources_2 } from 'graphql-transformer-core';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as ecs from 'aws-cdk-lib/aws-ecs';
import * as iam from 'aws-cdk-lib/aws-iam';
import { ResolverConfig } from 'graphql-transformer-core';

// @public (undocumented)
export function addAdminQueriesApi(context: $TSContext, apiProps: {
    apiName: string;
    functionName: string;
    authResourceName: string;
    dependsOn: Record<string, any>[];
}): Promise<void>;

// @public (undocumented)
export const addGraphQLAuthorizationMode: (context: $TSContext, args: Record<string, any>) => Promise<{
    authenticationType: string;
}>;

// @public (undocumented)
export type ApiResource = {
    category: string;
    resourceName: string;
    gitHubInfo?: {
        path: string;
        tokenSecretArn: string;
    };
    deploymentMechanism: DEPLOYMENT_MECHANISM;
    authName: string;
    restrictAccess: boolean;
    dependsOn: ResourceDependency[];
    environmentMap: Record<string, string>;
    categoryPolicies: any[];
    mutableParametersState: any;
    output?: Record<string, any>;
    apiType?: API_TYPE;
    exposedContainer?: {
        name: string;
        port: number;
    };
};

// @public (undocumented)
export const checkForcedUpdates: (context: $TSContext) => Promise<void>;

// @public (undocumented)
const console_2: (context: $TSContext) => Promise<void>;
export { console_2 as console }

// @public (undocumented)
export function convertDeperecatedRestApiPaths(deprecatedParametersFileName: string, deprecatedParametersFilePath: string, resourceName: string): {};

// @public (undocumented)
export enum DEPLOYMENT_MECHANISM {
    // (undocumented)
    FULLY_MANAGED = "FULLY_MANAGED",
    // (undocumented)
    INDENPENDENTLY_MANAGED = "INDENPENDENTLY_MANAGED",
    // (undocumented)
    SELF_MANAGED = "SELF_MANAGED"
}

// Warning: (ae-forgotten-export) The symbol "ContainersStack" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export class EcsAlbStack extends ContainersStack {
    // Warning: (ae-forgotten-export) The symbol "EcsStackProps" needs to be exported by the entry point index.d.ts
    constructor(scope: Construct, id: string, ecsProps: EcsStackProps);
}

// @public (undocumented)
export class EcsStack extends ContainersStack {
    // Warning: (ae-forgotten-export) The symbol "EcsStackProps_2" needs to be exported by the entry point index.d.ts
    constructor(scope: Construct, id: string, ecsProps: EcsStackProps_2);
}

// @public (undocumented)
export const executeAmplifyCommand: (context: $TSContext) => Promise<void>;

// @public (undocumented)
export const executeAmplifyHeadlessCommand: (context: $TSContext, headlessPayload: string) => Promise<void>;

// Warning: (ae-forgotten-export) The symbol "ContainerArtifactsMetadata" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function generateContainersArtifacts(context: $TSContext, resource: ApiResource, askForExposedContainer?: boolean): Promise<ContainerArtifactsMetadata>;

// @public (undocumented)
export const getAuthConfig: (context: $TSContext, resourceName: string) => Promise<{
    defaultAuthentication: any;
    additionalAuthenticationProviders: any[];
}>;

// Warning: (ae-forgotten-export) The symbol "DockerServiceInfo" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function getContainers(composeContents?: string, dockerfileContents?: string): DockerServiceInfo;

// @public (undocumented)
export const getDirectiveDefinitions: (context: $TSContext, resourceDir: string) => Promise<string>;

// @public (undocumented)
export function getGitHubOwnerRepoFromPath(path: string): {
    owner: string;
    repo: string;
    branch: string;
    path: string;
};

// @public (undocumented)
export const getPermissionPolicies: (context: $TSContext, resourceOpsMapping: Record<string, any>) => Promise<{
    permissionPolicies: any[];
    resourceAttributes: any[];
}>;

// @public (undocumented)
export const getResolverConfig: (context: $TSContext, resourceName: string) => Promise<ResolverConfig>;

// @public (undocumented)
export const getTransformerVersion: (context: any) => Promise<number>;

// @public (undocumented)
export const handleAmplifyEvent: (context: $TSContext, args: any) => Promise<void>;

// @public (undocumented)
export const initEnv: (context: $TSContext) => Promise<void>;

// @public (undocumented)
export const isDataStoreEnabled: (context: $TSContext) => Promise<boolean>;

// @public (undocumented)
export const migrate: (context: $TSContext, serviceName?: string) => Promise<void>;

// @public (undocumented)
export const NETWORK_STACK_LOGICAL_ID = "NetworkStack";

// @public (undocumented)
export function processDockerConfig(context: $TSContext, resource: ApiResource, srcPath: string, askForExposedContainer?: boolean): Promise<{
    containersPorts: number[];
    containers: Container[];
    isInitialDeploy: boolean;
    desiredCount: number;
    exposedContainer: {
        name: string;
        port: number;
    };
    secretsArns: Map<string, string>;
}>;

// @public (undocumented)
export function promptToAddApiKey(context: $TSContext): Promise<any>;

// @public (undocumented)
export const showApiAuthAcm: (context: $TSContext, modelName: string) => Promise<void>;

// @public (undocumented)
export const transformCategoryStack: (context: $TSContext, resource: Record<string, any>) => Promise<void>;

// Warning: (ae-forgotten-export) The symbol "DeploymentResources" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const transformGraphQLSchema: (context: $TSContext, options: any) => Promise<DeploymentResources | DeploymentResources_2 | undefined>;

// @public (undocumented)
export function updateAdminQueriesApi(context: $TSContext, apiProps: {
    apiName: string;
    functionName: string;
    authResourceName: string;
    dependsOn: Record<string, any>[];
}): Promise<void>;

// Warnings were encountered during analysis:
//
// src/provider-utils/awscloudformation/utils/containers-artifacts.ts:30:3 - (ae-forgotten-export) The symbol "ResourceDependency" needs to be exported by the entry point index.d.ts
// src/provider-utils/awscloudformation/utils/containers-artifacts.ts:35:3 - (ae-forgotten-export) The symbol "API_TYPE" needs to be exported by the entry point index.d.ts
// src/provider-utils/awscloudformation/utils/containers-artifacts.ts:124:42 - (ae-forgotten-export) The symbol "Container" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

```