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

ApigatewayFunctions

Functions

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

getApiKey

suspend fun getApiKey(argument: GetApiKeyPlainArgs): GetApiKeyResult

Resource Type definition for AWS::ApiGateway::ApiKey

suspend fun getApiKey(apiKeyId: String): GetApiKeyResult

suspend fun getApiKey(argument: suspend GetApiKeyPlainArgsBuilder.() -> Unit): GetApiKeyResult

getAuthorizer

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

getBasePathMapping

suspend fun getBasePathMapping(argument: GetBasePathMappingPlainArgs): GetBasePathMappingResult

Resource Type definition for AWS::ApiGateway::BasePathMapping

suspend fun getBasePathMapping(argument: suspend GetBasePathMappingPlainArgsBuilder.() -> Unit): GetBasePathMappingResult

suspend fun getBasePathMapping(basePath: String, domainName: String): GetBasePathMappingResult

getClientCertificate

suspend fun getClientCertificate(argument: GetClientCertificatePlainArgs): GetClientCertificateResult

Resource Type definition for AWS::ApiGateway::ClientCertificate

suspend fun getClientCertificate(clientCertificateId: String): GetClientCertificateResult

suspend fun getClientCertificate(argument: suspend GetClientCertificatePlainArgsBuilder.() -> Unit): GetClientCertificateResult

getDeployment

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

getDocumentationPart

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

getDocumentationVersion

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

getDomainName

suspend fun getDomainName(argument: GetDomainNamePlainArgs): GetDomainNameResult

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

suspend fun getDomainName(domainName: String): GetDomainNameResult

suspend fun getDomainName(argument: suspend GetDomainNamePlainArgsBuilder.() -> Unit): GetDomainNameResult

getMethod

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

getModel

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

getRequestValidator

suspend fun getRequestValidator(argument: GetRequestValidatorPlainArgs): GetRequestValidatorResult

Resource Type definition for AWS::ApiGateway::RequestValidator

suspend fun getRequestValidator(argument: suspend GetRequestValidatorPlainArgsBuilder.() -> Unit): GetRequestValidatorResult

suspend fun getRequestValidator(requestValidatorId: String, restApiId: String): GetRequestValidatorResult

getResource

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

getRestApi

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

getStage

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

getUsagePlan

suspend fun getUsagePlan(argument: GetUsagePlanPlainArgs): GetUsagePlanResult

Resource Type definition for AWS::ApiGateway::UsagePlan

suspend fun getUsagePlan(id: String): GetUsagePlanResult

suspend fun getUsagePlan(argument: suspend GetUsagePlanPlainArgsBuilder.() -> Unit): GetUsagePlanResult

getUsagePlanKey

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

getVpcLink

suspend fun getVpcLink(argument: GetVpcLinkPlainArgs): GetVpcLinkResult

Schema for AWS ApiGateway VpcLink

suspend fun getVpcLink(vpcLinkId: String): GetVpcLinkResult

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