Skip to content

Commit

Permalink
feat(client-api-gateway): Added support for custom domain names for p…
Browse files Browse the repository at this point in the history
…rivate APIs.
  • Loading branch information
awstools committed Nov 21, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent fb0e14e commit 47f4d7f
Showing 21 changed files with 1,610 additions and 18 deletions.
32 changes: 32 additions & 0 deletions clients/client-api-gateway/README.md
Original file line number Diff line number Diff line change
@@ -260,6 +260,14 @@ CreateDomainName

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/CreateDomainNameCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/CreateDomainNameCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/CreateDomainNameCommandOutput/)

</details>
<details>
<summary>
CreateDomainNameAccessAssociation
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/CreateDomainNameAccessAssociationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/CreateDomainNameAccessAssociationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/CreateDomainNameAccessAssociationCommandOutput/)

</details>
<details>
<summary>
@@ -388,6 +396,14 @@ DeleteDomainName

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/DeleteDomainNameCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/DeleteDomainNameCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/DeleteDomainNameCommandOutput/)

</details>
<details>
<summary>
DeleteDomainNameAccessAssociation
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/DeleteDomainNameAccessAssociationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/DeleteDomainNameAccessAssociationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/DeleteDomainNameAccessAssociationCommandOutput/)

</details>
<details>
<summary>
@@ -644,6 +660,14 @@ GetDomainName

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/GetDomainNameCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/GetDomainNameCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/GetDomainNameCommandOutput/)

</details>
<details>
<summary>
GetDomainNameAccessAssociations
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/GetDomainNameAccessAssociationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/GetDomainNameAccessAssociationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/GetDomainNameAccessAssociationsCommandOutput/)

</details>
<details>
<summary>
@@ -956,6 +980,14 @@ PutRestApi

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/PutRestApiCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/PutRestApiCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/PutRestApiCommandOutput/)

</details>
<details>
<summary>
RejectDomainNameAccessAssociation
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/api-gateway/command/RejectDomainNameAccessAssociationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/RejectDomainNameAccessAssociationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-api-gateway/Interface/RejectDomainNameAccessAssociationCommandOutput/)

</details>
<details>
<summary>
93 changes: 93 additions & 0 deletions clients/client-api-gateway/src/APIGateway.ts
Original file line number Diff line number Diff line change
@@ -33,6 +33,11 @@ import {
CreateDocumentationVersionCommandInput,
CreateDocumentationVersionCommandOutput,
} from "./commands/CreateDocumentationVersionCommand";
import {
CreateDomainNameAccessAssociationCommand,
CreateDomainNameAccessAssociationCommandInput,
CreateDomainNameAccessAssociationCommandOutput,
} from "./commands/CreateDomainNameAccessAssociationCommand";
import {
CreateDomainNameCommand,
CreateDomainNameCommandInput,
@@ -105,6 +110,11 @@ import {
DeleteDocumentationVersionCommandInput,
DeleteDocumentationVersionCommandOutput,
} from "./commands/DeleteDocumentationVersionCommand";
import {
DeleteDomainNameAccessAssociationCommand,
DeleteDomainNameAccessAssociationCommandInput,
DeleteDomainNameAccessAssociationCommandOutput,
} from "./commands/DeleteDomainNameAccessAssociationCommand";
import {
DeleteDomainNameCommand,
DeleteDomainNameCommandInput,
@@ -245,6 +255,11 @@ import {
GetDocumentationVersionsCommandInput,
GetDocumentationVersionsCommandOutput,
} from "./commands/GetDocumentationVersionsCommand";
import {
GetDomainNameAccessAssociationsCommand,
GetDomainNameAccessAssociationsCommandInput,
GetDomainNameAccessAssociationsCommandOutput,
} from "./commands/GetDomainNameAccessAssociationsCommand";
import {
GetDomainNameCommand,
GetDomainNameCommandInput,
@@ -373,6 +388,11 @@ import {
PutMethodResponseCommandOutput,
} from "./commands/PutMethodResponseCommand";
import { PutRestApiCommand, PutRestApiCommandInput, PutRestApiCommandOutput } from "./commands/PutRestApiCommand";
import {
RejectDomainNameAccessAssociationCommand,
RejectDomainNameAccessAssociationCommandInput,
RejectDomainNameAccessAssociationCommandOutput,
} from "./commands/RejectDomainNameAccessAssociationCommand";
import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
import {
TestInvokeAuthorizerCommand,
@@ -496,6 +516,7 @@ const commands = {
CreateDocumentationPartCommand,
CreateDocumentationVersionCommand,
CreateDomainNameCommand,
CreateDomainNameAccessAssociationCommand,
CreateModelCommand,
CreateRequestValidatorCommand,
CreateResourceCommand,
@@ -512,6 +533,7 @@ const commands = {
DeleteDocumentationPartCommand,
DeleteDocumentationVersionCommand,
DeleteDomainNameCommand,
DeleteDomainNameAccessAssociationCommand,
DeleteGatewayResponseCommand,
DeleteIntegrationCommand,
DeleteIntegrationResponseCommand,
@@ -544,6 +566,7 @@ const commands = {
GetDocumentationVersionCommand,
GetDocumentationVersionsCommand,
GetDomainNameCommand,
GetDomainNameAccessAssociationsCommand,
GetDomainNamesCommand,
GetExportCommand,
GetGatewayResponseCommand,
@@ -583,6 +606,7 @@ const commands = {
PutMethodCommand,
PutMethodResponseCommand,
PutRestApiCommand,
RejectDomainNameAccessAssociationCommand,
TagResourceCommand,
TestInvokeAuthorizerCommand,
TestInvokeMethodCommand,
@@ -726,6 +750,23 @@ export interface APIGateway {
cb: (err: any, data?: CreateDomainNameCommandOutput) => void
): void;

/**
* @see {@link CreateDomainNameAccessAssociationCommand}
*/
createDomainNameAccessAssociation(
args: CreateDomainNameAccessAssociationCommandInput,
options?: __HttpHandlerOptions
): Promise<CreateDomainNameAccessAssociationCommandOutput>;
createDomainNameAccessAssociation(
args: CreateDomainNameAccessAssociationCommandInput,
cb: (err: any, data?: CreateDomainNameAccessAssociationCommandOutput) => void
): void;
createDomainNameAccessAssociation(
args: CreateDomainNameAccessAssociationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: CreateDomainNameAccessAssociationCommandOutput) => void
): void;

/**
* @see {@link CreateModelCommand}
*/
@@ -962,6 +1003,23 @@ export interface APIGateway {
cb: (err: any, data?: DeleteDomainNameCommandOutput) => void
): void;

/**
* @see {@link DeleteDomainNameAccessAssociationCommand}
*/
deleteDomainNameAccessAssociation(
args: DeleteDomainNameAccessAssociationCommandInput,
options?: __HttpHandlerOptions
): Promise<DeleteDomainNameAccessAssociationCommandOutput>;
deleteDomainNameAccessAssociation(
args: DeleteDomainNameAccessAssociationCommandInput,
cb: (err: any, data?: DeleteDomainNameAccessAssociationCommandOutput) => void
): void;
deleteDomainNameAccessAssociation(
args: DeleteDomainNameAccessAssociationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: DeleteDomainNameAccessAssociationCommandOutput) => void
): void;

/**
* @see {@link DeleteGatewayResponseCommand}
*/
@@ -1429,6 +1487,24 @@ export interface APIGateway {
cb: (err: any, data?: GetDomainNameCommandOutput) => void
): void;

/**
* @see {@link GetDomainNameAccessAssociationsCommand}
*/
getDomainNameAccessAssociations(): Promise<GetDomainNameAccessAssociationsCommandOutput>;
getDomainNameAccessAssociations(
args: GetDomainNameAccessAssociationsCommandInput,
options?: __HttpHandlerOptions
): Promise<GetDomainNameAccessAssociationsCommandOutput>;
getDomainNameAccessAssociations(
args: GetDomainNameAccessAssociationsCommandInput,
cb: (err: any, data?: GetDomainNameAccessAssociationsCommandOutput) => void
): void;
getDomainNameAccessAssociations(
args: GetDomainNameAccessAssociationsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetDomainNameAccessAssociationsCommandOutput) => void
): void;

/**
* @see {@link GetDomainNamesCommand}
*/
@@ -1947,6 +2023,23 @@ export interface APIGateway {
cb: (err: any, data?: PutRestApiCommandOutput) => void
): void;

/**
* @see {@link RejectDomainNameAccessAssociationCommand}
*/
rejectDomainNameAccessAssociation(
args: RejectDomainNameAccessAssociationCommandInput,
options?: __HttpHandlerOptions
): Promise<RejectDomainNameAccessAssociationCommandOutput>;
rejectDomainNameAccessAssociation(
args: RejectDomainNameAccessAssociationCommandInput,
cb: (err: any, data?: RejectDomainNameAccessAssociationCommandOutput) => void
): void;
rejectDomainNameAccessAssociation(
args: RejectDomainNameAccessAssociationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: RejectDomainNameAccessAssociationCommandOutput) => void
): void;

/**
* @see {@link TagResourceCommand}
*/
24 changes: 24 additions & 0 deletions clients/client-api-gateway/src/APIGatewayClient.ts
Original file line number Diff line number Diff line change
@@ -69,6 +69,10 @@ import {
CreateDocumentationVersionCommandInput,
CreateDocumentationVersionCommandOutput,
} from "./commands/CreateDocumentationVersionCommand";
import {
CreateDomainNameAccessAssociationCommandInput,
CreateDomainNameAccessAssociationCommandOutput,
} from "./commands/CreateDomainNameAccessAssociationCommand";
import { CreateDomainNameCommandInput, CreateDomainNameCommandOutput } from "./commands/CreateDomainNameCommand";
import { CreateModelCommandInput, CreateModelCommandOutput } from "./commands/CreateModelCommand";
import {
@@ -100,6 +104,10 @@ import {
DeleteDocumentationVersionCommandInput,
DeleteDocumentationVersionCommandOutput,
} from "./commands/DeleteDocumentationVersionCommand";
import {
DeleteDomainNameAccessAssociationCommandInput,
DeleteDomainNameAccessAssociationCommandOutput,
} from "./commands/DeleteDomainNameAccessAssociationCommand";
import { DeleteDomainNameCommandInput, DeleteDomainNameCommandOutput } from "./commands/DeleteDomainNameCommand";
import {
DeleteGatewayResponseCommandInput,
@@ -171,6 +179,10 @@ import {
GetDocumentationVersionsCommandInput,
GetDocumentationVersionsCommandOutput,
} from "./commands/GetDocumentationVersionsCommand";
import {
GetDomainNameAccessAssociationsCommandInput,
GetDomainNameAccessAssociationsCommandOutput,
} from "./commands/GetDomainNameAccessAssociationsCommand";
import { GetDomainNameCommandInput, GetDomainNameCommandOutput } from "./commands/GetDomainNameCommand";
import { GetDomainNamesCommandInput, GetDomainNamesCommandOutput } from "./commands/GetDomainNamesCommand";
import { GetExportCommandInput, GetExportCommandOutput } from "./commands/GetExportCommand";
@@ -229,6 +241,10 @@ import {
import { PutMethodCommandInput, PutMethodCommandOutput } from "./commands/PutMethodCommand";
import { PutMethodResponseCommandInput, PutMethodResponseCommandOutput } from "./commands/PutMethodResponseCommand";
import { PutRestApiCommandInput, PutRestApiCommandOutput } from "./commands/PutRestApiCommand";
import {
RejectDomainNameAccessAssociationCommandInput,
RejectDomainNameAccessAssociationCommandOutput,
} from "./commands/RejectDomainNameAccessAssociationCommand";
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
import {
TestInvokeAuthorizerCommandInput,
@@ -303,6 +319,7 @@ export type ServiceInputTypes =
| CreateDeploymentCommandInput
| CreateDocumentationPartCommandInput
| CreateDocumentationVersionCommandInput
| CreateDomainNameAccessAssociationCommandInput
| CreateDomainNameCommandInput
| CreateModelCommandInput
| CreateRequestValidatorCommandInput
@@ -319,6 +336,7 @@ export type ServiceInputTypes =
| DeleteDeploymentCommandInput
| DeleteDocumentationPartCommandInput
| DeleteDocumentationVersionCommandInput
| DeleteDomainNameAccessAssociationCommandInput
| DeleteDomainNameCommandInput
| DeleteGatewayResponseCommandInput
| DeleteIntegrationCommandInput
@@ -351,6 +369,7 @@ export type ServiceInputTypes =
| GetDocumentationPartsCommandInput
| GetDocumentationVersionCommandInput
| GetDocumentationVersionsCommandInput
| GetDomainNameAccessAssociationsCommandInput
| GetDomainNameCommandInput
| GetDomainNamesCommandInput
| GetExportCommandInput
@@ -391,6 +410,7 @@ export type ServiceInputTypes =
| PutMethodCommandInput
| PutMethodResponseCommandInput
| PutRestApiCommandInput
| RejectDomainNameAccessAssociationCommandInput
| TagResourceCommandInput
| TestInvokeAuthorizerCommandInput
| TestInvokeMethodCommandInput
@@ -428,6 +448,7 @@ export type ServiceOutputTypes =
| CreateDeploymentCommandOutput
| CreateDocumentationPartCommandOutput
| CreateDocumentationVersionCommandOutput
| CreateDomainNameAccessAssociationCommandOutput
| CreateDomainNameCommandOutput
| CreateModelCommandOutput
| CreateRequestValidatorCommandOutput
@@ -444,6 +465,7 @@ export type ServiceOutputTypes =
| DeleteDeploymentCommandOutput
| DeleteDocumentationPartCommandOutput
| DeleteDocumentationVersionCommandOutput
| DeleteDomainNameAccessAssociationCommandOutput
| DeleteDomainNameCommandOutput
| DeleteGatewayResponseCommandOutput
| DeleteIntegrationCommandOutput
@@ -476,6 +498,7 @@ export type ServiceOutputTypes =
| GetDocumentationPartsCommandOutput
| GetDocumentationVersionCommandOutput
| GetDocumentationVersionsCommandOutput
| GetDomainNameAccessAssociationsCommandOutput
| GetDomainNameCommandOutput
| GetDomainNamesCommandOutput
| GetExportCommandOutput
@@ -516,6 +539,7 @@ export type ServiceOutputTypes =
| PutMethodCommandOutput
| PutMethodResponseCommandOutput
| PutRestApiCommandOutput
| RejectDomainNameAccessAssociationCommandOutput
| TagResourceCommandOutput
| TestInvokeAuthorizerCommandOutput
| TestInvokeMethodCommandOutput
Original file line number Diff line number Diff line change
@@ -37,6 +37,7 @@ export interface CreateBasePathMappingCommandOutput extends BasePathMapping, __M
* const client = new APIGatewayClient(config);
* const input = { // CreateBasePathMappingRequest
* domainName: "STRING_VALUE", // required
* domainNameId: "STRING_VALUE",
* basePath: "STRING_VALUE",
* restApiId: "STRING_VALUE", // required
* stage: "STRING_VALUE",
Loading

0 comments on commit 47f4d7f

Please sign in to comment.