apigateway
library
Classes
Account
Provides a settings of an API Gateway Account. Settings is applied region-wide per provider block.
AccountArgs
The set of arguments for Account.
The set of arguments for Account.
AccountState
Input properties used for looking up and filtering Account resources.
AccountThrottleSetting
ApiKey
Provides an API Gateway API Key.
ApiKeyArgs
The set of arguments for ApiKey.
The set of arguments for ApiKey.
ApiKeyState
Input properties used for looking up and filtering ApiKey resources.
Authorizer
Provides an API Gateway Authorizer.
AuthorizerArgs
The set of arguments for Authorizer.
The set of arguments for Authorizer.
AuthorizerState
Input properties used for looking up and filtering Authorizer resources.
BasePathMapping
Connects a custom domain name registered via aws.apigateway.DomainName
with a deployed API so that its methods can be called via the
custom domain name.
BasePathMappingArgs
The set of arguments for BasePathMapping.
The set of arguments for BasePathMapping.
BasePathMappingState
Input properties used for looking up and filtering BasePathMapping resources.
ClientCertificate
Provides an API Gateway Client Certificate.
ClientCertificateArgs
The set of arguments for ClientCertificate.
The set of arguments for ClientCertificate.
ClientCertificateState
Input properties used for looking up and filtering ClientCertificate resources.
DeploymentArgs
The set of arguments for Deployment.
The set of arguments for Deployment.
DeploymentState
Input properties used for looking up and filtering Deployment resources.
DeploymentType
Manages an API Gateway REST Deployment. A deployment is a snapshot of the REST API configuration. The deployment can then be published to callable endpoints via the aws.apigateway.Stage resource and optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws.apigateway.MethodSettings resource. For more information, see the API Gateway Developer Guide .
DocumentationPart
Provides a settings of an API Gateway Documentation Part.
DocumentationPartArgs
The set of arguments for DocumentationPart.
The set of arguments for DocumentationPart.
DocumentationPartLocation
DocumentationPartState
Input properties used for looking up and filtering DocumentationPart resources.
DocumentationVersion
Provides a resource to manage an API Gateway Documentation Version.
DocumentationVersionArgs
The set of arguments for DocumentationVersion.
The set of arguments for DocumentationVersion.
DocumentationVersionState
Input properties used for looking up and filtering DocumentationVersion resources.
DomainName
Registers a custom domain name for use with AWS API Gateway. Additional information about this functionality
can be found in the API Gateway Developer Guide .
DomainNameAccessAssociation
Creates a domain name access association resource between an access association source and a private custom domain name.
DomainNameAccessAssociationArgs
The set of arguments for DomainNameAccessAssociation.
The set of arguments for DomainNameAccessAssociation.
DomainNameAccessAssociationState
Input properties used for looking up and filtering DomainNameAccessAssociation resources.
DomainNameArgs
The set of arguments for DomainName.
The set of arguments for DomainName.
DomainNameEndpointConfiguration
DomainNameMutualTlsAuthentication
DomainNameState
Input properties used for looking up and filtering DomainName resources.
GetApiKeysArgs
Arguments for getApiKeys.
Arguments for getApiKeys.
GetApiKeysItem
GetApiKeysResult
Result data returned by getApiKeys.
GetAuthorizerArgs
Arguments for getAuthorizer.
Arguments for getAuthorizer.
GetAuthorizerResult
Result data returned by getAuthorizer.
GetAuthorizersArgs
Arguments for getAuthorizers.
Arguments for getAuthorizers.
GetAuthorizersResult
Result data returned by getAuthorizers.
GetDomainNameArgs
Arguments for getDomainName.
Arguments for getDomainName.
GetDomainNameEndpointConfiguration
GetDomainNameResult
Result data returned by getDomainName.
GetExportArgs
Arguments for getExport.
Arguments for getExport.
GetExportResult
Result data returned by getExport.
GetKeyArgs
Arguments for getKey.
Arguments for getKey.
GetKeyResult
Result data returned by getKey.
GetResourceArgs
Arguments for getResource.
Arguments for getResource.
GetResourceResult
Result data returned by getResource.
GetRestApiArgs
Arguments for getRestApi.
Arguments for getRestApi.
GetRestApiEndpointConfiguration
GetRestApiResult
Result data returned by getRestApi.
GetSdkArgs
Arguments for getSdk.
Arguments for getSdk.
GetSdkResult
Result data returned by getSdk.
GetVpcLinkArgs
Arguments for getVpcLink.
Arguments for getVpcLink.
GetVpcLinkResult
Result data returned by getVpcLink.
Integration
Provides an HTTP Method Integration for an API Gateway Integration.
IntegrationArgs
The set of arguments for Integration.
The set of arguments for Integration.
IntegrationResponse
Provides an HTTP Method Integration Response for an API Gateway Resource.
IntegrationResponseArgs
The set of arguments for IntegrationResponse.
The set of arguments for IntegrationResponse.
IntegrationResponseState
Input properties used for looking up and filtering IntegrationResponse resources.
IntegrationState
Input properties used for looking up and filtering Integration resources.
IntegrationTlsConfig
Method
Provides a HTTP Method for an API Gateway Resource.
MethodArgs
The set of arguments for Method.
The set of arguments for Method.
MethodResponse
Provides an HTTP Method Response for an API Gateway Resource. More information about API Gateway method responses can be found in the Amazon API Gateway Developer Guide .
MethodResponseArgs
The set of arguments for MethodResponse.
The set of arguments for MethodResponse.
MethodResponseState
Input properties used for looking up and filtering MethodResponse resources.
MethodSettings
Manages API Gateway Stage Method Settings. For example, CloudWatch logging and metrics.
MethodSettingsArgs
The set of arguments for MethodSettings.
The set of arguments for MethodSettings.
MethodSettingsSettings
MethodSettingsState
Input properties used for looking up and filtering MethodSettings resources.
MethodState
Input properties used for looking up and filtering Method resources.
Model
Provides a Model for a REST API Gateway.
ModelArgs
The set of arguments for Model.
The set of arguments for Model.
ModelState
Input properties used for looking up and filtering Model resources.
RequestValidator
Manages an API Gateway Request Validator.
RequestValidatorArgs
The set of arguments for RequestValidator.
The set of arguments for RequestValidator.
RequestValidatorState
Input properties used for looking up and filtering RequestValidator resources.
ResourceArgs
The set of arguments for Resource.
The set of arguments for Resource.
ResourceState
Input properties used for looking up and filtering Resource resources.
ResourceType
Provides an API Gateway Resource.
Response
Provides an API Gateway Gateway Response for a REST API Gateway.
ResponseArgs
The set of arguments for Response.
The set of arguments for Response.
ResponseState
Input properties used for looking up and filtering Response resources.
RestApi
Manages an API Gateway REST API. The REST API can be configured via importing an OpenAPI specification in the body argument (with other arguments serving as overrides) or via other provider resources to manage the resources (aws.apigateway.Resource resource), methods (aws.apigateway.Method resource), integrations (aws.apigateway.Integration resource), etc. of the REST API. Once the REST API is configured, the aws.apigateway.Deployment resource can be used along with the aws.apigateway.Stage resource to publish the REST API.
RestApiArgs
The set of arguments for RestApi.
The set of arguments for RestApi.
RestApiEndpointConfiguration
RestApiPolicy
Provides an API Gateway REST API Policy.
RestApiPolicyArgs
The set of arguments for RestApiPolicy.
The set of arguments for RestApiPolicy.
RestApiPolicyState
Input properties used for looking up and filtering RestApiPolicy resources.
RestApiPut
Resource for updating an AWS API Gateway REST API with a new API description.
RestApiPutArgs
The set of arguments for RestApiPut.
The set of arguments for RestApiPut.
RestApiPutState
Input properties used for looking up and filtering RestApiPut resources.
RestApiPutTimeouts
RestApiState
Input properties used for looking up and filtering RestApi resources.
Stage
Manages an API Gateway Stage. A stage is a named reference to a deployment, which can be done via the aws.apigateway.Deployment resource. Stages can be optionally managed further with the aws.apigateway.BasePathMapping resource, aws.apigateway.DomainName resource, and aws.apigateway.MethodSettings resource. For more information, see the API Gateway Developer Guide .
StageAccessLogSettings
StageArgs
The set of arguments for Stage.
The set of arguments for Stage.
StageCanarySettings
StageState
Input properties used for looking up and filtering Stage resources.
UsagePlan
Provides an API Gateway Usage Plan.
UsagePlanApiStage
UsagePlanApiStageThrottle
UsagePlanArgs
The set of arguments for UsagePlan.
The set of arguments for UsagePlan.
UsagePlanKey
Provides an API Gateway Usage Plan Key.
UsagePlanKeyArgs
The set of arguments for UsagePlanKey.
The set of arguments for UsagePlanKey.
UsagePlanKeyState
Input properties used for looking up and filtering UsagePlanKey resources.
UsagePlanQuotaSettings
UsagePlanState
Input properties used for looking up and filtering UsagePlan resources.
UsagePlanThrottleSettings
VpcLink
Provides an API Gateway VPC Link.
VpcLinkArgs
The set of arguments for VpcLink.
The set of arguments for VpcLink.
VpcLinkState
Input properties used for looking up and filtering VpcLink resources.
Functions
getApiKeys (GetApiKeysArgs args , {InvokeOptions? options })
→ Future <GetApiKeysResult >
Data source for managing AWS API Gateway API Keys.
getApiKeysOutput (GetApiKeysArgs args , {InvokeOutputOptions? options })
→ Output<GetApiKeysResult >
getAuthorizer (GetAuthorizerArgs args , {InvokeOptions? options })
→ Future <GetAuthorizerResult >
Provides details about a specific API Gateway Authorizer.
getAuthorizerOutput (GetAuthorizerArgs args , {InvokeOutputOptions? options })
→ Output<GetAuthorizerResult >
getAuthorizers (GetAuthorizersArgs args , {InvokeOptions? options })
→ Future <GetAuthorizersResult >
Provides details about multiple API Gateway Authorizers.
getAuthorizersOutput (GetAuthorizersArgs args , {InvokeOutputOptions? options })
→ Output<GetAuthorizersResult >
getDomainName (GetDomainNameArgs args , {InvokeOptions? options })
→ Future <GetDomainNameResult >
Use this data source to get the custom domain name for use with AWS API Gateway.
getDomainNameOutput (GetDomainNameArgs args , {InvokeOutputOptions? options })
→ Output<GetDomainNameResult >
getExport (GetExportArgs args , {InvokeOptions? options })
→ Future <GetExportResult >
Example Usage
getExportOutput (GetExportArgs args , {InvokeOutputOptions? options })
→ Output<GetExportResult >
getKey (GetKeyArgs args , {InvokeOptions? options })
→ Future <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.
getKeyOutput (GetKeyArgs args , {InvokeOutputOptions? options })
→ Output<GetKeyResult >
getResource (GetResourceArgs args , {InvokeOptions? options })
→ Future <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.
getResourceOutput (GetResourceArgs args , {InvokeOutputOptions? options })
→ Output<GetResourceResult >
getRestApi (GetRestApiArgs args , {InvokeOptions? options })
→ Future <GetRestApiResult >
Use this data source to get the id and rootResourceId 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.
getRestApiOutput (GetRestApiArgs args , {InvokeOutputOptions? options })
→ Output<GetRestApiResult >
getSdk (GetSdkArgs args , {InvokeOptions? options })
→ Future <GetSdkResult >
Example Usage
getSdkOutput (GetSdkArgs args , {InvokeOutputOptions? options })
→ Output<GetSdkResult >
getVpcLink (GetVpcLinkArgs args , {InvokeOptions? options })
→ Future <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.
getVpcLinkOutput (GetVpcLinkArgs args , {InvokeOutputOptions? options })
→ Output<GetVpcLinkResult >