@awboost/cfn-resource-types 0.1.183 → 0.1.185
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/lib/AWS-ApiGateway-Account.d.ts +0 -3
- package/lib/AWS-ApiGateway-ApiKey.d.ts +0 -27
- package/lib/AWS-ApiGateway-Authorizer.d.ts +0 -30
- package/lib/AWS-ApiGateway-BasePathMapping.d.ts +0 -12
- package/lib/AWS-ApiGateway-ClientCertificate.d.ts +0 -6
- package/lib/AWS-ApiGateway-Deployment.d.ts +1 -61
- package/lib/AWS-ApiGateway-DocumentationPart.d.ts +3 -23
- package/lib/AWS-ApiGateway-DocumentationVersion.d.ts +0 -5
- package/lib/AWS-ApiGateway-GatewayResponse.d.ts +0 -15
- package/lib/AWS-ApiGateway-Method.d.ts +1 -103
- package/lib/AWS-ApiGateway-Model.d.ts +0 -12
- package/lib/AWS-ApiGateway-RequestValidator.d.ts +0 -12
- package/lib/AWS-ApiGateway-Resource.d.ts +0 -9
- package/lib/AWS-ApiGateway-RestApi.d.ts +0 -33
- package/lib/AWS-ApiGateway-Stage.d.ts +3 -69
- package/lib/AWS-ApiGateway-UsagePlan.d.ts +4 -32
- package/lib/AWS-ApiGateway-UsagePlanKey.d.ts +0 -3
- package/lib/AWS-NimbleStudio-LaunchProfile.d.ts +9 -186
- package/lib/AWS-NimbleStudio-LaunchProfile.js +1 -2
- package/lib/AWS-NimbleStudio-StreamingImage.d.ts +6 -72
- package/lib/AWS-NimbleStudio-StreamingImage.js +1 -2
- package/lib/AWS-NimbleStudio-Studio.d.ts +4 -58
- package/lib/AWS-NimbleStudio-Studio.js +1 -2
- package/lib/AWS-NimbleStudio-StudioComponent.d.ts +11 -187
- package/lib/AWS-NimbleStudio-StudioComponent.js +1 -2
- package/lib/AWS-Wisdom-AIAgent.d.ts +182 -0
- package/lib/AWS-Wisdom-AIAgent.js +12 -0
- package/lib/AWS-Wisdom-AIAgentVersion.d.ts +45 -0
- package/lib/AWS-Wisdom-AIAgentVersion.js +12 -0
- package/package.json +1 -1
|
@@ -6,13 +6,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html}
|
|
7
7
|
*/
|
|
8
8
|
export type ApiGatewayRestApiProperties = {
|
|
9
|
-
/**
|
|
10
|
-
* The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.
|
|
11
|
-
*/
|
|
12
9
|
ApiKeySourceType?: string;
|
|
13
|
-
/**
|
|
14
|
-
* The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
|
|
15
|
-
*/
|
|
16
10
|
BinaryMediaTypes?: string[];
|
|
17
11
|
/**
|
|
18
12
|
* An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
|
|
@@ -22,29 +16,14 @@ export type ApiGatewayRestApiProperties = {
|
|
|
22
16
|
* The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
|
|
23
17
|
*/
|
|
24
18
|
BodyS3Location?: S3Location;
|
|
25
|
-
/**
|
|
26
|
-
* The ID of the RestApi that you want to clone from.
|
|
27
|
-
*/
|
|
28
19
|
CloneFrom?: string;
|
|
29
|
-
/**
|
|
30
|
-
* The description of the RestApi.
|
|
31
|
-
*/
|
|
32
20
|
Description?: string;
|
|
33
|
-
/**
|
|
34
|
-
* Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
|
|
35
|
-
*/
|
|
36
21
|
DisableExecuteApiEndpoint?: boolean;
|
|
37
22
|
/**
|
|
38
23
|
* A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property.
|
|
39
24
|
*/
|
|
40
25
|
EndpointConfiguration?: EndpointConfiguration;
|
|
41
|
-
/**
|
|
42
|
-
* A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.
|
|
43
|
-
*/
|
|
44
26
|
FailOnWarnings?: boolean;
|
|
45
|
-
/**
|
|
46
|
-
* A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
|
|
47
|
-
*/
|
|
48
27
|
MinimumCompressionSize?: number;
|
|
49
28
|
/**
|
|
50
29
|
* This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates.
|
|
@@ -59,17 +38,11 @@ export type ApiGatewayRestApiProperties = {
|
|
|
59
38
|
* The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
|
|
60
39
|
*/
|
|
61
40
|
Name?: string;
|
|
62
|
-
/**
|
|
63
|
-
* Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.
|
|
64
|
-
*/
|
|
65
41
|
Parameters?: Record<string, string> | string;
|
|
66
42
|
/**
|
|
67
43
|
* A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``""`` as delimiter and values of ``"execute-api:/"`` and ``"*"``.
|
|
68
44
|
*/
|
|
69
45
|
Policy?: Record<string, any> | string;
|
|
70
|
-
/**
|
|
71
|
-
* The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.
|
|
72
|
-
*/
|
|
73
46
|
Tags?: Tag[];
|
|
74
47
|
};
|
|
75
48
|
/**
|
|
@@ -87,13 +60,7 @@ export type ApiGatewayRestApiAttributes = {
|
|
|
87
60
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html}
|
|
88
61
|
*/
|
|
89
62
|
export type EndpointConfiguration = {
|
|
90
|
-
/**
|
|
91
|
-
* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``"EDGE"``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``.
|
|
92
|
-
*/
|
|
93
63
|
Types?: string[];
|
|
94
|
-
/**
|
|
95
|
-
* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.
|
|
96
|
-
*/
|
|
97
64
|
VpcEndpointIds?: string[];
|
|
98
65
|
};
|
|
99
66
|
/**
|
|
@@ -6,56 +6,21 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
6
6
|
*/
|
|
7
7
|
export type ApiGatewayStageProperties = {
|
|
8
8
|
/**
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
* The ``AccessLogSetting`` property type specifies settings for logging access in this stage.
|
|
10
|
+
``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
|
|
11
|
+
*/
|
|
11
12
|
AccessLogSetting?: AccessLogSetting;
|
|
12
|
-
/**
|
|
13
|
-
* Specifies whether a cache cluster is enabled for the stage.
|
|
14
|
-
*/
|
|
15
13
|
CacheClusterEnabled?: boolean;
|
|
16
|
-
/**
|
|
17
|
-
* The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).
|
|
18
|
-
*/
|
|
19
14
|
CacheClusterSize?: string;
|
|
20
|
-
/**
|
|
21
|
-
* Settings for the canary deployment in this stage.
|
|
22
|
-
*/
|
|
23
15
|
CanarySetting?: CanarySetting;
|
|
24
|
-
/**
|
|
25
|
-
* The identifier of a client certificate for an API stage.
|
|
26
|
-
*/
|
|
27
16
|
ClientCertificateId?: string;
|
|
28
|
-
/**
|
|
29
|
-
* The identifier of the Deployment that the stage points to.
|
|
30
|
-
*/
|
|
31
17
|
DeploymentId?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The stage's description.
|
|
34
|
-
*/
|
|
35
18
|
Description?: string;
|
|
36
|
-
/**
|
|
37
|
-
* The version of the associated API documentation.
|
|
38
|
-
*/
|
|
39
19
|
DocumentationVersion?: string;
|
|
40
|
-
/**
|
|
41
|
-
* A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\/*\*`` for overriding all methods in the stage.
|
|
42
|
-
*/
|
|
43
20
|
MethodSettings?: MethodSetting[];
|
|
44
|
-
/**
|
|
45
|
-
* The string identifier of the associated RestApi.
|
|
46
|
-
*/
|
|
47
21
|
RestApiId: string;
|
|
48
|
-
/**
|
|
49
|
-
* The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
|
|
50
|
-
*/
|
|
51
22
|
StageName?: string;
|
|
52
|
-
/**
|
|
53
|
-
* The collection of tags. Each tag element is associated with a given resource.
|
|
54
|
-
*/
|
|
55
23
|
Tags?: Tag[];
|
|
56
|
-
/**
|
|
57
|
-
* Specifies whether active tracing with X-ray is enabled for the Stage.
|
|
58
|
-
*/
|
|
59
24
|
TracingEnabled?: boolean;
|
|
60
25
|
/**
|
|
61
26
|
* A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.
|
|
@@ -80,27 +45,16 @@ export type AccessLogSetting = {
|
|
|
80
45
|
};
|
|
81
46
|
/**
|
|
82
47
|
* Type definition for `AWS::ApiGateway::Stage.CanarySetting`.
|
|
83
|
-
* Configuration settings of a canary deployment.
|
|
84
48
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html}
|
|
85
49
|
*/
|
|
86
50
|
export type CanarySetting = {
|
|
87
|
-
/**
|
|
88
|
-
* The ID of the canary deployment.
|
|
89
|
-
*/
|
|
90
51
|
DeploymentId?: string;
|
|
91
52
|
/**
|
|
92
|
-
* The percent (0-100) of traffic diverted to a canary deployment.
|
|
93
53
|
* @min `0`
|
|
94
54
|
* @max `100`
|
|
95
55
|
*/
|
|
96
56
|
PercentTraffic?: number;
|
|
97
|
-
/**
|
|
98
|
-
* Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
|
|
99
|
-
*/
|
|
100
57
|
StageVariableOverrides?: Record<string, string>;
|
|
101
|
-
/**
|
|
102
|
-
* A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
|
|
103
|
-
*/
|
|
104
58
|
UseStageCache?: boolean;
|
|
105
59
|
};
|
|
106
60
|
/**
|
|
@@ -110,45 +64,25 @@ export type CanarySetting = {
|
|
|
110
64
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html}
|
|
111
65
|
*/
|
|
112
66
|
export type MethodSetting = {
|
|
113
|
-
/**
|
|
114
|
-
* Specifies whether the cached responses are encrypted.
|
|
115
|
-
*/
|
|
116
67
|
CacheDataEncrypted?: boolean;
|
|
117
|
-
/**
|
|
118
|
-
* Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
|
|
119
|
-
*/
|
|
120
68
|
CacheTtlInSeconds?: number;
|
|
121
|
-
/**
|
|
122
|
-
* Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
|
|
123
|
-
*/
|
|
124
69
|
CachingEnabled?: boolean;
|
|
125
|
-
/**
|
|
126
|
-
* Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
|
|
127
|
-
*/
|
|
128
70
|
DataTraceEnabled?: boolean;
|
|
129
71
|
/**
|
|
130
72
|
* The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.
|
|
131
73
|
*/
|
|
132
74
|
HttpMethod?: string;
|
|
133
|
-
/**
|
|
134
|
-
* Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.
|
|
135
|
-
*/
|
|
136
75
|
LoggingLevel?: string;
|
|
137
|
-
/**
|
|
138
|
-
* Specifies whether Amazon CloudWatch metrics are enabled for this method.
|
|
139
|
-
*/
|
|
140
76
|
MetricsEnabled?: boolean;
|
|
141
77
|
/**
|
|
142
78
|
* The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.
|
|
143
79
|
*/
|
|
144
80
|
ResourcePath?: string;
|
|
145
81
|
/**
|
|
146
|
-
* Specifies the throttling burst limit.
|
|
147
82
|
* @min `0`
|
|
148
83
|
*/
|
|
149
84
|
ThrottlingBurstLimit?: number;
|
|
150
85
|
/**
|
|
151
|
-
* Specifies the throttling rate limit.
|
|
152
86
|
* @min `0`
|
|
153
87
|
*/
|
|
154
88
|
ThrottlingRateLimit?: number;
|
|
@@ -6,29 +6,18 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html}
|
|
7
7
|
*/
|
|
8
8
|
export type ApiGatewayUsagePlanProperties = {
|
|
9
|
-
/**
|
|
10
|
-
* The associated API stages of a usage plan.
|
|
11
|
-
*/
|
|
12
9
|
ApiStages?: ApiStage[];
|
|
13
|
-
/**
|
|
14
|
-
* The description of a usage plan.
|
|
15
|
-
*/
|
|
16
10
|
Description?: string;
|
|
17
11
|
/**
|
|
18
|
-
|
|
19
|
-
|
|
12
|
+
* ``QuotaSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
|
|
13
|
+
In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
|
|
14
|
+
*/
|
|
20
15
|
Quota?: QuotaSettings;
|
|
21
|
-
/**
|
|
22
|
-
* The collection of tags. Each tag element is associated with a given resource.
|
|
23
|
-
*/
|
|
24
16
|
Tags?: Tag[];
|
|
25
17
|
/**
|
|
26
|
-
*
|
|
18
|
+
* ``ThrottleSettings`` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
|
|
27
19
|
*/
|
|
28
20
|
Throttle?: ThrottleSettings;
|
|
29
|
-
/**
|
|
30
|
-
* The name of a usage plan.
|
|
31
|
-
*/
|
|
32
21
|
UsagePlanName?: string;
|
|
33
22
|
};
|
|
34
23
|
/**
|
|
@@ -40,21 +29,11 @@ export type ApiGatewayUsagePlanAttributes = {
|
|
|
40
29
|
};
|
|
41
30
|
/**
|
|
42
31
|
* Type definition for `AWS::ApiGateway::UsagePlan.ApiStage`.
|
|
43
|
-
* API stage name of the associated API stage in a usage plan.
|
|
44
32
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html}
|
|
45
33
|
*/
|
|
46
34
|
export type ApiStage = {
|
|
47
|
-
/**
|
|
48
|
-
* API Id of the associated API stage in a usage plan.
|
|
49
|
-
*/
|
|
50
35
|
ApiId?: string;
|
|
51
|
-
/**
|
|
52
|
-
* API stage name of the associated API stage in a usage plan.
|
|
53
|
-
*/
|
|
54
36
|
Stage?: string;
|
|
55
|
-
/**
|
|
56
|
-
* Map containing method level throttling information for API stage in a usage plan.
|
|
57
|
-
*/
|
|
58
37
|
Throttle?: Record<string, ThrottleSettings>;
|
|
59
38
|
};
|
|
60
39
|
/**
|
|
@@ -65,18 +44,13 @@ export type ApiStage = {
|
|
|
65
44
|
*/
|
|
66
45
|
export type QuotaSettings = {
|
|
67
46
|
/**
|
|
68
|
-
* The target maximum number of requests that can be made in a given time period.
|
|
69
47
|
* @min `0`
|
|
70
48
|
*/
|
|
71
49
|
Limit?: number;
|
|
72
50
|
/**
|
|
73
|
-
* The number of requests subtracted from the given limit in the initial time period.
|
|
74
51
|
* @min `0`
|
|
75
52
|
*/
|
|
76
53
|
Offset?: number;
|
|
77
|
-
/**
|
|
78
|
-
* The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
|
|
79
|
-
*/
|
|
80
54
|
Period?: string;
|
|
81
55
|
};
|
|
82
56
|
/**
|
|
@@ -104,12 +78,10 @@ export type Tag = {
|
|
|
104
78
|
*/
|
|
105
79
|
export type ThrottleSettings = {
|
|
106
80
|
/**
|
|
107
|
-
* The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
|
|
108
81
|
* @min `0`
|
|
109
82
|
*/
|
|
110
83
|
BurstLimit?: number;
|
|
111
84
|
/**
|
|
112
|
-
* The API target request rate limit.
|
|
113
85
|
* @min `0`
|
|
114
86
|
*/
|
|
115
87
|
RateLimit?: number;
|
|
@@ -9,9 +9,6 @@ export type ApiGatewayUsagePlanKeyProperties = {
|
|
|
9
9
|
* The Id of the UsagePlanKey resource.
|
|
10
10
|
*/
|
|
11
11
|
KeyId: string;
|
|
12
|
-
/**
|
|
13
|
-
* The type of a UsagePlanKey resource for a plan customer.
|
|
14
|
-
*/
|
|
15
12
|
KeyType: "API_KEY";
|
|
16
13
|
/**
|
|
17
14
|
* The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
|
|
@@ -1,51 +1,18 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
|
-
* Resource
|
|
5
|
-
* Represents a launch profile which delegates access to a collection of studio components to studio users
|
|
4
|
+
* Resource Type definition for AWS::NimbleStudio::LaunchProfile
|
|
6
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html}
|
|
7
6
|
*/
|
|
8
7
|
export type NimbleStudioLaunchProfileProperties = {
|
|
9
|
-
/**
|
|
10
|
-
* <p>The description.</p>
|
|
11
|
-
* @minLength `0`
|
|
12
|
-
* @maxLength `256`
|
|
13
|
-
*/
|
|
14
8
|
Description?: string;
|
|
15
|
-
/**
|
|
16
|
-
* <p>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from.
|
|
17
|
-
These subnets must support the specified instance types. </p>
|
|
18
|
-
* @minLength `0`
|
|
19
|
-
* @maxLength `6`
|
|
20
|
-
*/
|
|
21
9
|
Ec2SubnetIds: string[];
|
|
22
|
-
/**
|
|
23
|
-
* <p>The version number of the protocol that is used by the launch profile. The only valid
|
|
24
|
-
version is "2021-03-31".</p>
|
|
25
|
-
*/
|
|
26
10
|
LaunchProfileProtocolVersions: string[];
|
|
27
|
-
/**
|
|
28
|
-
* <p>The name for the launch profile.</p>
|
|
29
|
-
* @minLength `1`
|
|
30
|
-
* @maxLength `64`
|
|
31
|
-
*/
|
|
32
11
|
Name: string;
|
|
33
|
-
/**
|
|
34
|
-
* <p>A configuration for a streaming session.</p>
|
|
35
|
-
*/
|
|
36
12
|
StreamConfiguration: StreamConfiguration;
|
|
37
|
-
/**
|
|
38
|
-
* <p>Unique identifiers for a collection of studio components that can be used with this
|
|
39
|
-
launch profile.</p>
|
|
40
|
-
* @minLength `1`
|
|
41
|
-
* @maxLength `100`
|
|
42
|
-
*/
|
|
43
13
|
StudioComponentIds: string[];
|
|
44
|
-
/**
|
|
45
|
-
* <p>The studio ID. </p>
|
|
46
|
-
*/
|
|
47
14
|
StudioId: string;
|
|
48
|
-
Tags?:
|
|
15
|
+
Tags?: Record<string, string>;
|
|
49
16
|
};
|
|
50
17
|
/**
|
|
51
18
|
* Attribute type definition for `AWS::NimbleStudio::LaunchProfile`.
|
|
@@ -54,201 +21,57 @@ export type NimbleStudioLaunchProfileProperties = {
|
|
|
54
21
|
export type NimbleStudioLaunchProfileAttributes = {
|
|
55
22
|
LaunchProfileId: string;
|
|
56
23
|
};
|
|
57
|
-
/**
|
|
58
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.AutomaticTerminationMode`.
|
|
59
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-automaticterminationmode.html}
|
|
60
|
-
*/
|
|
61
|
-
export type AutomaticTerminationMode = "DEACTIVATED" | "ACTIVATED";
|
|
62
|
-
/**
|
|
63
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.SessionBackupMode`.
|
|
64
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-sessionbackupmode.html}
|
|
65
|
-
*/
|
|
66
|
-
export type SessionBackupMode = "AUTOMATIC" | "DEACTIVATED";
|
|
67
|
-
/**
|
|
68
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.SessionPersistenceMode`.
|
|
69
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-sessionpersistencemode.html}
|
|
70
|
-
*/
|
|
71
|
-
export type SessionPersistenceMode = "DEACTIVATED" | "ACTIVATED";
|
|
72
24
|
/**
|
|
73
25
|
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamConfiguration`.
|
|
74
|
-
* <p>A configuration for a streaming session.</p>
|
|
75
26
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfiguration.html}
|
|
76
27
|
*/
|
|
77
28
|
export type StreamConfiguration = {
|
|
78
|
-
AutomaticTerminationMode?:
|
|
79
|
-
ClipboardMode:
|
|
80
|
-
|
|
81
|
-
* <p>The EC2 instance types that users can select from when launching a streaming session
|
|
82
|
-
with this launch profile.</p>
|
|
83
|
-
* @minLength `1`
|
|
84
|
-
* @maxLength `30`
|
|
85
|
-
*/
|
|
86
|
-
Ec2InstanceTypes: StreamingInstanceType[];
|
|
87
|
-
/**
|
|
88
|
-
* <p>The length of time, in minutes, that a streaming session can be active before it is
|
|
89
|
-
stopped or terminated. After this point, Nimble Studio automatically terminates or
|
|
90
|
-
stops the session. The default length of time is 690 minutes, and the maximum length of
|
|
91
|
-
time is 30 days.</p>
|
|
92
|
-
* @min `1`
|
|
93
|
-
* @max `43200`
|
|
94
|
-
*/
|
|
29
|
+
AutomaticTerminationMode?: string;
|
|
30
|
+
ClipboardMode: string;
|
|
31
|
+
Ec2InstanceTypes: string[];
|
|
95
32
|
MaxSessionLengthInMinutes?: number;
|
|
96
|
-
/**
|
|
97
|
-
* <p>Integer that determines if you can start and stop your sessions and how long a session
|
|
98
|
-
can stay in the <code>STOPPED</code> state. The default value is 0. The maximum value is
|
|
99
|
-
5760.</p>
|
|
100
|
-
<p>This field is allowed only when <code>sessionPersistenceMode</code> is
|
|
101
|
-
<code>ACTIVATED</code> and <code>automaticTerminationMode</code> is
|
|
102
|
-
<code>ACTIVATED</code>.</p>
|
|
103
|
-
<p>If the value is set to 0, your sessions can’t be <code>STOPPED</code>. If you then
|
|
104
|
-
call <code>StopStreamingSession</code>, the session fails. If the time that a session
|
|
105
|
-
stays in the <code>READY</code> state exceeds the <code>maxSessionLengthInMinutes</code>
|
|
106
|
-
value, the session will automatically be terminated (instead of
|
|
107
|
-
<code>STOPPED</code>).</p>
|
|
108
|
-
<p>If the value is set to a positive number, the session can be stopped. You can call
|
|
109
|
-
<code>StopStreamingSession</code> to stop sessions in the <code>READY</code> state.
|
|
110
|
-
If the time that a session stays in the <code>READY</code> state exceeds the
|
|
111
|
-
<code>maxSessionLengthInMinutes</code> value, the session will automatically be
|
|
112
|
-
stopped (instead of terminated).</p>
|
|
113
|
-
* @min `0`
|
|
114
|
-
* @max `5760`
|
|
115
|
-
*/
|
|
116
33
|
MaxStoppedSessionLengthInMinutes?: number;
|
|
117
|
-
/**
|
|
118
|
-
* <p>Configures how streaming sessions are backed up when launched from this launch
|
|
119
|
-
profile.</p>
|
|
120
|
-
*/
|
|
121
34
|
SessionBackup?: StreamConfigurationSessionBackup;
|
|
122
|
-
SessionPersistenceMode?:
|
|
123
|
-
/**
|
|
124
|
-
* <p>The configuration for a streaming session’s upload storage.</p>
|
|
125
|
-
*/
|
|
35
|
+
SessionPersistenceMode?: string;
|
|
126
36
|
SessionStorage?: StreamConfigurationSessionStorage;
|
|
127
|
-
/**
|
|
128
|
-
* <p>The streaming images that users can select from when launching a streaming session
|
|
129
|
-
with this launch profile.</p>
|
|
130
|
-
* @minLength `1`
|
|
131
|
-
* @maxLength `20`
|
|
132
|
-
*/
|
|
133
37
|
StreamingImageIds: string[];
|
|
134
|
-
/**
|
|
135
|
-
* <p>Custom volume configuration for the root volumes that are attached to streaming
|
|
136
|
-
sessions.</p>
|
|
137
|
-
<p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
|
|
138
|
-
<code>ACTIVATED</code>.</p>
|
|
139
|
-
*/
|
|
140
38
|
VolumeConfiguration?: VolumeConfiguration;
|
|
141
39
|
};
|
|
142
40
|
/**
|
|
143
41
|
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionBackup`.
|
|
144
|
-
* <p>Configures how streaming sessions are backed up when launched from this launch
|
|
145
|
-
profile.</p>
|
|
146
42
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionbackup.html}
|
|
147
43
|
*/
|
|
148
44
|
export type StreamConfigurationSessionBackup = {
|
|
149
|
-
/**
|
|
150
|
-
* <p>The maximum number of backups that each streaming session created from this launch
|
|
151
|
-
profile can have.</p>
|
|
152
|
-
* @min `0`
|
|
153
|
-
* @max `10`
|
|
154
|
-
*/
|
|
155
45
|
MaxBackupsToRetain?: number;
|
|
156
|
-
Mode?:
|
|
46
|
+
Mode?: string;
|
|
157
47
|
};
|
|
158
48
|
/**
|
|
159
49
|
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamConfigurationSessionStorage`.
|
|
160
|
-
* <p>The configuration for a streaming session’s upload storage.</p>
|
|
161
50
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamconfigurationsessionstorage.html}
|
|
162
51
|
*/
|
|
163
52
|
export type StreamConfigurationSessionStorage = {
|
|
164
|
-
|
|
165
|
-
* <p>Allows artists to upload files to their workstations. The only valid option is
|
|
166
|
-
<code>UPLOAD</code>.</p>
|
|
167
|
-
* @minLength `1`
|
|
168
|
-
*/
|
|
169
|
-
Mode: StreamingSessionStorageMode[];
|
|
170
|
-
/**
|
|
171
|
-
* <p>The upload storage root location (folder) on streaming workstations where files are
|
|
172
|
-
uploaded.</p>
|
|
173
|
-
*/
|
|
53
|
+
Mode: string[];
|
|
174
54
|
Root?: StreamingSessionStorageRoot;
|
|
175
55
|
};
|
|
176
|
-
/**
|
|
177
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamingClipboardMode`.
|
|
178
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingclipboardmode.html}
|
|
179
|
-
*/
|
|
180
|
-
export type StreamingClipboardMode = "ENABLED" | "DISABLED";
|
|
181
|
-
/**
|
|
182
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamingInstanceType`.
|
|
183
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streaminginstancetype.html}
|
|
184
|
-
*/
|
|
185
|
-
export type StreamingInstanceType = "g4dn.xlarge" | "g4dn.2xlarge" | "g4dn.4xlarge" | "g4dn.8xlarge" | "g4dn.12xlarge" | "g4dn.16xlarge" | "g3.4xlarge" | "g3s.xlarge" | "g5.xlarge" | "g5.2xlarge" | "g5.4xlarge" | "g5.8xlarge" | "g5.16xlarge";
|
|
186
|
-
/**
|
|
187
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamingSessionStorageMode`.
|
|
188
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstoragemode.html}
|
|
189
|
-
*/
|
|
190
|
-
export type StreamingSessionStorageMode = "UPLOAD";
|
|
191
56
|
/**
|
|
192
57
|
* Type definition for `AWS::NimbleStudio::LaunchProfile.StreamingSessionStorageRoot`.
|
|
193
|
-
* <p>The upload storage root location (folder) on streaming workstations where files are
|
|
194
|
-
uploaded.</p>
|
|
195
58
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-streamingsessionstorageroot.html}
|
|
196
59
|
*/
|
|
197
60
|
export type StreamingSessionStorageRoot = {
|
|
198
|
-
/**
|
|
199
|
-
* <p>The folder path in Linux workstations where files are uploaded.</p>
|
|
200
|
-
* @minLength `1`
|
|
201
|
-
* @maxLength `128`
|
|
202
|
-
* @pattern `^(\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$`
|
|
203
|
-
*/
|
|
204
61
|
Linux?: string;
|
|
205
|
-
/**
|
|
206
|
-
* <p>The folder path in Windows workstations where files are uploaded.</p>
|
|
207
|
-
* @minLength `1`
|
|
208
|
-
* @maxLength `128`
|
|
209
|
-
* @pattern `^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$`
|
|
210
|
-
*/
|
|
211
62
|
Windows?: string;
|
|
212
63
|
};
|
|
213
|
-
/**
|
|
214
|
-
* Type definition for `AWS::NimbleStudio::LaunchProfile.Tags`.
|
|
215
|
-
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-tags.html}
|
|
216
|
-
*/
|
|
217
|
-
export type Tags = Record<string, string>;
|
|
218
64
|
/**
|
|
219
65
|
* Type definition for `AWS::NimbleStudio::LaunchProfile.VolumeConfiguration`.
|
|
220
|
-
* <p>Custom volume configuration for the root volumes that are attached to streaming
|
|
221
|
-
sessions.</p>
|
|
222
|
-
<p>This parameter is only allowed when <code>sessionPersistenceMode</code> is
|
|
223
|
-
<code>ACTIVATED</code>.</p>
|
|
224
66
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-nimblestudio-launchprofile-volumeconfiguration.html}
|
|
225
67
|
*/
|
|
226
68
|
export type VolumeConfiguration = {
|
|
227
|
-
/**
|
|
228
|
-
* <p>The number of I/O operations per second for the root volume that is attached to
|
|
229
|
-
streaming session.</p>
|
|
230
|
-
* @min `3000`
|
|
231
|
-
* @max `16000`
|
|
232
|
-
*/
|
|
233
69
|
Iops?: number;
|
|
234
|
-
/**
|
|
235
|
-
* <p>The size of the root volume that is attached to the streaming session. The root volume
|
|
236
|
-
size is measured in GiBs.</p>
|
|
237
|
-
* @min `100`
|
|
238
|
-
* @max `16000`
|
|
239
|
-
*/
|
|
240
70
|
Size?: number;
|
|
241
|
-
/**
|
|
242
|
-
* <p>The throughput to provision for the root volume that is attached to the streaming
|
|
243
|
-
session. The throughput is measured in MiB/s.</p>
|
|
244
|
-
* @min `125`
|
|
245
|
-
* @max `1000`
|
|
246
|
-
*/
|
|
247
71
|
Throughput?: number;
|
|
248
72
|
};
|
|
249
73
|
/**
|
|
250
|
-
* Resource
|
|
251
|
-
* Represents a launch profile which delegates access to a collection of studio components to studio users
|
|
74
|
+
* Resource Type definition for AWS::NimbleStudio::LaunchProfile
|
|
252
75
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html}
|
|
253
76
|
*/
|
|
254
77
|
export declare class NimbleStudioLaunchProfile extends $Resource<"AWS::NimbleStudio::LaunchProfile", NimbleStudioLaunchProfileProperties, NimbleStudioLaunchProfileAttributes> {
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
|
-
* Resource
|
|
4
|
-
* Represents a launch profile which delegates access to a collection of studio components to studio users
|
|
3
|
+
* Resource Type definition for AWS::NimbleStudio::LaunchProfile
|
|
5
4
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-nimblestudio-launchprofile.html}
|
|
6
5
|
*/
|
|
7
6
|
export class NimbleStudioLaunchProfile extends $Resource {
|