pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin/ApigatewayFunctions

ApigatewayFunctions

object ApigatewayFunctions

Functions

Link copied to clipboard
suspend fun getAuthorizer(argument: GetAuthorizerPlainArgs): GetAuthorizerResult

Provides details about a specific API Gateway Authorizer.

suspend fun getAuthorizer(argument: suspend GetAuthorizerPlainArgsBuilder.() -> Unit): GetAuthorizerResult
suspend fun getAuthorizer(authorizerId: String, restApiId: String): GetAuthorizerResult
Link copied to clipboard
suspend fun getAuthorizers(argument: GetAuthorizersPlainArgs): GetAuthorizersResult

Provides details about multiple API Gateway Authorizers.

suspend fun getAuthorizers(restApiId: String): GetAuthorizersResult
suspend fun getAuthorizers(argument: suspend GetAuthorizersPlainArgsBuilder.() -> Unit): GetAuthorizersResult
Link copied to clipboard
suspend fun getDomainName(argument: GetDomainNamePlainArgs): GetDomainNameResult

Use this data source to get the custom domain name for use with AWS API Gateway.

suspend fun getDomainName(argument: suspend GetDomainNamePlainArgsBuilder.() -> Unit): GetDomainNameResult
suspend fun getDomainName(domainName: String, tags: Map<String, String>? = null): GetDomainNameResult
Link copied to clipboard
suspend fun getExport(argument: GetExportPlainArgs): GetExportResult
suspend fun getExport(argument: suspend GetExportPlainArgsBuilder.() -> Unit): GetExportResult
suspend fun getExport(accepts: String? = null, exportType: String, parameters: Map<String, String>? = null, restApiId: String, stageName: String): GetExportResult
Link copied to clipboard
suspend fun getKey(argument: GetKeyPlainArgs): GetKeyResult

Use this data source to get the name and value of a pre-existing API Key, for example to supply credentials for a dependency microservice.

suspend fun getKey(argument: suspend GetKeyPlainArgsBuilder.() -> Unit): GetKeyResult
suspend fun getKey(id: String, tags: Map<String, String>? = null): GetKeyResult
Link copied to clipboard
suspend fun getResource(argument: GetResourcePlainArgs): GetResourceResult

Use this data source to get the id of a Resource in API Gateway. To fetch the Resource, you must provide the REST API id as well as the full path.

suspend fun getResource(argument: suspend GetResourcePlainArgsBuilder.() -> Unit): GetResourceResult
suspend fun getResource(path: String, restApiId: String): GetResourceResult
Link copied to clipboard
suspend fun getRestApi(argument: GetRestApiPlainArgs): GetRestApiResult

Use this data source to get the id and root_resource_id of a REST API in API Gateway. To fetch the REST API you must provide a name to match against. As there is no unique name constraint on REST APIs this data source will error if there is more than one match.

suspend fun getRestApi(argument: suspend GetRestApiPlainArgsBuilder.() -> Unit): GetRestApiResult
suspend fun getRestApi(name: String, tags: Map<String, String>? = null): GetRestApiResult
Link copied to clipboard
suspend fun getSdk(argument: GetSdkPlainArgs): GetSdkResult
suspend fun getSdk(argument: suspend GetSdkPlainArgsBuilder.() -> Unit): GetSdkResult
suspend fun getSdk(parameters: Map<String, String>? = null, restApiId: String, sdkType: String, stageName: String): GetSdkResult
Link copied to clipboard
suspend fun getVpcLink(argument: GetVpcLinkPlainArgs): GetVpcLinkResult

Use this data source to get the id of a VPC Link in API Gateway. To fetch the VPC Link you must provide a name to match against. As there is no unique name constraint on API Gateway VPC Links this data source will error if there is more than one match.

suspend fun getVpcLink(argument: suspend GetVpcLinkPlainArgsBuilder.() -> Unit): GetVpcLinkResult
suspend fun getVpcLink(name: String, tags: Map<String, String>? = null): GetVpcLinkResult