@awboost/cfn-resource-types 0.1.146 → 0.1.148

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, ResponseParameterMap>;
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,42 @@ 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;
100
+ };
101
+ /**
102
+ * Type definition for `AWS::ApiGatewayV2::Integration.ResponseParameterMap`.
103
+ * map of response parameter lists
104
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-responseparametermap.html}
105
+ */
106
+ export type ResponseParameterMap = {
107
+ /**
108
+ * list of response parameters
109
+ */
110
+ ResponseParameters?: ResponseParameter[];
33
111
  };
34
112
  /**
35
113
  * Type definition for `AWS::ApiGatewayV2::Integration.TlsConfig`.
114
+ * The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs.
36
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html}
37
116
  */
38
117
  export type TlsConfig = {
39
118
  ServerNameToVerify?: string;
40
119
  };
41
120
  /**
42
- * Resource Type definition for AWS::ApiGatewayV2::Integration
121
+ * Resource type definition for `AWS::ApiGatewayV2::Integration`.
122
+ * An example resource schema demonstrating some basic constructs and validation rules.
43
123
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html}
44
124
  */
45
125
  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 {
@@ -105,7 +105,7 @@ export type EC2VolumeAttributes = {
105
105
  };
106
106
  /**
107
107
  * Type definition for `AWS::EC2::Volume.Tag`.
108
- * 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).
108
+ * Specifies a tag. For more information, see [Resource tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
109
109
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-volume-tag.html}
110
110
  */
111
111
  export type Tag = {
@@ -149,7 +149,7 @@ export type NetworkAclEntry = {
149
149
  };
150
150
  /**
151
151
  * Protocol.
152
- * @pattern `^(tcp|udp|icmp|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$`
152
+ * @pattern `^(tcp|udp|icmp|-1|([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))$`
153
153
  */
154
154
  Protocol: string;
155
155
  /**
@@ -13,6 +13,7 @@ export type GlueJobProperties = {
13
13
  ExecutionClass?: string;
14
14
  ExecutionProperty?: ExecutionProperty;
15
15
  GlueVersion?: string;
16
+ JobMode?: string;
16
17
  LogUri?: string;
17
18
  MaintenanceWindow?: string;
18
19
  MaxCapacity?: number;
@@ -5,6 +5,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3express-directorybucket.html}
6
6
  */
7
7
  export type S3ExpressDirectoryBucketProperties = {
8
+ BucketEncryption?: any;
8
9
  /**
9
10
  * Specifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone. The bucket name must also follow the format 'bucket_base_name--az_id--x-s3' (for example, 'DOC-EXAMPLE-BUCKET--usw2-az1--x-s3'). If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
10
11
  * @maxLength `63`
@@ -29,6 +30,10 @@ export type S3ExpressDirectoryBucketAttributes = {
29
30
  * Returns the Amazon Resource Name (ARN) of the specified bucket.
30
31
  */
31
32
  Arn: string;
33
+ /**
34
+ * Returns the code for the Availability Zone where the directory bucket was created.
35
+ */
36
+ AvailabilityZoneName: string;
32
37
  };
33
38
  /**
34
39
  * Resource Type definition for AWS::S3Express::DirectoryBucket.
@@ -32,9 +32,13 @@ export type SyntheticsCanaryProperties = {
32
32
  FailureRetentionPeriod?: number;
33
33
  /**
34
34
  * Name of the canary.
35
- * @pattern `^[0-9a-z_\-]{1,21}$`
35
+ * @pattern `^[0-9a-z_\-]{1,255}$`
36
36
  */
37
37
  Name: string;
38
+ /**
39
+ * List of resources which canary tags should be replicated to.
40
+ */
41
+ ResourcesToReplicateTags?: ResourceToTag[];
38
42
  /**
39
43
  * Provide canary run configuration
40
44
  */
@@ -120,6 +124,12 @@ export type Code = {
120
124
  S3ObjectVersion?: string;
121
125
  Script?: string;
122
126
  };
127
+ /**
128
+ * Type definition for `AWS::Synthetics::Canary.ResourceToTag`.
129
+ * Specifies which resources canary tags should be replicated to.
130
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-resourcetotag.html}
131
+ */
132
+ export type ResourceToTag = "lambda-function";
123
133
  /**
124
134
  * Type definition for `AWS::Synthetics::Canary.RunConfig`.
125
135
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-runconfig.html}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.146",
3
+ "version": "0.1.148",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },