@awboost/cfn-resource-types 0.1.132 → 0.1.134

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.
@@ -1,27 +1,82 @@
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 Type definition for AWS::ApiGatewayV2::Integration
4
+ * Resource type definition for `AWS::ApiGatewayV2::Integration`.
5
+ * An example resource schema demonstrating some basic constructs and validation rules.
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html}
6
7
  */
7
8
  export type ApiGatewayV2IntegrationProperties = {
9
+ /**
10
+ * The API identifier.
11
+ */
8
12
  ApiId: string;
13
+ /**
14
+ * The ID of the VPC link for a private integration. Supported only for HTTP APIs.
15
+ */
9
16
  ConnectionId?: string;
17
+ /**
18
+ * The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
19
+ */
10
20
  ConnectionType?: string;
21
+ /**
22
+ * Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT.
23
+ */
11
24
  ContentHandlingStrategy?: string;
25
+ /**
26
+ * Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter.
27
+ */
12
28
  CredentialsArn?: string;
29
+ /**
30
+ * The description of the integration.
31
+ */
13
32
  Description?: string;
33
+ /**
34
+ * Specifies the integration's HTTP method type.
35
+ */
14
36
  IntegrationMethod?: string;
37
+ /**
38
+ * Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
39
+ */
15
40
  IntegrationSubtype?: string;
41
+ /**
42
+ * The integration type of an integration.
43
+ */
16
44
  IntegrationType: string;
45
+ /**
46
+ * For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service.
47
+ */
17
48
  IntegrationUri?: string;
49
+ /**
50
+ * Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
51
+ */
18
52
  PassthroughBehavior?: string;
53
+ /**
54
+ * Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value.
55
+ */
19
56
  PayloadFormatVersion?: string;
20
- RequestParameters?: Record<string, any>;
21
- RequestTemplates?: Record<string, any>;
22
- ResponseParameters?: Record<string, any>;
57
+ /**
58
+ * A key-value map specifying parameters.
59
+ */
60
+ RequestParameters?: Record<string, string>;
61
+ /**
62
+ * A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
63
+ */
64
+ RequestTemplates?: Record<string, string>;
65
+ /**
66
+ * Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
67
+ */
68
+ ResponseParameters?: Record<string, ResponseParameter[]>;
69
+ /**
70
+ * The template selection expression for the integration. Supported only for WebSocket APIs.
71
+ */
23
72
  TemplateSelectionExpression?: string;
73
+ /**
74
+ * Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
75
+ */
24
76
  TimeoutInMillis?: number;
77
+ /**
78
+ * The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
79
+ */
25
80
  TlsConfig?: TlsConfig;
26
81
  };
27
82
  /**
@@ -29,17 +84,31 @@ export type ApiGatewayV2IntegrationProperties = {
29
84
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#aws-resource-apigatewayv2-integration-return-values}
30
85
  */
31
86
  export type ApiGatewayV2IntegrationAttributes = {
32
- Id: string;
87
+ /**
88
+ * The integration ID.
89
+ */
90
+ IntegrationId: string;
91
+ };
92
+ /**
93
+ * Type definition for `AWS::ApiGatewayV2::Integration.ResponseParameter`.
94
+ * response parameter
95
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparameter.html}
96
+ */
97
+ export type ResponseParameter = {
98
+ Destination?: string;
99
+ Source?: string;
33
100
  };
34
101
  /**
35
102
  * Type definition for `AWS::ApiGatewayV2::Integration.TlsConfig`.
103
+ * The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs.
36
104
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html}
37
105
  */
38
106
  export type TlsConfig = {
39
107
  ServerNameToVerify?: string;
40
108
  };
41
109
  /**
42
- * Resource Type definition for AWS::ApiGatewayV2::Integration
110
+ * Resource type definition for `AWS::ApiGatewayV2::Integration`.
111
+ * An example resource schema demonstrating some basic constructs and validation rules.
43
112
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html}
44
113
  */
45
114
  export declare class ApiGatewayV2Integration extends $Resource<"AWS::ApiGatewayV2::Integration", ApiGatewayV2IntegrationProperties, ApiGatewayV2IntegrationAttributes> {
@@ -1,6 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::ApiGatewayV2::Integration
3
+ * Resource type definition for `AWS::ApiGatewayV2::Integration`.
4
+ * An example resource schema demonstrating some basic constructs and validation rules.
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html}
5
6
  */
6
7
  export class ApiGatewayV2Integration extends $Resource {
@@ -6,6 +6,10 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
6
6
  */
7
7
  export type EC2IPAMProperties = {
8
8
  Description?: string;
9
+ /**
10
+ * Enable provisioning of GUA space in private pools.
11
+ */
12
+ EnablePrivateGua?: boolean;
9
13
  /**
10
14
  * The regions IPAM is enabled for. Allows pools to be created in these regions, as well as enabling monitoring
11
15
  */
@@ -24,7 +24,7 @@ export type EC2NetworkAclAttributes = {
24
24
  };
25
25
  /**
26
26
  * Type definition for `AWS::EC2::NetworkAcl.Tag`.
27
- * Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).
27
+ * Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
28
28
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-networkacl-tag.html}
29
29
  */
30
30
  export type Tag = {
@@ -25,7 +25,7 @@ export type EC2RouteTableAttributes = {
25
25
  };
26
26
  /**
27
27
  * Type definition for `AWS::EC2::RouteTable.Tag`.
28
- * Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).
28
+ * Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
29
29
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-routetable-tag.html}
30
30
  */
31
31
  export type Tag = {
@@ -51,6 +51,14 @@ export type EC2VPCCidrBlockAttributes = {
51
51
  * The Id of the VPC associated CIDR Block.
52
52
  */
53
53
  Id: string;
54
+ /**
55
+ * The IP Source of an IPv6 VPC CIDR Block.
56
+ */
57
+ IpSource: string;
58
+ /**
59
+ * The value denoting whether an IPv6 VPC CIDR Block is public or private.
60
+ */
61
+ Ipv6AddressAttribute: string;
54
62
  };
55
63
  /**
56
64
  * Resource Type definition for AWS::EC2::VPCCidrBlock
@@ -85,6 +85,10 @@ export type LambdaFunctionProperties = {
85
85
  * The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.
86
86
  */
87
87
  PackageType?: "Image" | "Zip";
88
+ /**
89
+ * The function recursion configuration.
90
+ */
91
+ RecursiveLoop?: RecursiveLoop;
88
92
  /**
89
93
  * The number of simultaneous executions to reserve for the function.
90
94
  * @min `0`
@@ -290,6 +294,12 @@ export type LoggingConfig = {
290
294
  */
291
295
  SystemLogLevel?: "DEBUG" | "INFO" | "WARN";
292
296
  };
297
+ /**
298
+ * Type definition for `AWS::Lambda::Function.RecursiveLoop`.
299
+ * The function recursion configuration.
300
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-recursiveloop.html}
301
+ */
302
+ export type RecursiveLoop = "Allow" | "Terminate";
293
303
  /**
294
304
  * Type definition for `AWS::Lambda::Function.RuntimeManagementConfig`.
295
305
  * Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).
@@ -89,8 +89,9 @@ export type S3BucketProperties = {
89
89
  */
90
90
  Tags?: Tag[];
91
91
  /**
92
- * Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
93
- */
92
+ * Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them.
93
+ When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket.
94
+ */
94
95
  VersioningConfiguration?: VersioningConfiguration;
95
96
  /**
96
97
  * Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
@@ -302,6 +303,7 @@ export type Destination = {
302
303
  /**
303
304
  * Type definition for `AWS::S3::Bucket.EncryptionConfiguration`.
304
305
  * Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
306
+ If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
305
307
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-encryptionconfiguration.html}
306
308
  */
307
309
  export type EncryptionConfiguration = {
@@ -621,8 +623,10 @@ export type OwnershipControlsRule = {
621
623
  */
622
624
  export type PartitionedPrefix = {
623
625
  /**
624
- * Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.
625
- */
626
+ * Specifies the partition date source for the partitioned prefix. ``PartitionDateSource`` can be ``EventTime`` or ``DeliveryTime``.
627
+ For ``DeliveryTime``, the time in the log file names corresponds to the delivery time for the log files.
628
+ For ``EventTime``, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.
629
+ */
626
630
  PartitionDateSource?: "EventTime" | "DeliveryTime";
627
631
  };
628
632
  /**
@@ -1023,6 +1027,7 @@ export type S3KeyFilter = {
1023
1027
  /**
1024
1028
  * Type definition for `AWS::S3::Bucket.ServerSideEncryptionByDefault`.
1025
1029
  * Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*.
1030
+ If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
1026
1031
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html}
1027
1032
  */
1028
1033
  export type ServerSideEncryptionByDefault = {
@@ -1046,6 +1051,7 @@ export type ServerSideEncryptionByDefault = {
1046
1051
  /**
1047
1052
  * Type definition for `AWS::S3::Bucket.ServerSideEncryptionRule`.
1048
1053
  * Specifies the default server-side encryption configuration.
1054
+ If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
1049
1055
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionrule.html}
1050
1056
  */
1051
1057
  export type ServerSideEncryptionRule = {
@@ -1204,6 +1210,7 @@ export type Transition = {
1204
1210
  /**
1205
1211
  * Type definition for `AWS::S3::Bucket.VersioningConfiguration`.
1206
1212
  * Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.
1213
+ When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (``PUT`` or ``DELETE``) on objects in the bucket.
1207
1214
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-versioningconfiguration.html}
1208
1215
  */
1209
1216
  export type VersioningConfiguration = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.132",
3
+ "version": "0.1.134",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },