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

ApigatewayFunctions

object ApigatewayFunctions

Functions

Link copied to clipboard
suspend fun getAccount(argument: GetAccountPlainArgs): GetAccountResult

The `AWS::ApiGateway::Account` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one `AWS::ApiGateway::Account` resource per region per account.

suspend fun getAccount(id: String): GetAccountResult
suspend fun getAccount(argument: suspend GetAccountPlainArgsBuilder.() -> Unit): GetAccountResult
Link copied to clipboard
suspend fun getApiKey(argument: GetApiKeyPlainArgs): GetApiKeyResult

The `AWS::ApiGateway::ApiKey` resource creates a unique key that you can distribute to clients who are executing API Gateway `Method` resources that require an API key. To specify which API key clients must use, map the API key with the `RestApi` and `Stage` resources that include the methods that require a key.

suspend fun getApiKey(apiKeyId: String): GetApiKeyResult
suspend fun getApiKey(argument: suspend GetApiKeyPlainArgsBuilder.() -> Unit): GetApiKeyResult
Link copied to clipboard
suspend fun getAuthorizer(argument: GetAuthorizerPlainArgs): GetAuthorizerResult

The `AWS::ApiGateway::Authorizer` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.

suspend fun getAuthorizer(argument: suspend GetAuthorizerPlainArgsBuilder.() -> Unit): GetAuthorizerResult
suspend fun getAuthorizer(authorizerId: String, restApiId: String): GetAuthorizerResult
Link copied to clipboard
suspend fun getBasePathMapping(argument: GetBasePathMappingPlainArgs): GetBasePathMappingResult

The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL.

suspend fun getBasePathMapping(argument: suspend GetBasePathMappingPlainArgsBuilder.() -> Unit): GetBasePathMappingResult
suspend fun getBasePathMapping(basePath: String, domainName: String): GetBasePathMappingResult
Link copied to clipboard
suspend fun getBasePathMappingV2(argument: GetBasePathMappingV2PlainArgs): GetBasePathMappingV2Result

Resource Type definition for AWS::ApiGateway::BasePathMappingV2

suspend fun getBasePathMappingV2(basePathMappingArn: String): GetBasePathMappingV2Result
suspend fun getBasePathMappingV2(argument: suspend GetBasePathMappingV2PlainArgsBuilder.() -> Unit): GetBasePathMappingV2Result
Link copied to clipboard
suspend fun getClientCertificate(argument: GetClientCertificatePlainArgs): GetClientCertificateResult

The `AWS::ApiGateway::ClientCertificate` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

suspend fun getClientCertificate(clientCertificateId: String): GetClientCertificateResult
suspend fun getClientCertificate(argument: suspend GetClientCertificatePlainArgsBuilder.() -> Unit): GetClientCertificateResult
Link copied to clipboard
suspend fun getDeployment(argument: GetDeploymentPlainArgs): GetDeploymentResult

The `AWS::ApiGateway::Deployment` resource deploys an API Gateway `RestApi` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.

suspend fun getDeployment(argument: suspend GetDeploymentPlainArgsBuilder.() -> Unit): GetDeploymentResult
suspend fun getDeployment(deploymentId: String, restApiId: String): GetDeploymentResult
Link copied to clipboard
suspend fun getDocumentationPart(argument: GetDocumentationPartPlainArgs): GetDocumentationPartResult

The `AWS::ApiGateway::DocumentationPart` resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

suspend fun getDocumentationPart(argument: suspend GetDocumentationPartPlainArgsBuilder.() -> Unit): GetDocumentationPartResult
suspend fun getDocumentationPart(documentationPartId: String, restApiId: String): GetDocumentationPartResult
Link copied to clipboard
suspend fun getDocumentationVersion(argument: GetDocumentationVersionPlainArgs): GetDocumentationVersionResult

The `AWS::ApiGateway::DocumentationVersion` resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

suspend fun getDocumentationVersion(argument: suspend GetDocumentationVersionPlainArgsBuilder.() -> Unit): GetDocumentationVersionResult
suspend fun getDocumentationVersion(documentationVersion: String, restApiId: String): GetDocumentationVersionResult
Link copied to clipboard
suspend fun getDomainName(argument: GetDomainNamePlainArgs): GetDomainNameResult

The `AWS::ApiGateway::DomainName` resource specifies a custom domain name for your API in API Gateway. You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide.

suspend fun getDomainName(domainName: String): GetDomainNameResult
suspend fun getDomainName(argument: suspend GetDomainNamePlainArgsBuilder.() -> Unit): GetDomainNameResult
Link copied to clipboard
Link copied to clipboard
suspend fun getDomainNameV2(argument: GetDomainNameV2PlainArgs): GetDomainNameV2Result

Resource Type definition for AWS::ApiGateway::DomainNameV2.

suspend fun getDomainNameV2(domainNameArn: String): GetDomainNameV2Result
suspend fun getDomainNameV2(argument: suspend GetDomainNameV2PlainArgsBuilder.() -> Unit): GetDomainNameV2Result
Link copied to clipboard
suspend fun getGatewayResponse(argument: GetGatewayResponsePlainArgs): GetGatewayResponseResult

The `AWS::ApiGateway::GatewayResponse` resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.

suspend fun getGatewayResponse(id: String): GetGatewayResponseResult
suspend fun getGatewayResponse(argument: suspend GetGatewayResponsePlainArgsBuilder.() -> Unit): GetGatewayResponseResult
Link copied to clipboard
suspend fun getMethod(argument: GetMethodPlainArgs): GetMethodResult

The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.

suspend fun getMethod(argument: suspend GetMethodPlainArgsBuilder.() -> Unit): GetMethodResult
suspend fun getMethod(httpMethod: String, resourceId: String, restApiId: String): GetMethodResult
Link copied to clipboard
suspend fun getModel(argument: GetModelPlainArgs): GetModelResult

The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.

suspend fun getModel(argument: suspend GetModelPlainArgsBuilder.() -> Unit): GetModelResult
suspend fun getModel(name: String, restApiId: String): GetModelResult
Link copied to clipboard
suspend fun getRequestValidator(argument: GetRequestValidatorPlainArgs): GetRequestValidatorResult

The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an API in API Gateway in the API Gateway Developer Guide.

suspend fun getRequestValidator(argument: suspend GetRequestValidatorPlainArgsBuilder.() -> Unit): GetRequestValidatorResult
suspend fun getRequestValidator(requestValidatorId: String, restApiId: String): GetRequestValidatorResult
Link copied to clipboard
suspend fun getResource(argument: GetResourcePlainArgs): GetResourceResult

The `AWS::ApiGateway::Resource` resource creates a resource in an API.

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

The `AWS::ApiGateway::RestApi` resource creates a REST API. For more information, see restapi:create in the Amazon API Gateway REST API Reference. On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative, becoming the foundation of the OpenAPI Specification.

suspend fun getRestApi(restApiId: String): GetRestApiResult
suspend fun getRestApi(argument: suspend GetRestApiPlainArgsBuilder.() -> Unit): GetRestApiResult
Link copied to clipboard
suspend fun getStage(argument: GetStagePlainArgs): GetStageResult

The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.

suspend fun getStage(argument: suspend GetStagePlainArgsBuilder.() -> Unit): GetStageResult
suspend fun getStage(restApiId: String, stageName: String): GetStageResult
Link copied to clipboard
suspend fun getUsagePlan(argument: GetUsagePlanPlainArgs): GetUsagePlanResult

The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see Creating and Using API Usage Plans in Amazon API Gateway in the API Gateway Developer Guide. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using to monitor costs and to manage API requests.

suspend fun getUsagePlan(id: String): GetUsagePlanResult
suspend fun getUsagePlan(argument: suspend GetUsagePlanPlainArgsBuilder.() -> Unit): GetUsagePlanResult
Link copied to clipboard
suspend fun getUsagePlanKey(argument: GetUsagePlanKeyPlainArgs): GetUsagePlanKeyResult

The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

suspend fun getUsagePlanKey(id: String): GetUsagePlanKeyResult
suspend fun getUsagePlanKey(argument: suspend GetUsagePlanKeyPlainArgsBuilder.() -> Unit): GetUsagePlanKeyResult
Link copied to clipboard
suspend fun getVpcLink(argument: GetVpcLinkPlainArgs): GetVpcLinkResult

The `AWS::ApiGateway::VpcLink` resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see vpclink:create in the `Amazon API Gateway REST API Reference`.

suspend fun getVpcLink(vpcLinkId: String): GetVpcLinkResult
suspend fun getVpcLink(argument: suspend GetVpcLinkPlainArgsBuilder.() -> Unit): GetVpcLinkResult