Skip to content

Commit d91f934

Browse files
author
AWS
committed
Amazon Elastic Compute Cloud Update: Documentation updates for EC2.
1 parent bad5b63 commit d91f934

File tree

2 files changed

+57
-17
lines changed

2 files changed

+57
-17
lines changed

‎.changes/next-release/feature-AmazonElasticComputeCloud-cebf009.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Elastic Compute Cloud",
4+
"contributor": "",
5+
"description": "Documentation updates for EC2."
6+
}

‎services/ec2/src/main/resources/codegen-resources/service-2.json

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@
229229
},
230230
"input":{"shape":"AssociateIpamResourceDiscoveryRequest"},
231231
"output":{"shape":"AssociateIpamResourceDiscoveryResult"},
232-
"documentation":"<p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
232+
"documentation":"<p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
233233
},
234234
"AssociateNatGatewayAddress":{
235235
"name":"AssociateNatGatewayAddress",
@@ -766,7 +766,7 @@
766766
},
767767
"input":{"shape":"CreateIpamResourceDiscoveryRequest"},
768768
"output":{"shape":"CreateIpamResourceDiscoveryResult"},
769-
"documentation":"<p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
769+
"documentation":"<p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
770770
},
771771
"CreateIpamScope":{
772772
"name":"CreateIpamScope",
@@ -1510,7 +1510,7 @@
15101510
},
15111511
"input":{"shape":"DeleteIpamResourceDiscoveryRequest"},
15121512
"output":{"shape":"DeleteIpamResourceDiscoveryResult"},
1513-
"documentation":"<p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
1513+
"documentation":"<p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
15141514
},
15151515
"DeleteIpamScope":{
15161516
"name":"DeleteIpamScope",
@@ -2682,7 +2682,7 @@
26822682
},
26832683
"input":{"shape":"DescribeIpamResourceDiscoveriesRequest"},
26842684
"output":{"shape":"DescribeIpamResourceDiscoveriesResult"},
2685-
"documentation":"<p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
2685+
"documentation":"<p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
26862686
},
26872687
"DescribeIpamResourceDiscoveryAssociations":{
26882688
"name":"DescribeIpamResourceDiscoveryAssociations",
@@ -3807,7 +3807,7 @@
38073807
},
38083808
"input":{"shape":"DisassociateIpamResourceDiscoveryRequest"},
38093809
"output":{"shape":"DisassociateIpamResourceDiscoveryResult"},
3810-
"documentation":"<p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
3810+
"documentation":"<p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
38113811
},
38123812
"DisassociateNatGatewayAddress":{
38133813
"name":"DisassociateNatGatewayAddress",
@@ -4274,7 +4274,7 @@
42744274
},
42754275
"input":{"shape":"GetIpamResourceCidrsRequest"},
42764276
"output":{"shape":"GetIpamResourceCidrsResult"},
4277-
"documentation":"<p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
4277+
"documentation":"<p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
42784278
},
42794279
"GetLaunchTemplateData":{
42804280
"name":"GetLaunchTemplateData",
@@ -4810,7 +4810,7 @@
48104810
},
48114811
"input":{"shape":"ModifyIpamResourceDiscoveryRequest"},
48124812
"output":{"shape":"ModifyIpamResourceDiscoveryResult"},
4813-
"documentation":"<p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
4813+
"documentation":"<p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
48144814
},
48154815
"ModifyIpamScope":{
48164816
"name":"ModifyIpamScope",
@@ -6134,6 +6134,7 @@
61346134
},
61356135
"AcceptVpcPeeringConnectionRequest":{
61366136
"type":"structure",
6137+
"required":["VpcPeeringConnectionId"],
61376138
"members":{
61386139
"DryRun":{
61396140
"shape":"Boolean",
@@ -7566,6 +7567,10 @@
75667567
},
75677568
"AssociateEnclaveCertificateIamRoleRequest":{
75687569
"type":"structure",
7570+
"required":[
7571+
"CertificateArn",
7572+
"RoleArn"
7573+
],
75697574
"members":{
75707575
"CertificateArn":{
75717576
"shape":"CertificateId",
@@ -7818,6 +7823,11 @@
78187823
},
78197824
"AssociateTransitGatewayMulticastDomainRequest":{
78207825
"type":"structure",
7826+
"required":[
7827+
"TransitGatewayMulticastDomainId",
7828+
"TransitGatewayAttachmentId",
7829+
"SubnetIds"
7830+
],
78217831
"members":{
78227832
"TransitGatewayMulticastDomainId":{
78237833
"shape":"TransitGatewayMulticastDomainId",
@@ -12040,7 +12050,7 @@
1204012050
},
1204112051
"ExcessCapacityTerminationPolicy":{
1204212052
"shape":"FleetExcessCapacityTerminationPolicy",
12043-
"documentation":"<p>Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>"
12053+
"documentation":"<p>Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>"
1204412054
},
1204512055
"LaunchTemplateConfigs":{
1204612056
"shape":"FleetLaunchTemplateConfigListRequest",
@@ -15037,7 +15047,7 @@
1503715047
},
1503815048
"VolumeType":{
1503915049
"shape":"VolumeType",
15040-
"documentation":"<p>The volume type. This parameter can be one of the following values:</p> <ul> <li> <p>General Purpose SSD: <code>gp2</code> | <code>gp3</code> </p> </li> <li> <p>Provisioned IOPS SSD: <code>io1</code> | <code>io2</code> </p> </li> <li> <p>Throughput Optimized HDD: <code>st1</code> </p> </li> <li> <p>Cold HDD: <code>sc1</code> </p> </li> <li> <p>Magnetic: <code>standard</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Default: <code>gp2</code> </p>"
15050+
"documentation":"<p>The volume type. This parameter can be one of the following values:</p> <ul> <li> <p>General Purpose SSD: <code>gp2</code> | <code>gp3</code> </p> </li> <li> <p>Provisioned IOPS SSD: <code>io1</code> | <code>io2</code> </p> </li> <li> <p>Throughput Optimized HDD: <code>st1</code> </p> </li> <li> <p>Cold HDD: <code>sc1</code> </p> </li> <li> <p>Magnetic: <code>standard</code> </p> </li> </ul> <important> <p>Throughput Optimized HDD (<code>st1</code>) and Cold HDD (<code>sc1</code>) volumes can't be used as boot volumes.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS volume types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Default: <code>gp2</code> </p>"
1504115051
},
1504215052
"DryRun":{
1504315053
"shape":"Boolean",
@@ -15250,6 +15260,7 @@
1525015260
},
1525115261
"CreateVpcPeeringConnectionRequest":{
1525215262
"type":"structure",
15263+
"required":["VpcId"],
1525315264
"members":{
1525415265
"DryRun":{
1525515266
"shape":"Boolean",
@@ -25092,6 +25103,10 @@
2509225103
},
2509325104
"DisassociateEnclaveCertificateIamRoleRequest":{
2509425105
"type":"structure",
25106+
"required":[
25107+
"CertificateArn",
25108+
"RoleArn"
25109+
],
2509525110
"members":{
2509625111
"CertificateArn":{
2509725112
"shape":"CertificateId",
@@ -25277,6 +25292,11 @@
2527725292
},
2527825293
"DisassociateTransitGatewayMulticastDomainRequest":{
2527925294
"type":"structure",
25295+
"required":[
25296+
"TransitGatewayMulticastDomainId",
25297+
"TransitGatewayAttachmentId",
25298+
"SubnetIds"
25299+
],
2528025300
"members":{
2528125301
"TransitGatewayMulticastDomainId":{
2528225302
"shape":"TransitGatewayMulticastDomainId",
@@ -25720,7 +25740,7 @@
2572025740
},
2572125741
"Encrypted":{
2572225742
"shape":"Boolean",
25723-
"documentation":"<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> 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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters\">Amazon EBS encryption</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances\">Supported instance types</a>.</p> <p>This parameter is not returned by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html\">DescribeImageAttribute</a>.</p>",
25743+
"documentation":"<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> 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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters\">Amazon EBS encryption</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances\">Supported instance types</a>.</p> <p>This parameter is not returned by <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html\">DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, you can specify this parameter only for block device mappings that result in new, empty volumes when instances are launched from the image. Omit this parameter on block device mappings that include an existing volume or snapshot. If you include this parameter, and specify an encryption setting that is different from the existing volume or snapshot, the request will fail.</p>",
2572425744
"locationName":"encrypted"
2572525745
}
2572625746
},
@@ -27804,7 +27824,7 @@
2780427824
},
2780527825
"ExcessCapacityTerminationPolicy":{
2780627826
"shape":"FleetExcessCapacityTerminationPolicy",
27807-
"documentation":"<p>Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>",
27827+
"documentation":"<p>Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>",
2780827828
"locationName":"excessCapacityTerminationPolicy"
2780927829
},
2781027830
"FulfilledCapacity":{
@@ -28563,6 +28583,7 @@
2856328583
},
2856428584
"GetAssociatedEnclaveCertificateIamRolesRequest":{
2856528585
"type":"structure",
28586+
"required":["CertificateArn"],
2856628587
"members":{
2856728588
"CertificateArn":{
2856828589
"shape":"CertificateId",
@@ -29883,6 +29904,7 @@
2988329904
},
2988429905
"GetTransitGatewayMulticastDomainAssociationsRequest":{
2988529906
"type":"structure",
29907+
"required":["TransitGatewayMulticastDomainId"],
2988629908
"members":{
2988729909
"TransitGatewayMulticastDomainId":{
2988829910
"shape":"TransitGatewayMulticastDomainId",
@@ -32644,6 +32666,7 @@
3264432666
},
3264532667
"InstanceCreditSpecificationRequest":{
3264632668
"type":"structure",
32669+
"required":["InstanceId"],
3264732670
"members":{
3264832671
"InstanceId":{
3264932672
"shape":"InstanceId",
@@ -35876,7 +35899,7 @@
3587635899
"locationName":"tagSet"
3587735900
}
3587835901
},
35879-
"documentation":"<p>A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>"
35902+
"documentation":"<p>A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>"
3588035903
},
3588135904
"IpamResourceDiscoveryAssociation":{
3588235905
"type":"structure",
@@ -39018,7 +39041,7 @@
3901839041
},
3901939042
"ExcessCapacityTerminationPolicy":{
3902039043
"shape":"FleetExcessCapacityTerminationPolicy",
39021-
"documentation":"<p>Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>"
39044+
"documentation":"<p>Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>"
3902239045
},
3902339046
"LaunchTemplateConfigs":{
3902439047
"shape":"FleetLaunchTemplateConfigListRequest",
@@ -39992,6 +40015,7 @@
3999240015
},
3999340016
"ModifyPrivateDnsNameOptionsRequest":{
3999440017
"type":"structure",
40018+
"required":["InstanceId"],
3999540019
"members":{
3999640020
"DryRun":{
3999740021
"shape":"Boolean",
@@ -40169,7 +40193,7 @@
4016940193
"members":{
4017040194
"ExcessCapacityTerminationPolicy":{
4017140195
"shape":"ExcessCapacityTerminationPolicy",
40172-
"documentation":"<p>Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.</p>",
40196+
"documentation":"<p>Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>",
4017340197
"locationName":"excessCapacityTerminationPolicy"
4017440198
},
4017540199
"LaunchTemplateConfigs":{
@@ -45157,6 +45181,10 @@
4515745181
},
4515845182
"RegisterTransitGatewayMulticastGroupMembersRequest":{
4515945183
"type":"structure",
45184+
"required":[
45185+
"TransitGatewayMulticastDomainId",
45186+
"NetworkInterfaceIds"
45187+
],
4516045188
"members":{
4516145189
"TransitGatewayMulticastDomainId":{
4516245190
"shape":"TransitGatewayMulticastDomainId",
@@ -45188,6 +45216,10 @@
4518845216
},
4518945217
"RegisterTransitGatewayMulticastGroupSourcesRequest":{
4519045218
"type":"structure",
45219+
"required":[
45220+
"TransitGatewayMulticastDomainId",
45221+
"NetworkInterfaceIds"
45222+
],
4519145223
"members":{
4519245224
"TransitGatewayMulticastDomainId":{
4519345225
"shape":"TransitGatewayMulticastDomainId",
@@ -45975,7 +46007,7 @@
4597546007
},
4597646008
"ImageId":{
4597746009
"shape":"ImageId",
45978-
"documentation":"<p>The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.</p> <p>Valid formats:</p> <ul> <li> <p> <code>ami-17characters00000</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name:version-number</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name:label</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id\">Use a Systems Manager parameter instead of an AMI ID</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
46010+
"documentation":"<p>The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.</p> <p>Valid formats:</p> <ul> <li> <p> <code>ami-17characters00000</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name:version-number</code> </p> </li> <li> <p> <code>resolve:ssm:parameter-name:label</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI\">Use a Systems Manager parameter to find an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
4597946011
},
4598046012
"InstanceType":{
4598146013
"shape":"InstanceType",
@@ -48297,7 +48329,7 @@
4829748329
"members":{
4829848330
"AWSAccessKeyId":{
4829948331
"shape":"String",
48300-
"documentation":"<p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best practices for managing Amazon Web Services access keys</a>.</p>"
48332+
"documentation":"<p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html\">Best Practices for Amazon Web Services accounts</a> in the <i>Account ManagementReference Guide</i>.</p>"
4830148333
},
4830248334
"Bucket":{
4830348335
"shape":"String",
@@ -48863,6 +48895,7 @@
4886348895
},
4886448896
"SearchTransitGatewayMulticastGroupsRequest":{
4886548897
"type":"structure",
48898+
"required":["TransitGatewayMulticastDomainId"],
4886648899
"members":{
4886748900
"TransitGatewayMulticastDomainId":{
4886848901
"shape":"TransitGatewayMulticastDomainId",
@@ -49203,6 +49236,7 @@
4920349236
},
4920449237
"SecurityGroupRuleUpdate":{
4920549238
"type":"structure",
49239+
"required":["SecurityGroupRuleId"],
4920649240
"members":{
4920749241
"SecurityGroupRuleId":{
4920849242
"shape":"SecurityGroupRuleId",
@@ -50187,7 +50221,7 @@
5018750221
},
5018850222
"ExcessCapacityTerminationPolicy":{
5018950223
"shape":"ExcessCapacityTerminationPolicy",
50190-
"documentation":"<p>Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.</p>",
50224+
"documentation":"<p>Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.</p> <p>Supported only for fleets of type <code>maintain</code>.</p>",
5019150225
"locationName":"excessCapacityTerminationPolicy"
5019250226
},
5019350227
"FulfilledCapacity":{

0 commit comments

Comments
 (0)