@awboost/cfn-resource-types 0.1.52 → 0.1.54
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-ARCZonalShift-ZonalAutoshiftConfiguration.d.ts +1 -1
- package/lib/AWS-Amplify-Domain.d.ts +12 -2
- package/lib/AWS-Bedrock-DataSource.d.ts +179 -0
- package/lib/AWS-Bedrock-DataSource.js +12 -0
- package/lib/AWS-Bedrock-KnowledgeBase.d.ts +316 -0
- package/lib/AWS-Bedrock-KnowledgeBase.js +12 -0
- package/lib/AWS-CloudWatch-Alarm.d.ts +103 -56
- package/lib/AWS-CloudWatch-Alarm.js +3 -1
- package/lib/AWS-CloudWatch-CompositeAlarm.d.ts +24 -0
- package/lib/AWS-DynamoDB-Table.d.ts +24 -3
- package/lib/AWS-DynamoDB-Table.js +1 -1
- package/lib/AWS-EC2-NatGateway.d.ts +4 -4
- package/lib/AWS-EC2-NatGateway.js +1 -1
- package/lib/AWS-EC2-SecurityGroup.d.ts +0 -1
- package/lib/AWS-EC2-SecurityGroupEgress.d.ts +9 -9
- package/lib/AWS-EC2-SecurityGroupEgress.js +2 -2
- package/lib/AWS-ECS-TaskDefinition.d.ts +146 -41
- package/lib/AWS-ECS-TaskDefinition.js +3 -1
- package/lib/AWS-ElasticLoadBalancingV2-Listener.d.ts +1 -0
- package/lib/AWS-ElasticLoadBalancingV2-LoadBalancer.d.ts +28 -4
- package/lib/AWS-IVS-EncoderConfiguration.d.ts +90 -0
- package/lib/AWS-IVS-EncoderConfiguration.js +12 -0
- package/lib/AWS-IVS-PlaybackRestrictionPolicy.d.ts +73 -0
- package/lib/AWS-IVS-PlaybackRestrictionPolicy.js +12 -0
- package/lib/AWS-IVS-StorageConfiguration.d.ts +76 -0
- package/lib/AWS-IVS-StorageConfiguration.js +12 -0
- package/lib/AWS-Route53-HostedZone.d.ts +4 -4
- package/lib/AWS-SSM-Parameter.d.ts +1 -1
- package/lib/AWS-SageMaker-AppImageConfig.d.ts +15 -0
- package/lib/AWS-SageMaker-Domain.d.ts +6 -0
- package/lib/AWS-SageMaker-UserProfile.d.ts +6 -0
- package/lib/AWS-SecurityHub-Insight.d.ts +35 -3
- package/lib/AWS-VerifiedPermissions-IdentitySource.d.ts +13 -0
- package/package.json +1 -1
|
@@ -1,7 +1,9 @@
|
|
|
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
|
-
*
|
|
4
|
+
* The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.
|
|
5
|
+
When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
|
|
6
|
+
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
|
|
5
7
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html}
|
|
6
8
|
*/
|
|
7
9
|
export type CloudWatchAlarmProperties = {
|
|
@@ -10,7 +12,7 @@ export type CloudWatchAlarmProperties = {
|
|
|
10
12
|
*/
|
|
11
13
|
ActionsEnabled?: boolean;
|
|
12
14
|
/**
|
|
13
|
-
* The list of actions to execute when this alarm transitions into an ALARM state from any other state.
|
|
15
|
+
* The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.
|
|
14
16
|
*/
|
|
15
17
|
AlarmActions?: string[];
|
|
16
18
|
/**
|
|
@@ -18,76 +20,93 @@ export type CloudWatchAlarmProperties = {
|
|
|
18
20
|
*/
|
|
19
21
|
AlarmDescription?: string;
|
|
20
22
|
/**
|
|
21
|
-
|
|
22
|
-
|
|
23
|
+
* The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name.
|
|
24
|
+
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
|
|
25
|
+
*/
|
|
23
26
|
AlarmName?: string;
|
|
24
27
|
/**
|
|
25
|
-
* The arithmetic operation to use when comparing the specified statistic and threshold.
|
|
28
|
+
* The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
|
|
26
29
|
*/
|
|
27
30
|
ComparisonOperator: string;
|
|
28
31
|
/**
|
|
29
|
-
|
|
30
|
-
|
|
32
|
+
* The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
|
|
33
|
+
If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.
|
|
34
|
+
*/
|
|
31
35
|
DatapointsToAlarm?: number;
|
|
32
36
|
/**
|
|
33
|
-
* The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions
|
|
37
|
+
* The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.
|
|
34
38
|
*/
|
|
35
39
|
Dimensions?: Dimension[];
|
|
36
40
|
/**
|
|
37
|
-
* Used only for alarms based on percentiles.
|
|
41
|
+
* Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
|
|
38
42
|
*/
|
|
39
43
|
EvaluateLowSampleCountPercentile?: string;
|
|
40
44
|
/**
|
|
41
|
-
|
|
42
|
-
|
|
45
|
+
* The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and ``DatapointsToAlarm`` is the M.
|
|
46
|
+
For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.
|
|
47
|
+
*/
|
|
43
48
|
EvaluationPeriods: number;
|
|
44
49
|
/**
|
|
45
|
-
|
|
46
|
-
|
|
50
|
+
* The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
|
|
51
|
+
For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
|
|
52
|
+
For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.
|
|
53
|
+
*/
|
|
47
54
|
ExtendedStatistic?: string;
|
|
48
55
|
/**
|
|
49
|
-
* The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
|
|
56
|
+
* The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
|
50
57
|
*/
|
|
51
58
|
InsufficientDataActions?: string[];
|
|
52
59
|
/**
|
|
53
|
-
* The name of the metric associated with the alarm.
|
|
60
|
+
* The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.
|
|
54
61
|
*/
|
|
55
62
|
MetricName?: string;
|
|
56
63
|
/**
|
|
57
|
-
|
|
58
|
-
|
|
64
|
+
* An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.
|
|
65
|
+
If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.
|
|
66
|
+
*/
|
|
59
67
|
Metrics?: MetricDataQuery[];
|
|
60
68
|
/**
|
|
61
|
-
|
|
62
|
-
|
|
69
|
+
* The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead.
|
|
70
|
+
For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)
|
|
71
|
+
*/
|
|
63
72
|
Namespace?: string;
|
|
64
73
|
/**
|
|
65
|
-
* The actions to execute when this alarm transitions to the OK state from any other state.
|
|
74
|
+
* The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).
|
|
66
75
|
*/
|
|
67
76
|
OKActions?: string[];
|
|
68
77
|
/**
|
|
69
|
-
|
|
70
|
-
|
|
78
|
+
* The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.
|
|
79
|
+
For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter.
|
|
80
|
+
*Minimum:* 10
|
|
81
|
+
*/
|
|
71
82
|
Period?: number;
|
|
72
83
|
/**
|
|
73
|
-
|
|
74
|
-
|
|
84
|
+
* The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``.
|
|
85
|
+
For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both.
|
|
86
|
+
For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.
|
|
87
|
+
*/
|
|
75
88
|
Statistic?: string;
|
|
76
89
|
/**
|
|
77
|
-
*
|
|
90
|
+
* @maxLength `50`
|
|
91
|
+
*/
|
|
92
|
+
Tags?: Tag[];
|
|
93
|
+
/**
|
|
94
|
+
* The value to compare with the specified statistic.
|
|
78
95
|
*/
|
|
79
96
|
Threshold?: number;
|
|
80
97
|
/**
|
|
81
|
-
* In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
|
|
98
|
+
* In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.
|
|
82
99
|
*/
|
|
83
100
|
ThresholdMetricId?: string;
|
|
84
101
|
/**
|
|
85
|
-
|
|
86
|
-
|
|
102
|
+
* Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*.
|
|
103
|
+
If you omit this parameter, the default behavior of ``missing`` is used.
|
|
104
|
+
*/
|
|
87
105
|
TreatMissingData?: string;
|
|
88
106
|
/**
|
|
89
|
-
|
|
90
|
-
|
|
107
|
+
* The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array.
|
|
108
|
+
You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
|
|
109
|
+
*/
|
|
91
110
|
Unit?: string;
|
|
92
111
|
};
|
|
93
112
|
/**
|
|
@@ -95,48 +114,46 @@ export type CloudWatchAlarmProperties = {
|
|
|
95
114
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html#aws-resource-cloudwatch-alarm-return-values}
|
|
96
115
|
*/
|
|
97
116
|
export type CloudWatchAlarmAttributes = {
|
|
98
|
-
/**
|
|
99
|
-
* Amazon Resource Name is a unique name for each resource.
|
|
100
|
-
*/
|
|
101
117
|
Arn: string;
|
|
102
118
|
};
|
|
103
119
|
/**
|
|
104
120
|
* Type definition for `AWS::CloudWatch::Alarm.Dimension`.
|
|
105
|
-
* Dimensions are
|
|
121
|
+
* Dimension is an embedded property of the ``AWS::CloudWatch::Alarm`` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.
|
|
106
122
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-dimension.html}
|
|
107
123
|
*/
|
|
108
124
|
export type Dimension = {
|
|
109
125
|
/**
|
|
110
|
-
* The name of the dimension.
|
|
126
|
+
* The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.
|
|
111
127
|
*/
|
|
112
128
|
Name: string;
|
|
113
129
|
/**
|
|
114
|
-
* The value for the dimension.
|
|
130
|
+
* The value for the dimension, from 1–255 characters in length.
|
|
115
131
|
*/
|
|
116
132
|
Value: string;
|
|
117
133
|
};
|
|
118
134
|
/**
|
|
119
135
|
* Type definition for `AWS::CloudWatch::Alarm.Metric`.
|
|
120
|
-
* The Metric property type represents a specific metric.
|
|
136
|
+
* The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.
|
|
121
137
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metric.html}
|
|
122
138
|
*/
|
|
123
139
|
export type Metric = {
|
|
124
140
|
/**
|
|
125
|
-
* The dimensions for the metric.
|
|
141
|
+
* The metric dimensions that you want to be used for the metric that the alarm will watch.
|
|
126
142
|
*/
|
|
127
143
|
Dimensions?: Dimension[];
|
|
128
144
|
/**
|
|
129
|
-
* The name of the metric.
|
|
145
|
+
* The name of the metric that you want the alarm to watch. This is a required field.
|
|
130
146
|
*/
|
|
131
147
|
MetricName?: string;
|
|
132
148
|
/**
|
|
133
|
-
* The namespace of the metric.
|
|
149
|
+
* The namespace of the metric that the alarm will watch.
|
|
134
150
|
*/
|
|
135
151
|
Namespace?: string;
|
|
136
152
|
};
|
|
137
153
|
/**
|
|
138
154
|
* Type definition for `AWS::CloudWatch::Alarm.MetricDataQuery`.
|
|
139
|
-
*
|
|
155
|
+
* The ``MetricDataQuery`` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data.
|
|
156
|
+
Any expression used must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.
|
|
140
157
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html}
|
|
141
158
|
*/
|
|
142
159
|
export type MetricDataQuery = {
|
|
@@ -145,33 +162,38 @@ export type MetricDataQuery = {
|
|
|
145
162
|
*/
|
|
146
163
|
AccountId?: string;
|
|
147
164
|
/**
|
|
148
|
-
|
|
149
|
-
|
|
165
|
+
* The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*.
|
|
166
|
+
Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.
|
|
167
|
+
*/
|
|
150
168
|
Expression?: string;
|
|
151
169
|
/**
|
|
152
|
-
* A short name used to tie this object to the results in the response.
|
|
170
|
+
* A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
|
|
153
171
|
*/
|
|
154
172
|
Id: string;
|
|
155
173
|
/**
|
|
156
|
-
* A human-readable label for this metric or expression.
|
|
174
|
+
* A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default.
|
|
157
175
|
*/
|
|
158
176
|
Label?: string;
|
|
159
177
|
/**
|
|
160
|
-
|
|
161
|
-
|
|
178
|
+
* The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
|
|
179
|
+
Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.
|
|
180
|
+
*/
|
|
162
181
|
MetricStat?: MetricStat;
|
|
163
182
|
/**
|
|
164
|
-
* The
|
|
183
|
+
* The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``.
|
|
165
184
|
*/
|
|
166
185
|
Period?: number;
|
|
167
186
|
/**
|
|
168
|
-
|
|
169
|
-
|
|
187
|
+
* This option indicates whether to return the timestamps and raw data values of this metric.
|
|
188
|
+
When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm.
|
|
189
|
+
This field is required.
|
|
190
|
+
*/
|
|
170
191
|
ReturnData?: boolean;
|
|
171
192
|
};
|
|
172
193
|
/**
|
|
173
194
|
* Type definition for `AWS::CloudWatch::Alarm.MetricStat`.
|
|
174
195
|
* This structure defines the metric to be returned, along with the statistics, period, and units.
|
|
196
|
+
``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.
|
|
175
197
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html}
|
|
176
198
|
*/
|
|
177
199
|
export type MetricStat = {
|
|
@@ -180,20 +202,45 @@ export type MetricStat = {
|
|
|
180
202
|
*/
|
|
181
203
|
Metric: Metric;
|
|
182
204
|
/**
|
|
183
|
-
|
|
184
|
-
|
|
205
|
+
* The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.
|
|
206
|
+
If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
|
|
207
|
+
+ Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
|
|
208
|
+
+ Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
|
|
209
|
+
+ Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
|
|
210
|
+
*/
|
|
185
211
|
Period: number;
|
|
186
212
|
/**
|
|
187
|
-
* The statistic to return.
|
|
213
|
+
* The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.
|
|
188
214
|
*/
|
|
189
215
|
Stat: string;
|
|
190
216
|
/**
|
|
191
|
-
|
|
192
|
-
|
|
217
|
+
* The unit to use for the returned data points.
|
|
218
|
+
Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
|
|
219
|
+
*/
|
|
193
220
|
Unit?: string;
|
|
194
221
|
};
|
|
195
222
|
/**
|
|
196
|
-
*
|
|
223
|
+
* Type definition for `AWS::CloudWatch::Alarm.Tag`.
|
|
224
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-tag.html}
|
|
225
|
+
*/
|
|
226
|
+
export type Tag = {
|
|
227
|
+
/**
|
|
228
|
+
* A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.
|
|
229
|
+
* @minLength `1`
|
|
230
|
+
* @maxLength `128`
|
|
231
|
+
*/
|
|
232
|
+
Key: string;
|
|
233
|
+
/**
|
|
234
|
+
* The value for the specified tag key.
|
|
235
|
+
* @minLength `1`
|
|
236
|
+
* @maxLength `256`
|
|
237
|
+
*/
|
|
238
|
+
Value: string;
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.
|
|
242
|
+
When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
|
|
243
|
+
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
|
|
197
244
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html}
|
|
198
245
|
*/
|
|
199
246
|
export declare class CloudWatchAlarm extends $Resource<"AWS::CloudWatch::Alarm", CloudWatchAlarmProperties, CloudWatchAlarmAttributes> {
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The ``AWS::CloudWatch::Alarm`` type specifies an alarm and associates it with the specified metric or metric math expression.
|
|
4
|
+
When this operation creates an alarm, the alarm state is immediately set to ``INSUFFICIENT_DATA``. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.
|
|
5
|
+
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
|
|
4
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html}
|
|
5
7
|
*/
|
|
6
8
|
export class CloudWatchAlarm extends $Resource {
|
|
@@ -58,6 +58,11 @@ export type CloudWatchCompositeAlarmProperties = {
|
|
|
58
58
|
* @maxLength `5`
|
|
59
59
|
*/
|
|
60
60
|
OKActions?: string[];
|
|
61
|
+
/**
|
|
62
|
+
* A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.
|
|
63
|
+
* @maxLength `50`
|
|
64
|
+
*/
|
|
65
|
+
Tags?: Tag[];
|
|
61
66
|
};
|
|
62
67
|
/**
|
|
63
68
|
* Attribute type definition for `AWS::CloudWatch::CompositeAlarm`.
|
|
@@ -71,6 +76,25 @@ export type CloudWatchCompositeAlarmAttributes = {
|
|
|
71
76
|
*/
|
|
72
77
|
Arn: string;
|
|
73
78
|
};
|
|
79
|
+
/**
|
|
80
|
+
* Type definition for `AWS::CloudWatch::CompositeAlarm.Tag`.
|
|
81
|
+
* Metadata that you can assign to a composite alarm, Tags can help you organize and categorize your resources.
|
|
82
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-compositealarm-tag.html}
|
|
83
|
+
*/
|
|
84
|
+
export type Tag = {
|
|
85
|
+
/**
|
|
86
|
+
* A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.
|
|
87
|
+
* @minLength `1`
|
|
88
|
+
* @maxLength `128`
|
|
89
|
+
*/
|
|
90
|
+
Key: string;
|
|
91
|
+
/**
|
|
92
|
+
* The value for the specified tag key.
|
|
93
|
+
* @minLength `1`
|
|
94
|
+
* @maxLength `256`
|
|
95
|
+
*/
|
|
96
|
+
Value: string;
|
|
97
|
+
};
|
|
74
98
|
/**
|
|
75
99
|
* The AWS::CloudWatch::CompositeAlarm type specifies an alarm which aggregates the states of other Alarms (Metric or Composite Alarms) as defined by the AlarmRule expression
|
|
76
100
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html}
|
|
@@ -3,7 +3,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
3
3
|
/**
|
|
4
4
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
5
5
|
You should be aware of the following behaviors when working with DDB tables:
|
|
6
|
-
+
|
|
6
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).
|
|
7
7
|
|
|
8
8
|
Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -67,6 +67,10 @@ export type DynamoDBTableProperties = {
|
|
|
67
67
|
If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property.
|
|
68
68
|
*/
|
|
69
69
|
ProvisionedThroughput?: ProvisionedThroughput;
|
|
70
|
+
/**
|
|
71
|
+
* A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
|
|
72
|
+
When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
|
|
73
|
+
*/
|
|
70
74
|
ResourcePolicy?: ResourcePolicy;
|
|
71
75
|
/**
|
|
72
76
|
* Specifies the settings to enable server-side encryption.
|
|
@@ -328,9 +332,22 @@ export type ProvisionedThroughput = {
|
|
|
328
332
|
};
|
|
329
333
|
/**
|
|
330
334
|
* Type definition for `AWS::DynamoDB::Table.ResourcePolicy`.
|
|
335
|
+
* Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.
|
|
336
|
+
In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
|
|
337
|
+
While defining resource-based policies in your CFNshort templates, the following considerations apply:
|
|
338
|
+
+ The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit.
|
|
339
|
+
+ Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes.
|
|
340
|
+
+ Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template.
|
|
341
|
+
For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template.
|
|
342
|
+
Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template.
|
|
343
|
+
|
|
344
|
+
For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
|
|
331
345
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html}
|
|
332
346
|
*/
|
|
333
347
|
export type ResourcePolicy = {
|
|
348
|
+
/**
|
|
349
|
+
* A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
|
|
350
|
+
*/
|
|
334
351
|
PolicyDocument: Record<string, any>;
|
|
335
352
|
};
|
|
336
353
|
/**
|
|
@@ -378,6 +395,10 @@ export type SSESpecification = {
|
|
|
378
395
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-streamspecification.html}
|
|
379
396
|
*/
|
|
380
397
|
export type StreamSpecification = {
|
|
398
|
+
/**
|
|
399
|
+
* Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource.
|
|
400
|
+
In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
|
|
401
|
+
*/
|
|
381
402
|
ResourcePolicy?: ResourcePolicy;
|
|
382
403
|
/**
|
|
383
404
|
* When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are:
|
|
@@ -413,7 +434,7 @@ export type Tag = {
|
|
|
413
434
|
export type TimeToLiveSpecification = {
|
|
414
435
|
/**
|
|
415
436
|
* The name of the TTL attribute used to store the expiration time for items in the table.
|
|
416
|
-
+
|
|
437
|
+
+ The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled.
|
|
417
438
|
+ To update this property, you must first disable TTL and then enable TTL with the new attribute name.
|
|
418
439
|
*/
|
|
419
440
|
AttributeName?: string;
|
|
@@ -425,7 +446,7 @@ export type TimeToLiveSpecification = {
|
|
|
425
446
|
/**
|
|
426
447
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
427
448
|
You should be aware of the following behaviors when working with DDB tables:
|
|
428
|
-
+
|
|
449
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).
|
|
429
450
|
|
|
430
451
|
Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
431
452
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -2,7 +2,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
2
2
|
/**
|
|
3
3
|
* The ``AWS::DynamoDB::Table`` resource creates a DDB table. For more information, see [CreateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) in the *API Reference*.
|
|
4
4
|
You should be aware of the following behaviors when working with DDB tables:
|
|
5
|
-
+
|
|
5
|
+
+ CFNlong typically creates DDB tables in parallel. However, if your template includes multiple DDB tables with indexes, you must declare dependencies so that the tables are created sequentially. DDBlong limits the number of tables with secondary indexes that are in the creating state. If you create multiple tables with indexes at the same time, DDB returns an error and the stack operation fails. For an example, see [DynamoDB Table with a DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#aws-resource-dynamodb-table--examples--DynamoDB_Table_with_a_DependsOn_Attribute).
|
|
6
6
|
|
|
7
7
|
Our guidance is to use the latest schema documented here for your CFNlong templates. This schema supports the provisioning of all table settings below. When using this schema in your CFNlong templates, please ensure that your Identity and Access Management (IAM) policies are updated with appropriate permissions to allow for the authorization of these setting changes.
|
|
8
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html}
|
|
@@ -5,7 +5,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
5
|
* Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
|
|
6
6
|
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
|
|
7
7
|
If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.
|
|
8
|
-
|
|
8
|
+
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html}
|
|
10
10
|
*/
|
|
11
11
|
export type EC2NatGatewayProperties = {
|
|
@@ -31,13 +31,13 @@ export type EC2NatGatewayProperties = {
|
|
|
31
31
|
SecondaryAllocationIds?: string[];
|
|
32
32
|
/**
|
|
33
33
|
* [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
|
|
34
|
-
|
|
34
|
+
``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
|
|
35
35
|
* @min `1`
|
|
36
36
|
*/
|
|
37
37
|
SecondaryPrivateIpAddressCount?: number;
|
|
38
38
|
/**
|
|
39
39
|
* Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-creating) in the *Amazon Virtual Private Cloud User Guide*.
|
|
40
|
-
|
|
40
|
+
``SecondaryPrivateIpAddressCount`` and ``SecondaryPrivateIpAddresses`` cannot be set at the same time.
|
|
41
41
|
*/
|
|
42
42
|
SecondaryPrivateIpAddresses?: string[];
|
|
43
43
|
/**
|
|
@@ -76,7 +76,7 @@ export type Tag = {
|
|
|
76
76
|
* Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
|
|
77
77
|
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
|
|
78
78
|
If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.
|
|
79
|
-
|
|
79
|
+
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
|
|
80
80
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html}
|
|
81
81
|
*/
|
|
82
82
|
export declare class EC2NatGateway extends $Resource<"AWS::EC2::NatGateway", EC2NatGatewayProperties, EC2NatGatewayAttributes> {
|
|
@@ -4,7 +4,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
4
4
|
* Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.
|
|
5
5
|
With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*.
|
|
6
6
|
If you add a default route (``AWS::EC2::Route`` resource) that points to a NAT gateway, specify the NAT gateway ID for the route's ``NatGatewayId`` property.
|
|
7
|
-
|
|
7
|
+
When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#allocate-eip) in the *Amazon VPC User Guide*.
|
|
8
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html}
|
|
9
9
|
*/
|
|
10
10
|
export class EC2NatGateway extends $Resource {
|
|
@@ -4,21 +4,21 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
4
4
|
* Resource type definition for `AWS::EC2::SecurityGroupEgress`.
|
|
5
5
|
* Adds the specified outbound (egress) rule to a security group.
|
|
6
6
|
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
|
|
7
|
-
You must specify exactly one of the following destinations: an IPv4
|
|
7
|
+
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
|
|
8
8
|
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
|
|
9
|
-
Rule changes are propagated to instances associated with the security group as quickly as possible
|
|
9
|
+
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
|
|
10
10
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html}
|
|
11
11
|
*/
|
|
12
12
|
export type EC2SecurityGroupEgressProperties = {
|
|
13
13
|
/**
|
|
14
14
|
* The IPv4 address range, in CIDR format.
|
|
15
|
-
You must specify
|
|
15
|
+
You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
|
|
16
16
|
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
|
|
17
17
|
*/
|
|
18
18
|
CidrIp?: string;
|
|
19
19
|
/**
|
|
20
20
|
* The IPv6 address range, in CIDR format.
|
|
21
|
-
You must specify
|
|
21
|
+
You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
|
|
22
22
|
For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *User Guide*.
|
|
23
23
|
*/
|
|
24
24
|
CidrIpv6?: string;
|
|
@@ -28,13 +28,13 @@ export type EC2SecurityGroupEgressProperties = {
|
|
|
28
28
|
*/
|
|
29
29
|
Description?: string;
|
|
30
30
|
/**
|
|
31
|
-
* The prefix list IDs for an AWS service. This is the AWS service
|
|
32
|
-
You must specify
|
|
31
|
+
* The prefix list IDs for an AWS service. This is the AWS service to access through a VPC endpoint from instances associated with the security group.
|
|
32
|
+
You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
|
|
33
33
|
*/
|
|
34
34
|
DestinationPrefixListId?: string;
|
|
35
35
|
/**
|
|
36
36
|
* The ID of the security group.
|
|
37
|
-
You must specify
|
|
37
|
+
You must specify exactly one of the following: ``CidrIp``, ``CidrIpv6``, ``DestinationPrefixListId``, or ``DestinationSecurityGroupId``.
|
|
38
38
|
*/
|
|
39
39
|
DestinationSecurityGroupId?: string;
|
|
40
40
|
/**
|
|
@@ -66,9 +66,9 @@ export type EC2SecurityGroupEgressAttributes = {
|
|
|
66
66
|
* Resource type definition for `AWS::EC2::SecurityGroupEgress`.
|
|
67
67
|
* Adds the specified outbound (egress) rule to a security group.
|
|
68
68
|
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
|
|
69
|
-
You must specify exactly one of the following destinations: an IPv4
|
|
69
|
+
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
|
|
70
70
|
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
|
|
71
|
-
Rule changes are propagated to instances associated with the security group as quickly as possible
|
|
71
|
+
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
|
|
72
72
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html}
|
|
73
73
|
*/
|
|
74
74
|
export declare class EC2SecurityGroupEgress extends $Resource<"AWS::EC2::SecurityGroupEgress", EC2SecurityGroupEgressProperties, EC2SecurityGroupEgressAttributes> {
|
|
@@ -3,9 +3,9 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
3
3
|
* Resource type definition for `AWS::EC2::SecurityGroupEgress`.
|
|
4
4
|
* Adds the specified outbound (egress) rule to a security group.
|
|
5
5
|
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address range, the IP addresses that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html).
|
|
6
|
-
You must specify exactly one of the following destinations: an IPv4
|
|
6
|
+
You must specify exactly one of the following destinations: an IPv4 address range, an IPv6 address range, a prefix list, or a security group.
|
|
7
7
|
You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. To specify all types or all codes, use -1.
|
|
8
|
-
Rule changes are propagated to instances associated with the security group as quickly as possible
|
|
8
|
+
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
|
|
9
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-securitygroupegress.html}
|
|
10
10
|
*/
|
|
11
11
|
export class EC2SecurityGroupEgress extends $Resource {
|