@aws-sdk/client-apprunner 3.418.0 → 3.421.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist-types/commands/CreateServiceCommand.d.ts +2 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +1 -0
- package/dist-types/commands/DescribeServiceCommand.d.ts +1 -0
- package/dist-types/commands/PauseServiceCommand.d.ts +1 -0
- package/dist-types/commands/ResumeServiceCommand.d.ts +1 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +33 -30
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -40,16 +40,16 @@ using your favorite package manager:
|
|
|
40
40
|
|
|
41
41
|
The AWS SDK is modulized by clients and commands.
|
|
42
42
|
To send a request, you only need to import the `AppRunnerClient` and
|
|
43
|
-
the commands you need, for example `
|
|
43
|
+
the commands you need, for example `ListConnectionsCommand`:
|
|
44
44
|
|
|
45
45
|
```js
|
|
46
46
|
// ES5 example
|
|
47
|
-
const { AppRunnerClient,
|
|
47
|
+
const { AppRunnerClient, ListConnectionsCommand } = require("@aws-sdk/client-apprunner");
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
```ts
|
|
51
51
|
// ES6+ example
|
|
52
|
-
import { AppRunnerClient,
|
|
52
|
+
import { AppRunnerClient, ListConnectionsCommand } from "@aws-sdk/client-apprunner";
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
### Usage
|
|
@@ -68,7 +68,7 @@ const client = new AppRunnerClient({ region: "REGION" });
|
|
|
68
68
|
const params = {
|
|
69
69
|
/** input parameters */
|
|
70
70
|
};
|
|
71
|
-
const command = new
|
|
71
|
+
const command = new ListConnectionsCommand(params);
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
#### Async/await
|
|
@@ -147,7 +147,7 @@ const client = new AWS.AppRunner({ region: "REGION" });
|
|
|
147
147
|
|
|
148
148
|
// async/await.
|
|
149
149
|
try {
|
|
150
|
-
const data = await client.
|
|
150
|
+
const data = await client.listConnections(params);
|
|
151
151
|
// process data.
|
|
152
152
|
} catch (error) {
|
|
153
153
|
// error handling.
|
|
@@ -155,7 +155,7 @@ try {
|
|
|
155
155
|
|
|
156
156
|
// Promises.
|
|
157
157
|
client
|
|
158
|
-
.
|
|
158
|
+
.listConnections(params)
|
|
159
159
|
.then((data) => {
|
|
160
160
|
// process data.
|
|
161
161
|
})
|
|
@@ -164,7 +164,7 @@ client
|
|
|
164
164
|
});
|
|
165
165
|
|
|
166
166
|
// callbacks.
|
|
167
|
-
client.
|
|
167
|
+
client.listConnections(params, (err, data) => {
|
|
168
168
|
// process err and data.
|
|
169
169
|
});
|
|
170
170
|
```
|
|
@@ -55,6 +55,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
55
55
|
* },
|
|
56
56
|
* },
|
|
57
57
|
* },
|
|
58
|
+
* SourceDirectory: "STRING_VALUE",
|
|
58
59
|
* },
|
|
59
60
|
* ImageRepository: { // ImageRepository
|
|
60
61
|
* ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -147,6 +148,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
147
148
|
* // },
|
|
148
149
|
* // },
|
|
149
150
|
* // },
|
|
151
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
150
152
|
* // },
|
|
151
153
|
* // ImageRepository: { // ImageRepository
|
|
152
154
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -73,6 +73,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
|
|
|
73
73
|
* // },
|
|
74
74
|
* // },
|
|
75
75
|
* // },
|
|
76
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
76
77
|
* // },
|
|
77
78
|
* // ImageRepository: { // ImageRepository
|
|
78
79
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -67,6 +67,7 @@ export interface DescribeServiceCommandOutput extends DescribeServiceResponse, _
|
|
|
67
67
|
* // },
|
|
68
68
|
* // },
|
|
69
69
|
* // },
|
|
70
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
70
71
|
* // },
|
|
71
72
|
* // ImageRepository: { // ImageRepository
|
|
72
73
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -70,6 +70,7 @@ export interface PauseServiceCommandOutput extends PauseServiceResponse, __Metad
|
|
|
70
70
|
* // },
|
|
71
71
|
* // },
|
|
72
72
|
* // },
|
|
73
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
73
74
|
* // },
|
|
74
75
|
* // ImageRepository: { // ImageRepository
|
|
75
76
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -69,6 +69,7 @@ export interface ResumeServiceCommandOutput extends ResumeServiceResponse, __Met
|
|
|
69
69
|
* // },
|
|
70
70
|
* // },
|
|
71
71
|
* // },
|
|
72
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
72
73
|
* // },
|
|
73
74
|
* // ImageRepository: { // ImageRepository
|
|
74
75
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -59,6 +59,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
59
59
|
* },
|
|
60
60
|
* },
|
|
61
61
|
* },
|
|
62
|
+
* SourceDirectory: "STRING_VALUE",
|
|
62
63
|
* },
|
|
63
64
|
* ImageRepository: { // ImageRepository
|
|
64
65
|
* ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -142,6 +143,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
142
143
|
* // },
|
|
143
144
|
* // },
|
|
144
145
|
* // },
|
|
146
|
+
* // SourceDirectory: "STRING_VALUE",
|
|
145
147
|
* // },
|
|
146
148
|
* // ImageRepository: { // ImageRepository
|
|
147
149
|
* // ImageIdentifier: "STRING_VALUE", // required
|
|
@@ -222,8 +222,8 @@ export interface CreateAutoScalingConfigurationRequest {
|
|
|
222
222
|
* <p>A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number
|
|
223
223
|
* <code>1</code> of this name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.</p>
|
|
224
224
|
* <note>
|
|
225
|
-
* <p>Prior to the release of <a href="https://docs.aws.amazon.com/apprunner/latest/relnotes/release-
|
|
226
|
-
*
|
|
225
|
+
* <p>Prior to the release of <a href="https://docs.aws.amazon.com/apprunner/latest/relnotes/release-2023-09-22-auto-scale-config.html">Auto scale
|
|
226
|
+
* configuration enhancements</a>, the name <code>DefaultConfiguration</code> was reserved. </p>
|
|
227
227
|
* <p>This restriction is no longer in place. You can now manage <code>DefaultConfiguration</code> the same way you manage your custom auto scaling
|
|
228
228
|
* configurations. This means you can do the following with the <code>DefaultConfiguration</code> that App Runner provides:</p>
|
|
229
229
|
* <ul>
|
|
@@ -783,7 +783,7 @@ export interface ServiceObservabilityConfiguration {
|
|
|
783
783
|
* <p>The Amazon Resource Name (ARN) of the observability configuration that is associated with the service. Specified only when
|
|
784
784
|
* <code>ObservabilityEnabled</code> is <code>true</code>.</p>
|
|
785
785
|
* <p>Specify an ARN with a name and a revision number to associate that revision. For example:
|
|
786
|
-
*
|
|
786
|
+
* <code>arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/3</code>
|
|
787
787
|
* </p>
|
|
788
788
|
* <p>Specify just the name to associate the latest revision. For example:
|
|
789
789
|
* <code>arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing</code>
|
|
@@ -844,12 +844,14 @@ export interface CodeConfigurationValues {
|
|
|
844
844
|
Runtime: Runtime | string | undefined;
|
|
845
845
|
/**
|
|
846
846
|
* @public
|
|
847
|
-
* <p>The command App Runner runs to build your
|
|
847
|
+
* <p>The command App Runner runs to build your
|
|
848
|
+
* application.</p>
|
|
848
849
|
*/
|
|
849
850
|
BuildCommand?: string;
|
|
850
851
|
/**
|
|
851
852
|
* @public
|
|
852
|
-
* <p>The command App Runner runs to start your
|
|
853
|
+
* <p>The command App Runner runs to start your
|
|
854
|
+
* application.</p>
|
|
853
855
|
*/
|
|
854
856
|
StartCommand?: string;
|
|
855
857
|
/**
|
|
@@ -866,20 +868,17 @@ export interface CodeConfigurationValues {
|
|
|
866
868
|
RuntimeEnvironmentVariables?: Record<string, string>;
|
|
867
869
|
/**
|
|
868
870
|
* @public
|
|
869
|
-
* <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
|
|
870
|
-
*
|
|
871
|
+
* <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported
|
|
872
|
+
* values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager
|
|
873
|
+
* Parameter Store.</p>
|
|
871
874
|
* <note>
|
|
872
875
|
* <ul>
|
|
873
876
|
* <li>
|
|
874
|
-
* <p>
|
|
875
|
-
*
|
|
876
|
-
* you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
|
|
877
|
-
* </p>
|
|
877
|
+
* <p> If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use
|
|
878
|
+
* either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified. </p>
|
|
878
879
|
* </li>
|
|
879
880
|
* <li>
|
|
880
|
-
* <p>
|
|
881
|
-
* Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
|
|
882
|
-
* </p>
|
|
881
|
+
* <p> Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported. </p>
|
|
883
882
|
* </li>
|
|
884
883
|
* </ul>
|
|
885
884
|
* </note>
|
|
@@ -980,6 +979,12 @@ export interface CodeRepository {
|
|
|
980
979
|
* </note>
|
|
981
980
|
*/
|
|
982
981
|
CodeConfiguration?: CodeConfiguration;
|
|
982
|
+
/**
|
|
983
|
+
* @public
|
|
984
|
+
* <p>The path of the directory that stores source code and configuration files. The build and start commands also execute from here. The path is absolute
|
|
985
|
+
* from root and, if not specified, defaults to the repository root.</p>
|
|
986
|
+
*/
|
|
987
|
+
SourceDirectory?: string;
|
|
983
988
|
}
|
|
984
989
|
/**
|
|
985
990
|
* @public
|
|
@@ -1006,20 +1011,17 @@ export interface ImageConfiguration {
|
|
|
1006
1011
|
Port?: string;
|
|
1007
1012
|
/**
|
|
1008
1013
|
* @public
|
|
1009
|
-
* <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable.
|
|
1010
|
-
*
|
|
1014
|
+
* <p>An array of key-value pairs representing the secrets and parameters that get referenced to your service as an environment variable. The supported
|
|
1015
|
+
* values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager
|
|
1016
|
+
* Parameter Store.</p>
|
|
1011
1017
|
* <note>
|
|
1012
1018
|
* <ul>
|
|
1013
1019
|
* <li>
|
|
1014
|
-
* <p>
|
|
1015
|
-
*
|
|
1016
|
-
* you can use either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified.
|
|
1017
|
-
* </p>
|
|
1020
|
+
* <p> If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Amazon Web Services Region as the service that you're launching, you can use
|
|
1021
|
+
* either the full ARN or name of the secret. If the parameter exists in a different Region, then the full ARN must be specified. </p>
|
|
1018
1022
|
* </li>
|
|
1019
1023
|
* <li>
|
|
1020
|
-
* <p>
|
|
1021
|
-
* Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported.
|
|
1022
|
-
* </p>
|
|
1024
|
+
* <p> Currently, cross account referencing of Amazon Web Services Systems Manager Parameter Store parameter is not supported. </p>
|
|
1023
1025
|
* </li>
|
|
1024
1026
|
* </ul>
|
|
1025
1027
|
* </note>
|
|
@@ -1067,7 +1069,8 @@ export interface ImageRepository {
|
|
|
1067
1069
|
export interface SourceConfiguration {
|
|
1068
1070
|
/**
|
|
1069
1071
|
* @public
|
|
1070
|
-
* <p>The description of a source code
|
|
1072
|
+
* <p>The description of a source code
|
|
1073
|
+
* repository.</p>
|
|
1071
1074
|
* <p>You must provide either this member or <code>ImageRepository</code> (but not both).</p>
|
|
1072
1075
|
*/
|
|
1073
1076
|
CodeRepository?: CodeRepository;
|
|
@@ -1264,9 +1267,9 @@ export interface Service {
|
|
|
1264
1267
|
* <ul>
|
|
1265
1268
|
* <li>
|
|
1266
1269
|
* <p>
|
|
1267
|
-
* <code>CREATE_FAILED</code> – The service failed to create. The failed service isn't usable, and still counts towards your service quota.
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1270
|
+
* <code>CREATE_FAILED</code> – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To
|
|
1271
|
+
* troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using
|
|
1272
|
+
* <code>UpdateService</code>.</p>
|
|
1270
1273
|
* </li>
|
|
1271
1274
|
* <li>
|
|
1272
1275
|
* <p>
|
|
@@ -2318,9 +2321,9 @@ export interface ServiceSummary {
|
|
|
2318
2321
|
* <ul>
|
|
2319
2322
|
* <li>
|
|
2320
2323
|
* <p>
|
|
2321
|
-
* <code>CREATE_FAILED</code> – The service failed to create. The failed service isn't usable, and still counts towards your service quota.
|
|
2322
|
-
*
|
|
2323
|
-
*
|
|
2324
|
+
* <code>CREATE_FAILED</code> – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To
|
|
2325
|
+
* troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using
|
|
2326
|
+
* <code>UpdateService</code>.</p>
|
|
2324
2327
|
* </li>
|
|
2325
2328
|
* <li>
|
|
2326
2329
|
* <p>
|
|
@@ -261,6 +261,7 @@ export interface CodeRepository {
|
|
|
261
261
|
RepositoryUrl: string | undefined;
|
|
262
262
|
SourceCodeVersion: SourceCodeVersion | undefined;
|
|
263
263
|
CodeConfiguration?: CodeConfiguration;
|
|
264
|
+
SourceDirectory?: string;
|
|
264
265
|
}
|
|
265
266
|
export interface ImageConfiguration {
|
|
266
267
|
RuntimeEnvironmentVariables?: Record<string, string>;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-apprunner",
|
|
3
3
|
"description": "AWS SDK for JavaScript Apprunner Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.421.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.421.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.421.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.418.0",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.418.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.418.0",
|