Skip to content

Commit fa3d7b9

Browse files
author
awstools
committed
feat(client-api-gateway): Adds support to set the routing mode for a custom domain name.
1 parent 9babfac commit fa3d7b9

File tree

7 files changed

+74
-0
lines changed

7 files changed

+74
-0
lines changed

clients/client-api-gateway/src/commands/CreateDomainNameCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
6363
* },
6464
* ownershipVerificationCertificateArn: "STRING_VALUE",
6565
* policy: "STRING_VALUE",
66+
* routingMode: "BASE_PATH_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
6667
* };
6768
* const command = new CreateDomainNameCommand(input);
6869
* const response = await client.send(command);
@@ -104,6 +105,7 @@ export interface CreateDomainNameCommandOutput extends DomainName, __MetadataBea
104105
* // ownershipVerificationCertificateArn: "STRING_VALUE",
105106
* // managementPolicy: "STRING_VALUE",
106107
* // policy: "STRING_VALUE",
108+
* // routingMode: "BASE_PATH_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
107109
* // };
108110
*
109111
* ```

clients/client-api-gateway/src/commands/GetDomainNameCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ export interface GetDomainNameCommandOutput extends DomainName, __MetadataBearer
7979
* // ownershipVerificationCertificateArn: "STRING_VALUE",
8080
* // managementPolicy: "STRING_VALUE",
8181
* // policy: "STRING_VALUE",
82+
* // routingMode: "BASE_PATH_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
8283
* // };
8384
*
8485
* ```

clients/client-api-gateway/src/commands/GetDomainNamesCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ export interface GetDomainNamesCommandOutput extends DomainNames, __MetadataBear
8282
* // ownershipVerificationCertificateArn: "STRING_VALUE",
8383
* // managementPolicy: "STRING_VALUE",
8484
* // policy: "STRING_VALUE",
85+
* // routingMode: "BASE_PATH_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
8586
* // },
8687
* // ],
8788
* // position: "STRING_VALUE",

clients/client-api-gateway/src/commands/UpdateDomainNameCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ export interface UpdateDomainNameCommandOutput extends DomainName, __MetadataBea
8787
* // ownershipVerificationCertificateArn: "STRING_VALUE",
8888
* // managementPolicy: "STRING_VALUE",
8989
* // policy: "STRING_VALUE",
90+
* // routingMode: "BASE_PATH_MAPPING_ONLY" || "ROUTING_RULE_ONLY" || "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
9091
* // };
9192
*
9293
* ```

clients/client-api-gateway/src/models/models_0.ts

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,6 +1110,21 @@ export interface MutualTlsAuthenticationInput {
11101110
truststoreVersion?: string | undefined;
11111111
}
11121112

1113+
/**
1114+
* @public
1115+
* @enum
1116+
*/
1117+
export const RoutingMode = {
1118+
BASE_PATH_MAPPING_ONLY: "BASE_PATH_MAPPING_ONLY",
1119+
ROUTING_RULE_ONLY: "ROUTING_RULE_ONLY",
1120+
ROUTING_RULE_THEN_BASE_PATH_MAPPING: "ROUTING_RULE_THEN_BASE_PATH_MAPPING",
1121+
} as const;
1122+
1123+
/**
1124+
* @public
1125+
*/
1126+
export type RoutingMode = (typeof RoutingMode)[keyof typeof RoutingMode];
1127+
11131128
/**
11141129
* @public
11151130
* @enum
@@ -1218,6 +1233,14 @@ export interface CreateDomainNameRequest {
12181233
* @public
12191234
*/
12201235
policy?: string | undefined;
1236+
1237+
/**
1238+
* <p>
1239+
* The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
1240+
* </p>
1241+
* @public
1242+
*/
1243+
routingMode?: RoutingMode | undefined;
12211244
}
12221245

12231246
/**
@@ -1407,6 +1430,12 @@ export interface DomainName {
14071430
* @public
14081431
*/
14091432
policy?: string | undefined;
1433+
1434+
/**
1435+
* <p>The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.</p>
1436+
* @public
1437+
*/
1438+
routingMode?: RoutingMode | undefined;
14101439
}
14111440

14121441
/**

clients/client-api-gateway/src/protocols/Aws_restJson1.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -500,6 +500,7 @@ export const se_CreateDomainNameCommand = async (
500500
policy: [],
501501
regionalCertificateArn: [],
502502
regionalCertificateName: [],
503+
routingMode: [],
503504
securityPolicy: [],
504505
tags: (_) => _json(_),
505506
})
@@ -3172,6 +3173,7 @@ export const de_CreateDomainNameCommand = async (
31723173
regionalCertificateName: __expectString,
31733174
regionalDomainName: __expectString,
31743175
regionalHostedZoneId: __expectString,
3176+
routingMode: __expectString,
31753177
securityPolicy: __expectString,
31763178
tags: _json,
31773179
});
@@ -4254,6 +4256,7 @@ export const de_GetDomainNameCommand = async (
42544256
regionalCertificateName: __expectString,
42554257
regionalDomainName: __expectString,
42564258
regionalHostedZoneId: __expectString,
4259+
routingMode: __expectString,
42574260
securityPolicy: __expectString,
42584261
tags: _json,
42594262
});
@@ -5609,6 +5612,7 @@ export const de_UpdateDomainNameCommand = async (
56095612
regionalCertificateName: __expectString,
56105613
regionalDomainName: __expectString,
56115614
regionalHostedZoneId: __expectString,
5615+
routingMode: __expectString,
56125616
securityPolicy: __expectString,
56135617
tags: _json,
56145618
});
@@ -6369,6 +6373,7 @@ const de_DomainName = (output: any, context: __SerdeContext): DomainName => {
63696373
regionalCertificateName: __expectString,
63706374
regionalDomainName: __expectString,
63716375
regionalHostedZoneId: __expectString,
6376+
routingMode: __expectString,
63726377
securityPolicy: __expectString,
63736378
tags: _json,
63746379
}) as any;

codegen/sdk-codegen/aws-models/api-gateway.json

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2717,6 +2717,12 @@
27172717
"traits": {
27182718
"smithy.api#documentation": "<p>A stringified JSON policy document that applies to the <code>execute-api</code> service for this DomainName regardless of the caller and Method\n configuration. Supported only for private custom\n domain names.</p>"
27192719
}
2720+
},
2721+
"routingMode": {
2722+
"target": "com.amazonaws.apigateway#RoutingMode",
2723+
"traits": {
2724+
"smithy.api#documentation": "<p>\nThe routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.\n</p>"
2725+
}
27202726
}
27212727
},
27222728
"traits": {
@@ -5150,6 +5156,12 @@
51505156
"traits": {
51515157
"smithy.api#documentation": "<p>A stringified JSON policy document that applies to the <code>execute-api</code> service for this DomainName regardless of the caller and Method\n configuration. Supported only for private custom\n domain names.</p>"
51525158
}
5159+
},
5160+
"routingMode": {
5161+
"target": "com.amazonaws.apigateway#RoutingMode",
5162+
"traits": {
5163+
"smithy.api#documentation": "<p>The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.</p>"
5164+
}
51535165
}
51545166
},
51555167
"traits": {
@@ -10815,6 +10827,29 @@
1081510827
"smithy.api#documentation": "<p>Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.</p>"
1081610828
}
1081710829
},
10830+
"com.amazonaws.apigateway#RoutingMode": {
10831+
"type": "enum",
10832+
"members": {
10833+
"BASE_PATH_MAPPING_ONLY": {
10834+
"target": "smithy.api#Unit",
10835+
"traits": {
10836+
"smithy.api#enumValue": "BASE_PATH_MAPPING_ONLY"
10837+
}
10838+
},
10839+
"ROUTING_RULE_ONLY": {
10840+
"target": "smithy.api#Unit",
10841+
"traits": {
10842+
"smithy.api#enumValue": "ROUTING_RULE_ONLY"
10843+
}
10844+
},
10845+
"ROUTING_RULE_THEN_BASE_PATH_MAPPING": {
10846+
"target": "smithy.api#Unit",
10847+
"traits": {
10848+
"smithy.api#enumValue": "ROUTING_RULE_THEN_BASE_PATH_MAPPING"
10849+
}
10850+
}
10851+
}
10852+
},
1081810853
"com.amazonaws.apigateway#SdkConfigurationProperty": {
1081910854
"type": "structure",
1082010855
"members": {

0 commit comments

Comments
 (0)