@awboost/cfn-resource-types 0.1.279 → 0.1.281
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-ECS-Service.d.ts +14 -3
- package/lib/AWS-ECS-TaskDefinition.d.ts +11 -6
- package/lib/AWS-IAM-SAMLProvider.d.ts +48 -1
- package/lib/AWS-OpenSearchServerless-Index.d.ts +130 -0
- package/lib/AWS-OpenSearchServerless-Index.js +13 -0
- package/lib/AWS-RDS-DBCluster.d.ts +1 -1
- package/lib/AWS-RDS-DBInstance.d.ts +1 -1
- package/package.json +1 -1
package/lib/AWS-ECS-Service.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ export type ECSServiceProperties = {
|
|
|
15
15
|
/**
|
|
16
16
|
* The capacity provider strategy to use for the service.
|
|
17
17
|
If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used.
|
|
18
|
-
A capacity provider strategy
|
|
18
|
+
A capacity provider strategy can contain a maximum of 20 capacity providers.
|
|
19
19
|
To remove this property from your service resource, specify an empty ``CapacityProviderStrategyItem`` array.
|
|
20
20
|
*/
|
|
21
21
|
CapacityProviderStrategy?: CapacityProviderStrategyItem[];
|
|
@@ -157,8 +157,12 @@ export type ECSServiceAttributes = {
|
|
|
157
157
|
*/
|
|
158
158
|
export type AwsVpcConfiguration = {
|
|
159
159
|
/**
|
|
160
|
-
|
|
161
|
-
|
|
160
|
+
* Whether the task's elastic network interface receives a public IP address.
|
|
161
|
+
Consider the following when you set this value:
|
|
162
|
+
+ When you use ``create-service`` or ``update-service``, the default is ``DISABLED``.
|
|
163
|
+
+ When the service ``deploymentController`` is ``ECS``, the value must be ``DISABLED``.
|
|
164
|
+
+ When you use ``create-service`` or ``update-service``, the default is ``ENABLED``.
|
|
165
|
+
*/
|
|
162
166
|
AssignPublicIp?: "DISABLED" | "ENABLED";
|
|
163
167
|
/**
|
|
164
168
|
* The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.
|
|
@@ -691,6 +695,13 @@ export type ServiceVolumeConfiguration = {
|
|
|
691
695
|
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
|
|
692
696
|
+ Tag keys and values are case-sensitive.
|
|
693
697
|
+ Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
|
|
698
|
+
|
|
699
|
+
In order to tag a service that has the following ARN format, you need to migrate the service to the long ARN. You must use the API, CLI or console to migrate the service ARN. For more information, see [Migrate an short service ARN to a long ARN](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-arn-migration.html) in the *Developer Guide*.
|
|
700
|
+
``arn:aws:ecs:region:aws_account_id:service/service-name``
|
|
701
|
+
After the migration is complete, the following are true:
|
|
702
|
+
+ The service ARN is: ``arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name``
|
|
703
|
+
+ You can use CFN to tag the service as you would a service with a long ARN format.
|
|
704
|
+
+ When the ``PhysicalResourceId`` in the CFN stack represents a service, the value does not change and will be the short service ARN.
|
|
694
705
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-tag.html}
|
|
695
706
|
*/
|
|
696
707
|
export type Tag = {
|
|
@@ -16,8 +16,7 @@ export type ECSTaskDefinitionProperties = {
|
|
|
16
16
|
ContainerDefinitions?: ContainerDefinition[];
|
|
17
17
|
/**
|
|
18
18
|
* The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter.
|
|
19
|
-
If you
|
|
20
|
-
The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
|
|
19
|
+
If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between ``128`` CPU units (``0.125`` vCPUs) and ``196608`` CPU units (``192`` vCPUs). The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.
|
|
21
20
|
+ 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
|
|
22
21
|
+ 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
|
|
23
22
|
+ 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
|
|
@@ -633,20 +632,20 @@ export type HealthCheck = {
|
|
|
633
632
|
*/
|
|
634
633
|
Command?: string[];
|
|
635
634
|
/**
|
|
636
|
-
* The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
|
|
635
|
+
* The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. This value applies only when you specify a ``command``.
|
|
637
636
|
*/
|
|
638
637
|
Interval?: number;
|
|
639
638
|
/**
|
|
640
|
-
* The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
|
|
639
|
+
* The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. This value applies only when you specify a ``command``.
|
|
641
640
|
*/
|
|
642
641
|
Retries?: number;
|
|
643
642
|
/**
|
|
644
|
-
* The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off.
|
|
643
|
+
* The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. This value applies only when you specify a ``command``.
|
|
645
644
|
If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
|
|
646
645
|
*/
|
|
647
646
|
StartPeriod?: number;
|
|
648
647
|
/**
|
|
649
|
-
* The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
|
|
648
|
+
* The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. This value applies only when you specify a ``command``.
|
|
650
649
|
*/
|
|
651
650
|
Timeout?: number;
|
|
652
651
|
};
|
|
@@ -695,6 +694,12 @@ export type InferenceAccelerator = {
|
|
|
695
694
|
/**
|
|
696
695
|
* Type definition for `AWS::ECS::TaskDefinition.KernelCapabilities`.
|
|
697
696
|
* The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.
|
|
697
|
+
The following describes how Docker processes the Linux capabilities specified in the ``add`` and ``drop`` request parameters. For information about the latest behavior, see [Docker Compose: order of cap_drop and cap_add](https://docs.aws.amazon.com/https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1) in the Docker Community Forum.
|
|
698
|
+
+ When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the ``add`` request parameter, and the ``drop`` request parameter are ignored.
|
|
699
|
+
+ When the ``add`` request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the ``drop`` request parameter.
|
|
700
|
+
+ When the ``drop`` request parameter is set to ALL, the container capabilities are the capabilities specified in the ``add`` request parameter.
|
|
701
|
+
+ When the ``add`` request parameter and the ``drop`` request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities.
|
|
702
|
+
+ The default is to first drop the capabilities specified in the ``drop`` request parameter, and then add the capabilities specified in the ``add`` request parameter.
|
|
698
703
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-kernelcapabilities.html}
|
|
699
704
|
*/
|
|
700
705
|
export type KernelCapabilities = {
|
|
@@ -5,17 +5,39 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html}
|
|
6
6
|
*/
|
|
7
7
|
export type IAMSAMLProviderProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* The private key from your external identity provider
|
|
10
|
+
* @minLength `1`
|
|
11
|
+
* @maxLength `16384`
|
|
12
|
+
* @pattern `[\u0009\u000A\u000D\u0020-\u00FF]+`
|
|
13
|
+
*/
|
|
14
|
+
AddPrivateKey?: string;
|
|
15
|
+
/**
|
|
16
|
+
* The encryption setting for the SAML provider
|
|
17
|
+
*/
|
|
18
|
+
AssertionEncryptionMode?: "Allowed" | "Required";
|
|
8
19
|
/**
|
|
9
20
|
* @minLength `1`
|
|
10
21
|
* @maxLength `128`
|
|
11
22
|
* @pattern `[\w._-]+`
|
|
12
23
|
*/
|
|
13
24
|
Name?: string;
|
|
25
|
+
/**
|
|
26
|
+
* @maxLength `2`
|
|
27
|
+
*/
|
|
28
|
+
PrivateKeyList?: SAMLPrivateKey[];
|
|
29
|
+
/**
|
|
30
|
+
* The Key ID of the private key to remove
|
|
31
|
+
* @minLength `22`
|
|
32
|
+
* @maxLength `64`
|
|
33
|
+
* @pattern `[A-Z0-9]+`
|
|
34
|
+
*/
|
|
35
|
+
RemovePrivateKey?: string;
|
|
14
36
|
/**
|
|
15
37
|
* @minLength `1000`
|
|
16
38
|
* @maxLength `10000000`
|
|
17
39
|
*/
|
|
18
|
-
SamlMetadataDocument
|
|
40
|
+
SamlMetadataDocument?: string;
|
|
19
41
|
Tags?: Tag[];
|
|
20
42
|
};
|
|
21
43
|
/**
|
|
@@ -29,6 +51,31 @@ export type IAMSAMLProviderAttributes = {
|
|
|
29
51
|
* @maxLength `1600`
|
|
30
52
|
*/
|
|
31
53
|
Arn: string;
|
|
54
|
+
/**
|
|
55
|
+
* The unique identifier assigned to the SAML provider
|
|
56
|
+
* @minLength `22`
|
|
57
|
+
* @maxLength `64`
|
|
58
|
+
* @pattern `[A-Z0-9]+`
|
|
59
|
+
*/
|
|
60
|
+
SamlProviderUUID: string;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Type definition for `AWS::IAM::SAMLProvider.SAMLPrivateKey`.
|
|
64
|
+
* The private key metadata for the SAML provider
|
|
65
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html}
|
|
66
|
+
*/
|
|
67
|
+
export type SAMLPrivateKey = {
|
|
68
|
+
/**
|
|
69
|
+
* The unique identifier for the SAML private key.
|
|
70
|
+
* @minLength `22`
|
|
71
|
+
* @maxLength `64`
|
|
72
|
+
* @pattern `[A-Z0-9]+`
|
|
73
|
+
*/
|
|
74
|
+
KeyId: string;
|
|
75
|
+
/**
|
|
76
|
+
* The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time </a> format, when the private key was uploaded.
|
|
77
|
+
*/
|
|
78
|
+
Timestamp: string;
|
|
32
79
|
};
|
|
33
80
|
/**
|
|
34
81
|
* Type definition for `AWS::IAM::SAMLProvider.Tag`.
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
|
+
/**
|
|
4
|
+
* Resource type definition for `AWS::OpenSearchServerless::Index`.
|
|
5
|
+
* An OpenSearch Serverless index resource
|
|
6
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html}
|
|
7
|
+
*/
|
|
8
|
+
export type OpenSearchServerlessIndexProperties = {
|
|
9
|
+
/**
|
|
10
|
+
* The endpoint for the collection.
|
|
11
|
+
*/
|
|
12
|
+
CollectionEndpoint: string;
|
|
13
|
+
/**
|
|
14
|
+
* The name of the OpenSearch Serverless index.
|
|
15
|
+
* @pattern `^(?![_-])[a-z][a-z0-9_-]*$`
|
|
16
|
+
*/
|
|
17
|
+
IndexName: string;
|
|
18
|
+
/**
|
|
19
|
+
* Index Mappings
|
|
20
|
+
*/
|
|
21
|
+
Mappings?: {
|
|
22
|
+
/**
|
|
23
|
+
* Defines the fields within the mapping, including their types and configurations
|
|
24
|
+
*/
|
|
25
|
+
Properties?: Record<string, PropertyMapping>;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Index settings
|
|
29
|
+
*/
|
|
30
|
+
Settings?: IndexSettings;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Attribute type definition for `AWS::OpenSearchServerless::Index`.
|
|
34
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#aws-resource-opensearchserverless-index-return-values}
|
|
35
|
+
*/
|
|
36
|
+
export type OpenSearchServerlessIndexAttributes = {
|
|
37
|
+
/**
|
|
38
|
+
* The unique identifier for the index.
|
|
39
|
+
*/
|
|
40
|
+
Uuid: string;
|
|
41
|
+
};
|
|
42
|
+
/**
|
|
43
|
+
* Type definition for `AWS::OpenSearchServerless::Index.IndexSettings`.
|
|
44
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html}
|
|
45
|
+
*/
|
|
46
|
+
export type IndexSettings = {
|
|
47
|
+
Index?: {
|
|
48
|
+
/**
|
|
49
|
+
* Enable/disable k-nearest neighbor search capability
|
|
50
|
+
*/
|
|
51
|
+
Knn?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* Size of the dynamic list for the nearest neighbors
|
|
54
|
+
*/
|
|
55
|
+
KnnAlgoParamEfSearch?: number;
|
|
56
|
+
/**
|
|
57
|
+
* How often to perform refresh operation (e.g. '1s', '5s')
|
|
58
|
+
*/
|
|
59
|
+
RefreshInterval?: string;
|
|
60
|
+
};
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Type definition for `AWS::OpenSearchServerless::Index.PropertyMapping`.
|
|
64
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html}
|
|
65
|
+
*/
|
|
66
|
+
export type PropertyMapping = {
|
|
67
|
+
/**
|
|
68
|
+
* Dimension size for vector fields, defines the number of dimensions in the vector
|
|
69
|
+
*/
|
|
70
|
+
Dimension?: number;
|
|
71
|
+
/**
|
|
72
|
+
* Whether a field should be indexed
|
|
73
|
+
*/
|
|
74
|
+
Index?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Configuration for k-NN search method
|
|
77
|
+
*/
|
|
78
|
+
Method?: {
|
|
79
|
+
/**
|
|
80
|
+
* The k-NN search engine to use
|
|
81
|
+
*/
|
|
82
|
+
Engine: "nmslib" | "faiss" | "lucene";
|
|
83
|
+
/**
|
|
84
|
+
* The algorithm name for k-NN search
|
|
85
|
+
*/
|
|
86
|
+
Name: "hnsw" | "ivf";
|
|
87
|
+
/**
|
|
88
|
+
* Additional parameters for the k-NN algorithm
|
|
89
|
+
*/
|
|
90
|
+
Parameters?: {
|
|
91
|
+
/**
|
|
92
|
+
* The size of the dynamic list used during k-NN graph creation
|
|
93
|
+
* @min `1`
|
|
94
|
+
*/
|
|
95
|
+
EfConstruction?: number;
|
|
96
|
+
/**
|
|
97
|
+
* Number of neighbors to consider during k-NN search
|
|
98
|
+
* @min `2`
|
|
99
|
+
* @max `100`
|
|
100
|
+
*/
|
|
101
|
+
M?: number;
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* The distance function used for k-NN search
|
|
105
|
+
*/
|
|
106
|
+
SpaceType?: "l2" | "l1" | "linf" | "cosinesimil" | "innerproduct" | "hamming";
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* Nested fields within an object or nested field type
|
|
110
|
+
*/
|
|
111
|
+
Properties?: Record<string, PropertyMapping>;
|
|
112
|
+
/**
|
|
113
|
+
* The field data type. Must be a valid OpenSearch field type.
|
|
114
|
+
*/
|
|
115
|
+
Type: "text" | "knn_vector";
|
|
116
|
+
/**
|
|
117
|
+
* Default value for the field when not specified in a document
|
|
118
|
+
*/
|
|
119
|
+
Value?: string;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Resource type definition for `AWS::OpenSearchServerless::Index`.
|
|
123
|
+
* An OpenSearch Serverless index resource
|
|
124
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html}
|
|
125
|
+
*/
|
|
126
|
+
export declare class OpenSearchServerlessIndex extends $Resource<"AWS::OpenSearchServerless::Index", OpenSearchServerlessIndexProperties, OpenSearchServerlessIndexAttributes> {
|
|
127
|
+
static readonly Type = "AWS::OpenSearchServerless::Index";
|
|
128
|
+
constructor(logicalId: string, properties: OpenSearchServerlessIndexProperties, options?: $ResourceOptions);
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=AWS-OpenSearchServerless-Index.d.ts.map
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
/**
|
|
3
|
+
* Resource type definition for `AWS::OpenSearchServerless::Index`.
|
|
4
|
+
* An OpenSearch Serverless index resource
|
|
5
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html}
|
|
6
|
+
*/
|
|
7
|
+
export class OpenSearchServerlessIndex extends $Resource {
|
|
8
|
+
static Type = "AWS::OpenSearchServerless::Index";
|
|
9
|
+
constructor(logicalId, properties, options) {
|
|
10
|
+
super(logicalId, OpenSearchServerlessIndex.Type, properties, options);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=AWS-OpenSearchServerless-Index.js.map
|
|
@@ -123,7 +123,7 @@ export type RDSDBClusterProperties = {
|
|
|
123
123
|
/**
|
|
124
124
|
* The mode of Database Insights to enable for the DB cluster.
|
|
125
125
|
If you set this value to ``advanced``, you must also set the ``PerformanceInsightsEnabled`` parameter to ``true`` and the ``PerformanceInsightsRetentionPeriod`` parameter to 465.
|
|
126
|
-
Valid for Cluster Type: Aurora DB clusters
|
|
126
|
+
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
127
127
|
*/
|
|
128
128
|
DatabaseInsightsMode?: string;
|
|
129
129
|
/**
|
|
@@ -294,7 +294,7 @@ export type RDSDBInstanceProperties = {
|
|
|
294
294
|
DBSnapshotIdentifier?: string;
|
|
295
295
|
/**
|
|
296
296
|
* A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
|
|
297
|
-
If
|
|
297
|
+
If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a ``DBSubnetGroupName``, the DB instance fails to launch.
|
|
298
298
|
For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
299
299
|
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
300
300
|
*/
|