72 lines
2.8 KiB
TypeScript
72 lines
2.8 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import { CallApiGatewayEndpointBase } from './base';
|
|
import type { CallApiGatewayEndpointBaseProps, CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayEndpointJsonPathBaseProps } from './base-types';
|
|
import type * as iam from '../../../aws-iam';
|
|
import * as sfn from '../../../aws-stepfunctions';
|
|
import * as cdk from '../../../core';
|
|
/**
|
|
* Base properties for calling an HTTP API Endpoint
|
|
*/
|
|
export interface CallApiGatewayHttpApiEndpointOptions {
|
|
/**
|
|
* The Id of the API to call
|
|
*/
|
|
readonly apiId: string;
|
|
/**
|
|
* The Stack in which the API is defined
|
|
*/
|
|
readonly apiStack: cdk.Stack;
|
|
/**
|
|
* Name of the stage where the API is deployed to in API Gateway
|
|
* @default '$default'
|
|
*/
|
|
readonly stageName?: string;
|
|
}
|
|
/**
|
|
* Properties for calling an HTTP API Endpoint using JSONPath
|
|
*/
|
|
export interface CallApiGatewayHttpApiEndpointJsonPathProps extends CallApiGatewayEndpointJsonPathBaseProps, CallApiGatewayHttpApiEndpointOptions {
|
|
}
|
|
/**
|
|
* Properties for calling an HTTP API Endpoint using JSONata
|
|
*/
|
|
export interface CallApiGatewayHttpApiEndpointJsonataProps extends CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayHttpApiEndpointOptions {
|
|
}
|
|
/**
|
|
* Properties for calling an HTTP API Endpoint
|
|
*/
|
|
export interface CallApiGatewayHttpApiEndpointProps extends CallApiGatewayEndpointBaseProps, CallApiGatewayHttpApiEndpointOptions {
|
|
}
|
|
/**
|
|
* Call HTTP API endpoint as a Task
|
|
*
|
|
* @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html
|
|
*/
|
|
export declare class CallApiGatewayHttpApiEndpoint extends CallApiGatewayEndpointBase {
|
|
private readonly props;
|
|
/**
|
|
* Uniquely identifies this class.
|
|
*/
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
/**
|
|
* Call HTTP API endpoint as a Task using JSONPath
|
|
*
|
|
* @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html
|
|
*/
|
|
static jsonPath(scope: Construct, id: string, props: CallApiGatewayHttpApiEndpointJsonPathProps): CallApiGatewayHttpApiEndpoint;
|
|
/**
|
|
* Call HTTP API endpoint as a Task using JSONata
|
|
*
|
|
* @see https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html
|
|
*/
|
|
static jsonata(scope: Construct, id: string, props: CallApiGatewayHttpApiEndpointJsonataProps): CallApiGatewayHttpApiEndpoint;
|
|
protected readonly taskMetrics?: sfn.TaskMetricsConfig | undefined;
|
|
protected readonly taskPolicies?: iam.PolicyStatement[] | undefined;
|
|
protected readonly apiEndpoint: string;
|
|
protected readonly arnForExecuteApi: string;
|
|
protected readonly stageName?: string;
|
|
constructor(scope: Construct, id: string, props: CallApiGatewayHttpApiEndpointProps);
|
|
private getApiEndpoint;
|
|
private getArnForExecuteApi;
|
|
}
|