@propulsionworks/cloudformation 0.1.32 → 0.1.34
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/out/exports/resources.generated/aws-amazonmq-broker.d.ts +42 -53
- package/out/exports/resources.generated/aws-amazonmq-configuration.d.ts +5 -11
- package/out/exports/resources.generated/aws-amazonmq-configurationassociation.d.ts +6 -10
- package/out/exports/resources.generated/aws-appstream-fleet.d.ts +0 -4
- package/out/exports/resources.generated/aws-appstream-imagebuilder.d.ts +0 -4
- package/out/exports/resources.generated/aws-aps-anomalydetector.d.ts +34 -12
- package/out/exports/resources.generated/aws-batch-jobdefinition.d.ts +17 -0
- package/out/exports/resources.generated/aws-bedrock-automatedreasoningpolicy.d.ts +15 -0
- package/out/exports/resources.generated/aws-bedrockagentcore-browsercustom.d.ts +16 -0
- package/out/exports/resources.generated/aws-bedrockagentcore-runtime.d.ts +104 -1
- package/out/exports/resources.generated/aws-bedrockagentcore-workloadidentity.d.ts +61 -0
- package/out/exports/resources.generated/aws-billingconductor-customlineitem.d.ts +14 -0
- package/out/exports/resources.generated/aws-cassandra-keyspace.d.ts +1 -1
- package/out/exports/resources.generated/aws-ce-anomalymonitor.d.ts +1 -1
- package/out/exports/resources.generated/aws-cleanrooms-collaboration.d.ts +9 -0
- package/out/exports/resources.generated/aws-cleanrooms-configuredtable.d.ts +15 -1
- package/out/exports/resources.generated/aws-cleanrooms-privacybudgettemplate.d.ts +30 -3
- package/out/exports/resources.generated/aws-cloudfront-anycastiplist.d.ts +1 -0
- package/out/exports/resources.generated/aws-cloudfront-distribution.d.ts +1 -0
- package/out/exports/resources.generated/aws-cloudfront-vpcorigin.d.ts +1 -0
- package/out/exports/resources.generated/aws-codebuild-fleet.d.ts +2 -2
- package/out/exports/resources.generated/aws-connect-emailaddress.d.ts +2 -2
- package/out/exports/resources.generated/aws-connectcampaignsv2-campaign.d.ts +73 -0
- package/out/exports/resources.generated/aws-datazone-connection.d.ts +70 -4
- package/out/exports/resources.generated/aws-datazone-domain.d.ts +1 -1
- package/out/exports/resources.generated/aws-datazone-environmentblueprintconfiguration.d.ts +2 -2
- package/out/exports/resources.generated/aws-dynamodb-globaltable.d.ts +10 -0
- package/out/exports/resources.generated/aws-ec2-capacitymanagerdataexport.d.ts +8 -6
- package/out/exports/resources.generated/aws-ec2-natgateway.d.ts +1 -0
- package/out/exports/resources.generated/aws-ec2-volume.d.ts +532 -0
- package/out/exports/resources.generated/aws-ecs-capacityprovider.d.ts +1 -1
- package/out/exports/resources.generated/aws-ecs-cluster.d.ts +5 -5
- package/out/exports/resources.generated/aws-ecs-clustercapacityproviderassociations.d.ts +5 -5
- package/out/exports/resources.generated/aws-ecs-service.d.ts +95 -7
- package/out/exports/resources.generated/aws-ecs-taskdefinition.d.ts +4 -4
- package/out/exports/resources.generated/aws-ecs-taskset.d.ts +5 -5
- package/out/exports/resources.generated/aws-elasticloadbalancingv2-listenerrule.d.ts +4 -0
- package/out/exports/resources.generated/aws-events-apidestination.d.ts +1 -1
- package/out/exports/resources.generated/aws-events-connection.d.ts +1 -1
- package/out/exports/resources.generated/aws-events-eventbuspolicy.d.ts +5 -13
- package/out/exports/resources.generated/aws-gamelift-build.d.ts +1 -1
- package/out/exports/resources.generated/aws-glue-integrationresourceproperty.d.ts +74 -0
- package/out/exports/resources.generated/aws-guardduty-trustedentityset.d.ts +4 -4
- package/out/exports/resources.generated/aws-iam-policy.d.ts +2 -2
- package/out/exports/resources.generated/aws-imagebuilder-containerrecipe.d.ts +1 -1
- package/out/exports/resources.generated/aws-imagebuilder-image.d.ts +35 -4
- package/out/exports/resources.generated/aws-imagebuilder-imagerecipe.d.ts +1 -1
- package/out/exports/resources.generated/aws-kendra-datasource.d.ts +19 -19
- package/out/exports/resources.generated/aws-kinesis-stream.d.ts +7 -0
- package/out/exports/resources.generated/aws-kms-key.d.ts +1 -1
- package/out/exports/resources.generated/aws-lambda-eventinvokeconfig.d.ts +4 -0
- package/out/exports/resources.generated/aws-lambda-eventsourcemapping.d.ts +2 -0
- package/out/exports/resources.generated/aws-lambda-permission.d.ts +1 -1
- package/out/exports/resources.generated/aws-location-apikey.d.ts +39 -0
- package/out/exports/resources.generated/aws-mediapackagev2-originendpoint.d.ts +3 -1
- package/out/exports/resources.generated/aws-networkfirewall-firewall.d.ts +8 -0
- package/out/exports/resources.generated/aws-networkfirewall-firewallpolicy.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkfirewall-rulegroup.d.ts +1 -1
- package/out/exports/resources.generated/aws-networkmanager-connectattachment.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkmanager-directconnectgatewayattachment.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkmanager-sitetositevpnattachment.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkmanager-transitgatewaypeering.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkmanager-transitgatewayroutetableattachment.d.ts +5 -0
- package/out/exports/resources.generated/aws-networkmanager-vpcattachment.d.ts +5 -0
- package/out/exports/resources.generated/aws-opensearchserverless-collection.d.ts +5 -0
- package/out/exports/resources.generated/aws-organizations-account.d.ts +3 -1
- package/out/exports/resources.generated/aws-osis-pipeline.d.ts +1 -1
- package/out/exports/resources.generated/aws-qbusiness-application.d.ts +3 -3
- package/out/exports/resources.generated/aws-quicksight-analysis.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-dashboard.d.ts +9 -2
- package/out/exports/resources.generated/aws-quicksight-dataset.d.ts +987 -27
- package/out/exports/resources.generated/aws-quicksight-datasource.d.ts +1 -1
- package/out/exports/resources.generated/aws-quicksight-template.d.ts +1 -1
- package/out/exports/resources.generated/aws-rtbfabric-link.d.ts +179 -0
- package/out/exports/resources.generated/aws-rtbfabric-requestergateway.d.ts +7 -0
- package/out/exports/resources.generated/aws-rtbfabric-respondergateway.d.ts +29 -0
- package/out/exports/resources.generated/aws-s3-bucket.d.ts +6 -2
- package/out/exports/resources.generated/aws-s3vectors-index.d.ts +141 -0
- package/out/exports/resources.generated/aws-s3vectors-vectorbucket.d.ts +124 -0
- package/out/exports/resources.generated/aws-s3vectors-vectorbucketpolicy.d.ts +105 -0
- package/out/exports/resources.generated/aws-sagemaker-notebookinstance.d.ts +1 -1
- package/out/exports/resources.generated/aws-sagemaker-processingjob.d.ts +1 -1
- package/out/exports/resources.generated/aws-sagemaker-userprofile.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-aggregatorv2.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-automationrulev2.d.ts +2 -2
- package/out/exports/resources.generated/aws-securityhub-hubv2.d.ts +2 -2
- package/out/exports/resources.generated/aws-servicecatalog-cloudformationproduct.d.ts +16 -15
- package/out/exports/resources.generated/aws-servicecatalog-portfolioprincipalassociation.d.ts +5 -13
- package/out/exports/resources.generated/aws-ses-multiregionendpoint.d.ts +48 -0
- package/out/exports/resources.generated/aws-transfer-connector.d.ts +58 -1
- package/out/exports/resources.generated/aws-wafv2-webacl.d.ts +32 -0
- package/package.json +1 -1
|
@@ -55,6 +55,141 @@ export type EC2VolumeProps = {
|
|
|
55
55
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone}
|
|
56
56
|
*/
|
|
57
57
|
AvailabilityZone: string;
|
|
58
|
+
/**
|
|
59
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid}
|
|
60
|
+
*/
|
|
61
|
+
AvailabilityZoneId?: string | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
|
|
64
|
+
*
|
|
65
|
+
* Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .
|
|
66
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted}
|
|
67
|
+
*/
|
|
68
|
+
Encrypted?: boolean | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* The number of I/O operations per second (IOPS) to provision for the volume. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types.
|
|
71
|
+
*
|
|
72
|
+
* Valid ranges:
|
|
73
|
+
*
|
|
74
|
+
* - gp3: `3,000` ( *default* ) `- 80,000` IOPS
|
|
75
|
+
* - io1: `100 - 64,000` IOPS
|
|
76
|
+
* - io2: `100 - 256,000` IOPS
|
|
77
|
+
*
|
|
78
|
+
* > [Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
|
|
79
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops}
|
|
80
|
+
*/
|
|
81
|
+
Iops?: number | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* The identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true` .
|
|
84
|
+
*
|
|
85
|
+
* If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to `true` , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
|
|
86
|
+
*
|
|
87
|
+
* Alternatively, if you want to specify a different key, you can specify one of the following:
|
|
88
|
+
*
|
|
89
|
+
* - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
90
|
+
* - Key alias. Specify the alias for the key, prefixed with `alias/` . For example, for a key with the alias `my_cmk` , use `alias/my_cmk` . Or to specify the AWS managed key , use `alias/aws/ebs` .
|
|
91
|
+
* - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
92
|
+
* - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
|
|
93
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid}
|
|
94
|
+
*/
|
|
95
|
+
KmsKeyId?: string | undefined;
|
|
96
|
+
/**
|
|
97
|
+
* Indicates whether Amazon EBS Multi-Attach is enabled.
|
|
98
|
+
*
|
|
99
|
+
* AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
|
|
100
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled}
|
|
101
|
+
*/
|
|
102
|
+
MultiAttachEnabled?: boolean | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* The Amazon Resource Name (ARN) of the Outpost.
|
|
105
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn}
|
|
106
|
+
*/
|
|
107
|
+
OutpostArn?: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size, and you can specify a volume size that is equal to or larger than the snapshot size.
|
|
110
|
+
*
|
|
111
|
+
* Valid sizes:
|
|
112
|
+
*
|
|
113
|
+
* - gp2: `1 - 16,384` GiB
|
|
114
|
+
* - gp3: `1 - 65,536` GiB
|
|
115
|
+
* - io1: `4 - 16,384` GiB
|
|
116
|
+
* - io2: `4 - 65,536` GiB
|
|
117
|
+
* - st1 and sc1: `125 - 16,384` GiB
|
|
118
|
+
* - standard: `1 - 1024` GiB
|
|
119
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size}
|
|
120
|
+
*/
|
|
121
|
+
Size: number;
|
|
122
|
+
/**
|
|
123
|
+
* The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
|
|
124
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid}
|
|
125
|
+
*/
|
|
126
|
+
SnapshotId?: string | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid}
|
|
129
|
+
*/
|
|
130
|
+
SourceVolumeId?: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* The tags to apply to the volume during creation.
|
|
133
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags}
|
|
134
|
+
*/
|
|
135
|
+
Tags?: Tag[] | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
|
|
138
|
+
*
|
|
139
|
+
* This parameter is valid only for `gp3` volumes. The default value is 125.
|
|
140
|
+
*
|
|
141
|
+
* Valid Range: Minimum value of 125. Maximum value of 1000.
|
|
142
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput}
|
|
143
|
+
*/
|
|
144
|
+
Throughput?: number | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
|
|
147
|
+
*
|
|
148
|
+
* This parameter is supported only for volumes created from snapshots. Omit this parameter if:
|
|
149
|
+
*
|
|
150
|
+
* - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
|
|
151
|
+
*
|
|
152
|
+
* > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
|
|
153
|
+
* - You want to create a volume that is initialized at the default rate.
|
|
154
|
+
*
|
|
155
|
+
* For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* .
|
|
156
|
+
*
|
|
157
|
+
* Valid range: 100 - 300 MiB/s
|
|
158
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate}
|
|
159
|
+
*/
|
|
160
|
+
VolumeInitializationRate?: number | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* The volume type. This parameter can be one of the following values:
|
|
163
|
+
*
|
|
164
|
+
* - General Purpose SSD: `gp2` | `gp3`
|
|
165
|
+
* - Provisioned IOPS SSD: `io1` | `io2`
|
|
166
|
+
* - Throughput Optimized HDD: `st1`
|
|
167
|
+
* - Cold HDD: `sc1`
|
|
168
|
+
* - Magnetic: `standard`
|
|
169
|
+
*
|
|
170
|
+
* For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) .
|
|
171
|
+
*
|
|
172
|
+
* Default: `gp2`
|
|
173
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype}
|
|
174
|
+
*/
|
|
175
|
+
VolumeType?: string | undefined;
|
|
176
|
+
} | {
|
|
177
|
+
/**
|
|
178
|
+
* Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
|
|
179
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio}
|
|
180
|
+
*/
|
|
181
|
+
AutoEnableIO?: boolean | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* The ID of the Availability Zone in which to create the volume. For example, `us-east-1a` .
|
|
184
|
+
*
|
|
185
|
+
* Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.
|
|
186
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone}
|
|
187
|
+
*/
|
|
188
|
+
AvailabilityZone: string;
|
|
189
|
+
/**
|
|
190
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid}
|
|
191
|
+
*/
|
|
192
|
+
AvailabilityZoneId?: string | undefined;
|
|
58
193
|
/**
|
|
59
194
|
* Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
|
|
60
195
|
*
|
|
@@ -115,11 +250,408 @@ export type EC2VolumeProps = {
|
|
|
115
250
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size}
|
|
116
251
|
*/
|
|
117
252
|
Size?: number | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
|
|
255
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid}
|
|
256
|
+
*/
|
|
257
|
+
SnapshotId: string;
|
|
258
|
+
/**
|
|
259
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid}
|
|
260
|
+
*/
|
|
261
|
+
SourceVolumeId?: string | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* The tags to apply to the volume during creation.
|
|
264
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags}
|
|
265
|
+
*/
|
|
266
|
+
Tags?: Tag[] | undefined;
|
|
267
|
+
/**
|
|
268
|
+
* The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
|
|
269
|
+
*
|
|
270
|
+
* This parameter is valid only for `gp3` volumes. The default value is 125.
|
|
271
|
+
*
|
|
272
|
+
* Valid Range: Minimum value of 125. Maximum value of 1000.
|
|
273
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput}
|
|
274
|
+
*/
|
|
275
|
+
Throughput?: number | undefined;
|
|
276
|
+
/**
|
|
277
|
+
* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
|
|
278
|
+
*
|
|
279
|
+
* This parameter is supported only for volumes created from snapshots. Omit this parameter if:
|
|
280
|
+
*
|
|
281
|
+
* - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
|
|
282
|
+
*
|
|
283
|
+
* > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
|
|
284
|
+
* - You want to create a volume that is initialized at the default rate.
|
|
285
|
+
*
|
|
286
|
+
* For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* .
|
|
287
|
+
*
|
|
288
|
+
* Valid range: 100 - 300 MiB/s
|
|
289
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate}
|
|
290
|
+
*/
|
|
291
|
+
VolumeInitializationRate?: number | undefined;
|
|
292
|
+
/**
|
|
293
|
+
* The volume type. This parameter can be one of the following values:
|
|
294
|
+
*
|
|
295
|
+
* - General Purpose SSD: `gp2` | `gp3`
|
|
296
|
+
* - Provisioned IOPS SSD: `io1` | `io2`
|
|
297
|
+
* - Throughput Optimized HDD: `st1`
|
|
298
|
+
* - Cold HDD: `sc1`
|
|
299
|
+
* - Magnetic: `standard`
|
|
300
|
+
*
|
|
301
|
+
* For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) .
|
|
302
|
+
*
|
|
303
|
+
* Default: `gp2`
|
|
304
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype}
|
|
305
|
+
*/
|
|
306
|
+
VolumeType?: string | undefined;
|
|
307
|
+
} | {
|
|
308
|
+
/**
|
|
309
|
+
* Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
|
|
310
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio}
|
|
311
|
+
*/
|
|
312
|
+
AutoEnableIO?: boolean | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* The ID of the Availability Zone in which to create the volume. For example, `us-east-1a` .
|
|
315
|
+
*
|
|
316
|
+
* Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.
|
|
317
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone}
|
|
318
|
+
*/
|
|
319
|
+
AvailabilityZone?: string | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid}
|
|
322
|
+
*/
|
|
323
|
+
AvailabilityZoneId: string;
|
|
324
|
+
/**
|
|
325
|
+
* Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
|
|
326
|
+
*
|
|
327
|
+
* Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .
|
|
328
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted}
|
|
329
|
+
*/
|
|
330
|
+
Encrypted?: boolean | undefined;
|
|
331
|
+
/**
|
|
332
|
+
* The number of I/O operations per second (IOPS) to provision for the volume. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types.
|
|
333
|
+
*
|
|
334
|
+
* Valid ranges:
|
|
335
|
+
*
|
|
336
|
+
* - gp3: `3,000` ( *default* ) `- 80,000` IOPS
|
|
337
|
+
* - io1: `100 - 64,000` IOPS
|
|
338
|
+
* - io2: `100 - 256,000` IOPS
|
|
339
|
+
*
|
|
340
|
+
* > [Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
|
|
341
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops}
|
|
342
|
+
*/
|
|
343
|
+
Iops?: number | undefined;
|
|
344
|
+
/**
|
|
345
|
+
* The identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true` .
|
|
346
|
+
*
|
|
347
|
+
* If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to `true` , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
|
|
348
|
+
*
|
|
349
|
+
* Alternatively, if you want to specify a different key, you can specify one of the following:
|
|
350
|
+
*
|
|
351
|
+
* - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
352
|
+
* - Key alias. Specify the alias for the key, prefixed with `alias/` . For example, for a key with the alias `my_cmk` , use `alias/my_cmk` . Or to specify the AWS managed key , use `alias/aws/ebs` .
|
|
353
|
+
* - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
354
|
+
* - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
|
|
355
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid}
|
|
356
|
+
*/
|
|
357
|
+
KmsKeyId?: string | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* Indicates whether Amazon EBS Multi-Attach is enabled.
|
|
360
|
+
*
|
|
361
|
+
* AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
|
|
362
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled}
|
|
363
|
+
*/
|
|
364
|
+
MultiAttachEnabled?: boolean | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* The Amazon Resource Name (ARN) of the Outpost.
|
|
367
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn}
|
|
368
|
+
*/
|
|
369
|
+
OutpostArn?: string | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size, and you can specify a volume size that is equal to or larger than the snapshot size.
|
|
372
|
+
*
|
|
373
|
+
* Valid sizes:
|
|
374
|
+
*
|
|
375
|
+
* - gp2: `1 - 16,384` GiB
|
|
376
|
+
* - gp3: `1 - 65,536` GiB
|
|
377
|
+
* - io1: `4 - 16,384` GiB
|
|
378
|
+
* - io2: `4 - 65,536` GiB
|
|
379
|
+
* - st1 and sc1: `125 - 16,384` GiB
|
|
380
|
+
* - standard: `1 - 1024` GiB
|
|
381
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size}
|
|
382
|
+
*/
|
|
383
|
+
Size: number;
|
|
118
384
|
/**
|
|
119
385
|
* The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
|
|
120
386
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid}
|
|
121
387
|
*/
|
|
122
388
|
SnapshotId?: string | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid}
|
|
391
|
+
*/
|
|
392
|
+
SourceVolumeId?: string | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* The tags to apply to the volume during creation.
|
|
395
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags}
|
|
396
|
+
*/
|
|
397
|
+
Tags?: Tag[] | undefined;
|
|
398
|
+
/**
|
|
399
|
+
* The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
|
|
400
|
+
*
|
|
401
|
+
* This parameter is valid only for `gp3` volumes. The default value is 125.
|
|
402
|
+
*
|
|
403
|
+
* Valid Range: Minimum value of 125. Maximum value of 1000.
|
|
404
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput}
|
|
405
|
+
*/
|
|
406
|
+
Throughput?: number | undefined;
|
|
407
|
+
/**
|
|
408
|
+
* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
|
|
409
|
+
*
|
|
410
|
+
* This parameter is supported only for volumes created from snapshots. Omit this parameter if:
|
|
411
|
+
*
|
|
412
|
+
* - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
|
|
413
|
+
*
|
|
414
|
+
* > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
|
|
415
|
+
* - You want to create a volume that is initialized at the default rate.
|
|
416
|
+
*
|
|
417
|
+
* For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* .
|
|
418
|
+
*
|
|
419
|
+
* Valid range: 100 - 300 MiB/s
|
|
420
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate}
|
|
421
|
+
*/
|
|
422
|
+
VolumeInitializationRate?: number | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* The volume type. This parameter can be one of the following values:
|
|
425
|
+
*
|
|
426
|
+
* - General Purpose SSD: `gp2` | `gp3`
|
|
427
|
+
* - Provisioned IOPS SSD: `io1` | `io2`
|
|
428
|
+
* - Throughput Optimized HDD: `st1`
|
|
429
|
+
* - Cold HDD: `sc1`
|
|
430
|
+
* - Magnetic: `standard`
|
|
431
|
+
*
|
|
432
|
+
* For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) .
|
|
433
|
+
*
|
|
434
|
+
* Default: `gp2`
|
|
435
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype}
|
|
436
|
+
*/
|
|
437
|
+
VolumeType?: string | undefined;
|
|
438
|
+
} | {
|
|
439
|
+
/**
|
|
440
|
+
* Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
|
|
441
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio}
|
|
442
|
+
*/
|
|
443
|
+
AutoEnableIO?: boolean | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* The ID of the Availability Zone in which to create the volume. For example, `us-east-1a` .
|
|
446
|
+
*
|
|
447
|
+
* Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.
|
|
448
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone}
|
|
449
|
+
*/
|
|
450
|
+
AvailabilityZone?: string | undefined;
|
|
451
|
+
/**
|
|
452
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid}
|
|
453
|
+
*/
|
|
454
|
+
AvailabilityZoneId: string;
|
|
455
|
+
/**
|
|
456
|
+
* Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
|
|
457
|
+
*
|
|
458
|
+
* Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .
|
|
459
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted}
|
|
460
|
+
*/
|
|
461
|
+
Encrypted?: boolean | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* The number of I/O operations per second (IOPS) to provision for the volume. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types.
|
|
464
|
+
*
|
|
465
|
+
* Valid ranges:
|
|
466
|
+
*
|
|
467
|
+
* - gp3: `3,000` ( *default* ) `- 80,000` IOPS
|
|
468
|
+
* - io1: `100 - 64,000` IOPS
|
|
469
|
+
* - io2: `100 - 256,000` IOPS
|
|
470
|
+
*
|
|
471
|
+
* > [Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
|
|
472
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops}
|
|
473
|
+
*/
|
|
474
|
+
Iops?: number | undefined;
|
|
475
|
+
/**
|
|
476
|
+
* The identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true` .
|
|
477
|
+
*
|
|
478
|
+
* If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to `true` , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
|
|
479
|
+
*
|
|
480
|
+
* Alternatively, if you want to specify a different key, you can specify one of the following:
|
|
481
|
+
*
|
|
482
|
+
* - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
483
|
+
* - Key alias. Specify the alias for the key, prefixed with `alias/` . For example, for a key with the alias `my_cmk` , use `alias/my_cmk` . Or to specify the AWS managed key , use `alias/aws/ebs` .
|
|
484
|
+
* - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
485
|
+
* - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
|
|
486
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid}
|
|
487
|
+
*/
|
|
488
|
+
KmsKeyId?: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* Indicates whether Amazon EBS Multi-Attach is enabled.
|
|
491
|
+
*
|
|
492
|
+
* AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
|
|
493
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled}
|
|
494
|
+
*/
|
|
495
|
+
MultiAttachEnabled?: boolean | undefined;
|
|
496
|
+
/**
|
|
497
|
+
* The Amazon Resource Name (ARN) of the Outpost.
|
|
498
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn}
|
|
499
|
+
*/
|
|
500
|
+
OutpostArn?: string | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size, and you can specify a volume size that is equal to or larger than the snapshot size.
|
|
503
|
+
*
|
|
504
|
+
* Valid sizes:
|
|
505
|
+
*
|
|
506
|
+
* - gp2: `1 - 16,384` GiB
|
|
507
|
+
* - gp3: `1 - 65,536` GiB
|
|
508
|
+
* - io1: `4 - 16,384` GiB
|
|
509
|
+
* - io2: `4 - 65,536` GiB
|
|
510
|
+
* - st1 and sc1: `125 - 16,384` GiB
|
|
511
|
+
* - standard: `1 - 1024` GiB
|
|
512
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size}
|
|
513
|
+
*/
|
|
514
|
+
Size?: number | undefined;
|
|
515
|
+
/**
|
|
516
|
+
* The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
|
|
517
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid}
|
|
518
|
+
*/
|
|
519
|
+
SnapshotId: string;
|
|
520
|
+
/**
|
|
521
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid}
|
|
522
|
+
*/
|
|
523
|
+
SourceVolumeId?: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* The tags to apply to the volume during creation.
|
|
526
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags}
|
|
527
|
+
*/
|
|
528
|
+
Tags?: Tag[] | undefined;
|
|
529
|
+
/**
|
|
530
|
+
* The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
|
|
531
|
+
*
|
|
532
|
+
* This parameter is valid only for `gp3` volumes. The default value is 125.
|
|
533
|
+
*
|
|
534
|
+
* Valid Range: Minimum value of 125. Maximum value of 1000.
|
|
535
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-throughput}
|
|
536
|
+
*/
|
|
537
|
+
Throughput?: number | undefined;
|
|
538
|
+
/**
|
|
539
|
+
* Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization* . Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.
|
|
540
|
+
*
|
|
541
|
+
* This parameter is supported only for volumes created from snapshots. Omit this parameter if:
|
|
542
|
+
*
|
|
543
|
+
* - You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.
|
|
544
|
+
*
|
|
545
|
+
* > If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.
|
|
546
|
+
* - You want to create a volume that is initialized at the default rate.
|
|
547
|
+
*
|
|
548
|
+
* For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide* .
|
|
549
|
+
*
|
|
550
|
+
* Valid range: 100 - 300 MiB/s
|
|
551
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumeinitializationrate}
|
|
552
|
+
*/
|
|
553
|
+
VolumeInitializationRate?: number | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* The volume type. This parameter can be one of the following values:
|
|
556
|
+
*
|
|
557
|
+
* - General Purpose SSD: `gp2` | `gp3`
|
|
558
|
+
* - Provisioned IOPS SSD: `io1` | `io2`
|
|
559
|
+
* - Throughput Optimized HDD: `st1`
|
|
560
|
+
* - Cold HDD: `sc1`
|
|
561
|
+
* - Magnetic: `standard`
|
|
562
|
+
*
|
|
563
|
+
* For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) .
|
|
564
|
+
*
|
|
565
|
+
* Default: `gp2`
|
|
566
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-volumetype}
|
|
567
|
+
*/
|
|
568
|
+
VolumeType?: string | undefined;
|
|
569
|
+
} | {
|
|
570
|
+
/**
|
|
571
|
+
* Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.
|
|
572
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-autoenableio}
|
|
573
|
+
*/
|
|
574
|
+
AutoEnableIO?: boolean | undefined;
|
|
575
|
+
/**
|
|
576
|
+
* The ID of the Availability Zone in which to create the volume. For example, `us-east-1a` .
|
|
577
|
+
*
|
|
578
|
+
* Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both.
|
|
579
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzone}
|
|
580
|
+
*/
|
|
581
|
+
AvailabilityZone?: string | undefined;
|
|
582
|
+
/**
|
|
583
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-availabilityzoneid}
|
|
584
|
+
*/
|
|
585
|
+
AvailabilityZoneId?: string | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide* .
|
|
588
|
+
*
|
|
589
|
+
* Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances) .
|
|
590
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-encrypted}
|
|
591
|
+
*/
|
|
592
|
+
Encrypted?: boolean | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* The number of I/O operations per second (IOPS) to provision for the volume. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types.
|
|
595
|
+
*
|
|
596
|
+
* Valid ranges:
|
|
597
|
+
*
|
|
598
|
+
* - gp3: `3,000` ( *default* ) `- 80,000` IOPS
|
|
599
|
+
* - io1: `100 - 64,000` IOPS
|
|
600
|
+
* - io2: `100 - 256,000` IOPS
|
|
601
|
+
*
|
|
602
|
+
* > [Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS.
|
|
603
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-iops}
|
|
604
|
+
*/
|
|
605
|
+
Iops?: number | undefined;
|
|
606
|
+
/**
|
|
607
|
+
* The identifier of the AWS KMS key to use for Amazon EBS encryption. If `KmsKeyId` is specified, the encrypted state must be `true` .
|
|
608
|
+
*
|
|
609
|
+
* If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to `true` , then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the AWS managed key .
|
|
610
|
+
*
|
|
611
|
+
* Alternatively, if you want to specify a different key, you can specify one of the following:
|
|
612
|
+
*
|
|
613
|
+
* - Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
614
|
+
* - Key alias. Specify the alias for the key, prefixed with `alias/` . For example, for a key with the alias `my_cmk` , use `alias/my_cmk` . Or to specify the AWS managed key , use `alias/aws/ebs` .
|
|
615
|
+
* - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
|
|
616
|
+
* - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
|
|
617
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-kmskeyid}
|
|
618
|
+
*/
|
|
619
|
+
KmsKeyId?: string | undefined;
|
|
620
|
+
/**
|
|
621
|
+
* Indicates whether Amazon EBS Multi-Attach is enabled.
|
|
622
|
+
*
|
|
623
|
+
* AWS CloudFormation does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.
|
|
624
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-multiattachenabled}
|
|
625
|
+
*/
|
|
626
|
+
MultiAttachEnabled?: boolean | undefined;
|
|
627
|
+
/**
|
|
628
|
+
* The Amazon Resource Name (ARN) of the Outpost.
|
|
629
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-outpostarn}
|
|
630
|
+
*/
|
|
631
|
+
OutpostArn?: string | undefined;
|
|
632
|
+
/**
|
|
633
|
+
* The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size, and you can specify a volume size that is equal to or larger than the snapshot size.
|
|
634
|
+
*
|
|
635
|
+
* Valid sizes:
|
|
636
|
+
*
|
|
637
|
+
* - gp2: `1 - 16,384` GiB
|
|
638
|
+
* - gp3: `1 - 65,536` GiB
|
|
639
|
+
* - io1: `4 - 16,384` GiB
|
|
640
|
+
* - io2: `4 - 65,536` GiB
|
|
641
|
+
* - st1 and sc1: `125 - 16,384` GiB
|
|
642
|
+
* - standard: `1 - 1024` GiB
|
|
643
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-size}
|
|
644
|
+
*/
|
|
645
|
+
Size?: number | undefined;
|
|
646
|
+
/**
|
|
647
|
+
* The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
|
|
648
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-snapshotid}
|
|
649
|
+
*/
|
|
650
|
+
SnapshotId?: string | undefined;
|
|
651
|
+
/**
|
|
652
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-sourcevolumeid}
|
|
653
|
+
*/
|
|
654
|
+
SourceVolumeId: string;
|
|
123
655
|
/**
|
|
124
656
|
* The tags to apply to the volume during creation.
|
|
125
657
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-volume.html#cfn-ec2-volume-tags}
|
|
@@ -184,7 +184,7 @@ export type InstanceRequirementsRequest = {
|
|
|
184
184
|
* The specific accelerator names to include. For example, you can specify `a100` , `v100` , `k80` , or other specific accelerator models.
|
|
185
185
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratornames}
|
|
186
186
|
*/
|
|
187
|
-
AcceleratorNames?: ("a10g" | "a100" | "h100" | "inferentia" | "k520" | "k80" | "m60" | "radeon-pro-v520" | "t4" | "t4g" | "vu9p" | "v100")[] | undefined;
|
|
187
|
+
AcceleratorNames?: ("a10g" | "a100" | "h100" | "inferentia" | "k520" | "k80" | "m60" | "radeon-pro-v520" | "t4" | "t4g" | "vu9p" | "v100" | "l40s")[] | undefined;
|
|
188
188
|
/**
|
|
189
189
|
* The minimum and maximum total accelerator memory in mebibytes (MiB). This is important for GPU workloads that require specific amounts of video memory.
|
|
190
190
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-capacityprovider-instancerequirementsrequest.html#cfn-ecs-capacityprovider-instancerequirementsrequest-acceleratortotalmemorymib}
|
|
@@ -88,14 +88,14 @@ export type CapacityProviderStrategyItem = {
|
|
|
88
88
|
* Base value characteristics:
|
|
89
89
|
*
|
|
90
90
|
* - Only one capacity provider in a strategy can have a base defined
|
|
91
|
-
* -
|
|
92
|
-
* -
|
|
91
|
+
* - The default value is `0` if not specified
|
|
92
|
+
* - The valid range is 0 to 100,000
|
|
93
93
|
* - Base requirements are satisfied first before weight distribution
|
|
94
94
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base}
|
|
95
95
|
*/
|
|
96
96
|
Base?: number | undefined;
|
|
97
97
|
/**
|
|
98
|
-
* The short name of the capacity provider.
|
|
98
|
+
* The short name of the capacity provider. This can be either an AWS managed capacity provider ( `FARGATE` or `FARGATE_SPOT` ) or the name of a custom capacity provider that you created.
|
|
99
99
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider}
|
|
100
100
|
*/
|
|
101
101
|
CapacityProvider?: string | undefined;
|
|
@@ -107,8 +107,8 @@ export type CapacityProviderStrategyItem = {
|
|
|
107
107
|
* Weight value characteristics:
|
|
108
108
|
*
|
|
109
109
|
* - Weight is considered after the base value is satisfied
|
|
110
|
-
* -
|
|
111
|
-
* -
|
|
110
|
+
* - The default value is `0` if not specified
|
|
111
|
+
* - The valid range is 0 to 1,000
|
|
112
112
|
* - At least one capacity provider must have a weight greater than zero
|
|
113
113
|
* - Capacity providers with weight of `0` cannot place tasks
|
|
114
114
|
*
|
|
@@ -41,8 +41,8 @@ export type CapacityProviderStrategy = {
|
|
|
41
41
|
* Base value characteristics:
|
|
42
42
|
*
|
|
43
43
|
* - Only one capacity provider in a strategy can have a base defined
|
|
44
|
-
* -
|
|
45
|
-
* -
|
|
44
|
+
* - The default value is `0` if not specified
|
|
45
|
+
* - The valid range is 0 to 100,000
|
|
46
46
|
* - Base requirements are satisfied first before weight distribution
|
|
47
47
|
* @min 0
|
|
48
48
|
* @max 100000
|
|
@@ -50,7 +50,7 @@ export type CapacityProviderStrategy = {
|
|
|
50
50
|
*/
|
|
51
51
|
Base?: number | undefined;
|
|
52
52
|
/**
|
|
53
|
-
* The short name of the capacity provider.
|
|
53
|
+
* The short name of the capacity provider. This can be either an AWS managed capacity provider ( `FARGATE` or `FARGATE_SPOT` ) or the name of a custom capacity provider that you created.
|
|
54
54
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-capacityprovider}
|
|
55
55
|
*/
|
|
56
56
|
CapacityProvider: CapacityProvider;
|
|
@@ -62,8 +62,8 @@ export type CapacityProviderStrategy = {
|
|
|
62
62
|
* Weight value characteristics:
|
|
63
63
|
*
|
|
64
64
|
* - Weight is considered after the base value is satisfied
|
|
65
|
-
* -
|
|
66
|
-
* -
|
|
65
|
+
* - The default value is `0` if not specified
|
|
66
|
+
* - The valid range is 0 to 1,000
|
|
67
67
|
* - At least one capacity provider must have a weight greater than zero
|
|
68
68
|
* - Capacity providers with weight of `0` cannot place tasks
|
|
69
69
|
*
|