1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
)
// In addition to your infrastruction configuration, these settings provide an
// extra layer of control over your build instances. For instances where Image
// Builder installs the Systems Manager agent, you can choose whether to keep it
// for the AMI that you create. You can also specify commands to run on launch for
// all of your build instances.
type AdditionalInstanceConfiguration struct {
// Contains settings for the Systems Manager agent on your build instance.
SystemsManagerAgent *SystemsManagerAgent
// Use this property to provide commands or a command script to run when you launch
// your build instance. The userDataOverride property replaces any commands that
// Image Builder might have added to ensure that Systems Manager is installed on
// your Linux build instance. If you override the user data, make sure that you add
// commands to install Systems Manager, if it is not pre-installed on your base
// image. The user data is always base 64 encoded. For example, the following
// commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$:
// #!/bin/bash mkdir -p /var/bb/ touch /var
UserDataOverride *string
noSmithyDocumentSerde
}
// Details of an Amazon EC2 AMI.
type Ami struct {
// The account ID of the owner of the AMI.
AccountId *string
// The description of the Amazon EC2 AMI. Minimum and maximum length are in
// characters.
Description *string
// The AMI ID of the Amazon EC2 AMI.
Image *string
// The name of the Amazon EC2 AMI.
Name *string
// The Amazon Web Services Region of the Amazon EC2 AMI.
Region *string
// Image state shows the image status and the reason for that status.
State *ImageState
noSmithyDocumentSerde
}
// Define and configure the output AMIs of the pipeline.
type AmiDistributionConfiguration struct {
// The tags to apply to AMIs distributed to this Region.
AmiTags map[string]string
// The description of the AMI distribution configuration. Minimum and maximum
// length are in characters.
Description *string
// The KMS key identifier used to encrypt the distributed image.
KmsKeyId *string
// Launch permissions can be used to configure which Amazon Web Services accounts
// can use the AMI to launch instances.
LaunchPermission *LaunchPermissionConfiguration
// The name of the output AMI.
Name *string
// The ID of an account to which you want to distribute an image.
TargetAccountIds []string
noSmithyDocumentSerde
}
// A detailed view of a component.
type Component struct {
// The Amazon Resource Name (ARN) of the component.
Arn *string
// The change description of the component.
ChangeDescription *string
// Component data contains the YAML document content for the component.
Data *string
// The date that the component was created.
DateCreated *string
// The description of the component.
Description *string
// The encryption status of the component.
Encrypted *bool
// The KMS key identifier used to encrypt the component.
KmsKeyId *string
// The name of the component.
Name *string
// The owner of the component.
Owner *string
// Contains parameter details for each of the parameters that are defined for the
// component.
Parameters []ComponentParameterDetail
// The platform of the component.
Platform Platform
// Describes the current status of the component. This is used for components that
// are no longer active.
State *ComponentState
// The operating system (OS) version supported by the component. If the OS
// information is available, a prefix match is performed against the base image OS
// version during image recipe creation.
SupportedOsVersions []string
// The tags associated with the component.
Tags map[string]string
// The type of the component denotes whether the component is used to build the
// image or only to test it.
Type ComponentType
// The version of the component.
Version *string
noSmithyDocumentSerde
}
// Configuration details of the component.
type ComponentConfiguration struct {
// The Amazon Resource Name (ARN) of the component.
//
// This member is required.
ComponentArn *string
// A group of parameter settings that are used to configure the component for a
// specific recipe.
Parameters []ComponentParameter
noSmithyDocumentSerde
}
// Contains a key/value pair that sets the named component parameter.
type ComponentParameter struct {
// The name of the component parameter to set.
//
// This member is required.
Name *string
// Sets the value for the named component parameter.
//
// This member is required.
Value []string
noSmithyDocumentSerde
}
// Defines a parameter that is used to provide configuration details for the
// component.
type ComponentParameterDetail struct {
// The name of this input parameter.
//
// This member is required.
Name *string
// The type of input this parameter provides. The currently supported value is
// "string".
//
// This member is required.
Type *string
// The default value of this parameter if no input is provided.
DefaultValue []string
// Describes this parameter.
Description *string
noSmithyDocumentSerde
}
// A group of fields that describe the current status of components that are no
// longer active.
type ComponentState struct {
// Describes how or why the component changed state.
Reason *string
// The current state of the component.
Status ComponentStatus
noSmithyDocumentSerde
}
// A high-level summary of a component.
type ComponentSummary struct {
// The Amazon Resource Name (ARN) of the component.
Arn *string
// The change description of the component.
ChangeDescription *string
// The date that the component was created.
DateCreated *string
// The description of the component.
Description *string
// The name of the component.
Name *string
// The owner of the component.
Owner *string
// The platform of the component.
Platform Platform
// Describes the current status of the component.
State *ComponentState
// The operating system (OS) version supported by the component. If the OS
// information is available, a prefix match is performed against the base image OS
// version during image recipe creation.
SupportedOsVersions []string
// The tags associated with the component.
Tags map[string]string
// The type of the component denotes whether the component is used to build the
// image or only to test it.
Type ComponentType
// The version of the component.
Version *string
noSmithyDocumentSerde
}
// The defining characteristics of a specific version of an Amazon Web Services TOE
// component.
type ComponentVersion struct {
// The Amazon Resource Name (ARN) of the component. Semantic versioning is included
// in each object's Amazon Resource Name (ARN), at the level that applies to that
// object as follows:
//
// * Versionless ARNs and Name ARNs do not include specific
// values in any of the nodes. The nodes are either left off entirely, or they are
// specified as wildcards, for example: x.x.x.
//
// * Version ARNs have only the first
// three nodes: ..
//
// * Build version ARNs have all four nodes, and point to a
// specific build for a specific version of an object.
Arn *string
// The date that the component was created.
DateCreated *string
// The description of the component.
Description *string
// The name of the component.
Name *string
// The owner of the component.
Owner *string
// The platform of the component.
Platform Platform
// he operating system (OS) version supported by the component. If the OS
// information is available, a prefix match is performed against the base image OS
// version during image recipe creation.
SupportedOsVersions []string
// The type of the component denotes whether the component is used to build the
// image or only to test it.
Type ComponentType
// The semantic version of the component. The semantic version has four nodes: ../.
// You can assign values for the first three, and can filter on all of them.
// Assignment: For the first three nodes you can assign any positive integer value,
// including zero, with an upper limit of 2^30-1, or 1073741823 for each node.
// Image Builder automatically assigns the build number to the fourth node.
// Patterns: You can use any numeric pattern that adheres to the assignment
// requirements for the nodes that you can assign. For example, you might choose a
// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
// Filtering: With semantic versioning, you have the flexibility to use wildcards
// (x) to specify the most recent versions or nodes when selecting the base image
// or components for your recipe. When you use a wildcard in any node, all nodes to
// the right of the first wildcard must also be wildcards.
Version *string
noSmithyDocumentSerde
}
// A container encapsulates the runtime environment for an application.
type Container struct {
// A list of URIs for containers created in the context Region.
ImageUris []string
// Containers and container images are Region-specific. This is the Region context
// for the container.
Region *string
noSmithyDocumentSerde
}
// Container distribution settings for encryption, licensing, and sharing in a
// specific Region.
type ContainerDistributionConfiguration struct {
// The destination repository for the container distribution configuration.
//
// This member is required.
TargetRepository *TargetContainerRepository
// Tags that are attached to the container distribution configuration.
ContainerTags []string
// The description of the container distribution configuration.
Description *string
noSmithyDocumentSerde
}
// A container recipe.
type ContainerRecipe struct {
// The Amazon Resource Name (ARN) of the container recipe. Semantic versioning is
// included in each object's Amazon Resource Name (ARN), at the level that applies
// to that object as follows:
//
// * Versionless ARNs and Name ARNs do not include
// specific values in any of the nodes. The nodes are either left off entirely, or
// they are specified as wildcards, for example: x.x.x.
//
// * Version ARNs have only
// the first three nodes: ..
//
// * Build version ARNs have all four nodes, and point
// to a specific build for a specific version of an object.
Arn *string
// Components for build and test that are included in the container recipe.
Components []ComponentConfiguration
// Specifies the type of container, such as Docker.
ContainerType ContainerType
// The date when this container recipe was created.
DateCreated *string
// The description of the container recipe.
Description *string
// Dockerfiles are text documents that are used to build Docker containers, and
// ensure that they contain all of the elements required by the application running
// inside. The template data consists of contextual variables where Image Builder
// places build information or scripts, based on your container image recipe.
DockerfileTemplateData *string
// A flag that indicates if the target container is encrypted.
Encrypted *bool
// A group of options that can be used to configure an instance for building and
// testing container images.
InstanceConfiguration *InstanceConfiguration
// Identifies which KMS key is used to encrypt the container image for distribution
// to the target Region.
KmsKeyId *string
// The name of the container recipe.
Name *string
// The owner of the container recipe.
Owner *string
// The base image for the container recipe.
ParentImage *string
// The system platform for the container, such as Windows or Linux.
Platform Platform
// Tags that are attached to the container recipe.
Tags map[string]string
// The destination repository for the container image.
TargetRepository *TargetContainerRepository
// The semantic version of the container recipe. The semantic version has four
// nodes: ../. You can assign values for the first three, and can filter on all of
// them. Assignment: For the first three nodes you can assign any positive integer
// value, including zero, with an upper limit of 2^30-1, or 1073741823 for each
// node. Image Builder automatically assigns the build number to the fourth node.
// Patterns: You can use any numeric pattern that adheres to the assignment
// requirements for the nodes that you can assign. For example, you might choose a
// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
// Filtering: With semantic versioning, you have the flexibility to use wildcards
// (x) to specify the most recent versions or nodes when selecting the base image
// or components for your recipe. When you use a wildcard in any node, all nodes to
// the right of the first wildcard must also be wildcards.
Version *string
// The working directory for use during build and test workflows.
WorkingDirectory *string
noSmithyDocumentSerde
}
// A summary of a container recipe
type ContainerRecipeSummary struct {
// The Amazon Resource Name (ARN) of the container recipe.
Arn *string
// Specifies the type of container, such as "Docker".
ContainerType ContainerType
// The date when this container recipe was created.
DateCreated *string
// The name of the container recipe.
Name *string
// The owner of the container recipe.
Owner *string
// The base image for the container recipe.
ParentImage *string
// The system platform for the container, such as Windows or Linux.
Platform Platform
// Tags that are attached to the container recipe.
Tags map[string]string
noSmithyDocumentSerde
}
// Defines the settings for a specific Region.
type Distribution struct {
// The target Region.
//
// This member is required.
Region *string
// The specific AMI settings; for example, launch permissions or AMI tags.
AmiDistributionConfiguration *AmiDistributionConfiguration
// Container distribution settings for encryption, licensing, and sharing in a
// specific Region.
ContainerDistributionConfiguration *ContainerDistributionConfiguration
// The Windows faster-launching configurations to use for AMI distribution.
FastLaunchConfigurations []FastLaunchConfiguration
// A group of launchTemplateConfiguration settings that apply to image distribution
// for specified accounts.
LaunchTemplateConfigurations []LaunchTemplateConfiguration
// The License Manager Configuration to associate with the AMI in the specified
// Region.
LicenseConfigurationArns []string
// Configure export settings to deliver disk images created from your image build,
// using a file format that is compatible with your VMs in that Region.
S3ExportConfiguration *S3ExportConfiguration
noSmithyDocumentSerde
}
// A distribution configuration.
type DistributionConfiguration struct {
// The maximum duration in minutes for this distribution configuration.
//
// This member is required.
TimeoutMinutes *int32
// The Amazon Resource Name (ARN) of the distribution configuration.
Arn *string
// The date on which this distribution configuration was created.
DateCreated *string
// The date on which this distribution configuration was last updated.
DateUpdated *string
// The description of the distribution configuration.
Description *string
// The distribution objects that apply Region-specific settings for the deployment
// of the image to targeted Regions.
Distributions []Distribution
// The name of the distribution configuration.
Name *string
// The tags of the distribution configuration.
Tags map[string]string
noSmithyDocumentSerde
}
// A high-level overview of a distribution configuration.
type DistributionConfigurationSummary struct {
// The Amazon Resource Name (ARN) of the distribution configuration.
Arn *string
// The date on which the distribution configuration was created.
DateCreated *string
// The date on which the distribution configuration was updated.
DateUpdated *string
// The description of the distribution configuration.
Description *string
// The name of the distribution configuration.
Name *string
// A list of Regions where the container image is distributed to.
Regions []string
// The tags associated with the distribution configuration.
Tags map[string]string
noSmithyDocumentSerde
}
// Amazon EBS-specific block device mapping specifications.
type EbsInstanceBlockDeviceSpecification struct {
// Use to configure delete on termination of the associated device.
DeleteOnTermination *bool
// Use to configure device encryption.
Encrypted *bool
// Use to configure device IOPS.
Iops *int32
// Use to configure the KMS key to use when encrypting the device.
KmsKeyId *string
// The snapshot that defines the device contents.
SnapshotId *string
// For GP3 volumes only – The throughput in MiB/s that the volume supports.
Throughput *int32
// Use to override the device's volume size.
VolumeSize *int32
// Use to override the device's volume type.
VolumeType EbsVolumeType
noSmithyDocumentSerde
}
// Define and configure faster launching for output Windows AMIs.
type FastLaunchConfiguration struct {
// A Boolean that represents the current state of faster launching for the Windows
// AMI. Set to true to start using Windows faster launching, or false to stop using
// it.
//
// This member is required.
Enabled bool
// The owner account ID for the fast-launch enabled Windows AMI.
AccountId *string
// The launch template that the fast-launch enabled Windows AMI uses when it
// launches Windows instances to create pre-provisioned snapshots.
LaunchTemplate *FastLaunchLaunchTemplateSpecification
// The maximum number of parallel instances that are launched for creating
// resources.
MaxParallelLaunches *int32
// Configuration settings for managing the number of snapshots that are created
// from pre-provisioned instances for the Windows AMI when faster launching is
// enabled.
SnapshotConfiguration *FastLaunchSnapshotConfiguration
noSmithyDocumentSerde
}
// Identifies the launch template that the associated Windows AMI uses for
// launching an instance when faster launching is enabled. You can specify either
// the launchTemplateName or the launchTemplateId, but not both.
type FastLaunchLaunchTemplateSpecification struct {
// The ID of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateId *string
// The name of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateName *string
// The version of the launch template to use for faster launching for a Windows
// AMI.
LaunchTemplateVersion *string
noSmithyDocumentSerde
}
// Configuration settings for creating and managing pre-provisioned snapshots for a
// fast-launch enabled Windows AMI.
type FastLaunchSnapshotConfiguration struct {
// The number of pre-provisioned snapshots to keep on hand for a fast-launch
// enabled Windows AMI.
TargetResourceCount *int32
noSmithyDocumentSerde
}
// A filter name and value pair that is used to return a more specific list of
// results from a list operation. Filters can be used to match a set of resources
// by specific criteria, such as tags, attributes, or IDs.
type Filter struct {
// The name of the filter. Filter names are case-sensitive.
Name *string
// The filter values. Filter values are case-sensitive.
Values []string
noSmithyDocumentSerde
}
// An Image Builder image. You must specify exactly one recipe for the image –
// either a container recipe (containerRecipe), which creates a container image, or
// an image recipe (imageRecipe), which creates an AMI.
type Image struct {
// The Amazon Resource Name (ARN) of the image. Semantic versioning is included in
// each object's Amazon Resource Name (ARN), at the level that applies to that
// object as follows:
//
// * Versionless ARNs and Name ARNs do not include specific
// values in any of the nodes. The nodes are either left off entirely, or they are
// specified as wildcards, for example: x.x.x.
//
// * Version ARNs have only the first
// three nodes: ..
//
// * Build version ARNs have all four nodes, and point to a
// specific build for a specific version of an object.
Arn *string
// Indicates the type of build that created this image. The build can be initiated
// in the following ways:
//
// * USER_INITIATED – A manual pipeline build request.
//
// *
// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
// pipeline, or from EventBridge.
//
// * IMPORT – A VM import created the image to use
// as the base image for the recipe.
BuildType BuildType
// The recipe that is used to create an Image Builder container image.
ContainerRecipe *ContainerRecipe
// The date on which this image was created.
DateCreated *string
// The distribution configuration used when creating this image.
DistributionConfiguration *DistributionConfiguration
// Collects additional information about the image being created, including the
// operating system (OS) version and package list. This information is used to
// enhance the overall experience of using EC2 Image Builder. Enabled by default.
EnhancedImageMetadataEnabled *bool
// The image recipe used when creating the image.
ImageRecipe *ImageRecipe
// The image tests configuration used when creating this image.
ImageTestsConfiguration *ImageTestsConfiguration
// The infrastructure used when creating this image.
InfrastructureConfiguration *InfrastructureConfiguration
// The name of the image.
Name *string
// The operating system version of the instance. For example, Amazon Linux 2,
// Ubuntu 18, or Microsoft Windows Server 2019.
OsVersion *string
// The output resources produced when creating this image.
OutputResources *OutputResources
// The platform of the image.
Platform Platform
// The Amazon Resource Name (ARN) of the image pipeline that created this image.
SourcePipelineArn *string
// The name of the image pipeline that created this image.
SourcePipelineName *string
// The state of the image.
State *ImageState
// The tags of the image.
Tags map[string]string
// Specifies whether this is an AMI or container image.
Type ImageType
// The semantic version of the image. The semantic version has four nodes: ../. You
// can assign values for the first three, and can filter on all of them.
// Assignment: For the first three nodes you can assign any positive integer value,
// including zero, with an upper limit of 2^30-1, or 1073741823 for each node.
// Image Builder automatically assigns the build number to the fourth node.
// Patterns: You can use any numeric pattern that adheres to the assignment
// requirements for the nodes that you can assign. For example, you might choose a
// software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
// Filtering: With semantic versioning, you have the flexibility to use wildcards
// (x) to specify the most recent versions or nodes when selecting the base image
// or components for your recipe. When you use a wildcard in any node, all nodes to
// the right of the first wildcard must also be wildcards.
Version *string
noSmithyDocumentSerde
}
// Represents a package installed on an Image Builder image.
type ImagePackage struct {
// The name of the package as reported to the operating system package manager.
PackageName *string
// The version of the package as reported to the operating system package manager.
PackageVersion *string
noSmithyDocumentSerde
}
// Details of an image pipeline.
type ImagePipeline struct {
// The Amazon Resource Name (ARN) of the image pipeline.
Arn *string
// The Amazon Resource Name (ARN) of the container recipe that is used for this
// pipeline.
ContainerRecipeArn *string
// The date on which this image pipeline was created.
DateCreated *string
// The date on which this image pipeline was last run.
DateLastRun *string
// The date on which this image pipeline will next be run.
DateNextRun *string
// The date on which this image pipeline was last updated.
DateUpdated *string
// The description of the image pipeline.
Description *string
// The Amazon Resource Name (ARN) of the distribution configuration associated with
// this image pipeline.
DistributionConfigurationArn *string
// Collects additional information about the image being created, including the
// operating system (OS) version and package list. This information is used to
// enhance the overall experience of using EC2 Image Builder. Enabled by default.
EnhancedImageMetadataEnabled *bool
// The Amazon Resource Name (ARN) of the image recipe associated with this image
// pipeline.
ImageRecipeArn *string
// The image tests configuration of the image pipeline.
ImageTestsConfiguration *ImageTestsConfiguration
// The Amazon Resource Name (ARN) of the infrastructure configuration associated
// with this image pipeline.
InfrastructureConfigurationArn *string
// The name of the image pipeline.
Name *string
// The platform of the image pipeline.
Platform Platform
// The schedule of the image pipeline.
Schedule *Schedule
// The status of the image pipeline.
Status PipelineStatus
// The tags of this image pipeline.
Tags map[string]string
noSmithyDocumentSerde
}
// An image recipe.
type ImageRecipe struct {
// Before you create a new AMI, Image Builder launches temporary Amazon EC2
// instances to build and test your image configuration. Instance configuration
// adds a layer of control over those instances. You can define settings and add
// scripts to run when an instance is launched from your AMI.
AdditionalInstanceConfiguration *AdditionalInstanceConfiguration
// The Amazon Resource Name (ARN) of the image recipe.
Arn *string
// The block device mappings to apply when creating images from this recipe.
BlockDeviceMappings []InstanceBlockDeviceMapping
// The components of the image recipe.
Components []ComponentConfiguration
// The date on which this image recipe was created.
DateCreated *string
// The description of the image recipe.
Description *string
// The name of the image recipe.
Name *string
// The owner of the image recipe.
Owner *string
// The base image of the image recipe.
ParentImage *string
// The platform of the image recipe.
Platform Platform
// The tags of the image recipe.
Tags map[string]string
// Specifies which type of image is created by the recipe - an AMI or a container
// image.
Type ImageType
// The version of the image recipe.
Version *string
// The working directory to be used during build and test workflows.
WorkingDirectory *string
noSmithyDocumentSerde
}
// A summary of an image recipe.
type ImageRecipeSummary struct {
// The Amazon Resource Name (ARN) of the image recipe.
Arn *string
// The date on which this image recipe was created.
DateCreated *string
// The name of the image recipe.
Name *string
// The owner of the image recipe.
Owner *string
// The base image of the image recipe.
ParentImage *string
// The platform of the image recipe.
Platform Platform
// The tags of the image recipe.
Tags map[string]string
noSmithyDocumentSerde
}
// Image state shows the image status and the reason for that status.
type ImageState struct {
// The reason for the image's status.
Reason *string
// The status of the image.
Status ImageStatus
noSmithyDocumentSerde
}
// An image summary.
type ImageSummary struct {
// The Amazon Resource Name (ARN) of the image.
Arn *string
// Indicates the type of build that created this image. The build can be initiated
// in the following ways:
//
// * USER_INITIATED – A manual pipeline build request.
//
// *
// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
// pipeline, or from EventBridge.
//
// * IMPORT – A VM import created the image to use
// as the base image for the recipe.
BuildType BuildType
// The date on which this image was created.
DateCreated *string
// The name of the image.
Name *string
// The operating system version of the instance. For example, Amazon Linux 2,
// Ubuntu 18, or Microsoft Windows Server 2019.
OsVersion *string
// The output resources produced when creating this image.
OutputResources *OutputResources
// The owner of the image.
Owner *string
// The platform of the image.
Platform Platform
// The state of the image.
State *ImageState
// The tags of the image.
Tags map[string]string
// Specifies whether this is an AMI or container image.
Type ImageType
// The version of the image.
Version *string
noSmithyDocumentSerde
}
// Configure image tests for your pipeline build. Tests run after building the
// image, to verify that the AMI or container image is valid before distributing
// it.
type ImageTestsConfiguration struct {
// Determines if tests should run after building the image. Image Builder defaults
// to enable tests to run following the image build, before image distribution.
ImageTestsEnabled *bool
// The maximum time in minutes that tests are permitted to run.
TimeoutMinutes *int32
noSmithyDocumentSerde
}
// The defining characteristics of a specific version of an Image Builder image.
type ImageVersion struct {
// The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
// Semantic versioning is included in each object's Amazon Resource Name (ARN), at
// the level that applies to that object as follows:
//
// * Versionless ARNs and Name
// ARNs do not include specific values in any of the nodes. The nodes are either
// left off entirely, or they are specified as wildcards, for example: x.x.x.
//
// *
// Version ARNs have only the first three nodes: ..
//
// * Build version ARNs have all
// four nodes, and point to a specific build for a specific version of an object.
Arn *string
// Indicates the type of build that created this image. The build can be initiated
// in the following ways:
//
// * USER_INITIATED – A manual pipeline build request.
//
// *
// SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder
// pipeline, or from EventBridge.
//
// * IMPORT – A VM import created the image to use
// as the base image for the recipe.
BuildType BuildType
// The date on which this specific version of the Image Builder image was created.
DateCreated *string
// The name of this specific version of an Image Builder image.
Name *string
// The operating system version of the Amazon EC2 build instance. For example,
// Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
OsVersion *string
// The owner of the image version.
Owner *string
// The platform of the image version, for example "Windows" or "Linux".
Platform Platform
// Specifies whether this image is an AMI or a container image.
Type ImageType
// Details for a specific version of an Image Builder image. This version follows
// the semantic version syntax. The semantic version has four nodes: ../. You can
// assign values for the first three, and can filter on all of them. Assignment:
// For the first three nodes you can assign any positive integer value, including
// zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder
// automatically assigns the build number to the fourth node. Patterns: You can use
// any numeric pattern that adheres to the assignment requirements for the nodes
// that you can assign. For example, you might choose a software version pattern,
// such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic
// versioning, you have the flexibility to use wildcards (x) to specify the most
// recent versions or nodes when selecting the base image or components for your
// recipe. When you use a wildcard in any node, all nodes to the right of the first
// wildcard must also be wildcards.
Version *string
noSmithyDocumentSerde
}
// Details of the infrastructure configuration.
type InfrastructureConfiguration struct {
// The Amazon Resource Name (ARN) of the infrastructure configuration.
Arn *string
// The date on which the infrastructure configuration was created.
DateCreated *string
// The date on which the infrastructure configuration was last updated.
DateUpdated *string
// The description of the infrastructure configuration.
Description *string
// The instance metadata option settings for the infrastructure configuration.
InstanceMetadataOptions *InstanceMetadataOptions
// The instance profile of the infrastructure configuration.
InstanceProfileName *string
// The instance types of the infrastructure configuration.
InstanceTypes []string
// The Amazon EC2 key pair of the infrastructure configuration.
KeyPair *string
// The logging configuration of the infrastructure configuration.
Logging *Logging
// The name of the infrastructure configuration.
Name *string
// The tags attached to the resource created by Image Builder.
ResourceTags map[string]string
// The security group IDs of the infrastructure configuration.
SecurityGroupIds []string
// The Amazon Resource Name (ARN) for the SNS topic to which we send image build
// event notifications. EC2 Image Builder is unable to send notifications to SNS
// topics that are encrypted using keys from other accounts. The key that is used
// to encrypt the SNS topic must reside in the account that the Image Builder
// service runs under.
SnsTopicArn *string
// The subnet ID of the infrastructure configuration.
SubnetId *string
// The tags of the infrastructure configuration.
Tags map[string]string
// The terminate instance on failure configuration of the infrastructure
// configuration.
TerminateInstanceOnFailure *bool
noSmithyDocumentSerde
}
// The infrastructure used when building Amazon EC2 AMIs.
type InfrastructureConfigurationSummary struct {
// The Amazon Resource Name (ARN) of the infrastructure configuration.
Arn *string
// The date on which the infrastructure configuration was created.
DateCreated *string
// The date on which the infrastructure configuration was last updated.
DateUpdated *string
// The description of the infrastructure configuration.
Description *string
// The instance profile of the infrastructure configuration.
InstanceProfileName *string
// The instance types of the infrastructure configuration.
InstanceTypes []string
// The name of the infrastructure configuration.
Name *string
// The tags attached to the image created by Image Builder.
ResourceTags map[string]string
// The tags of the infrastructure configuration.
Tags map[string]string
noSmithyDocumentSerde
}
// Defines block device mappings for the instance used to configure your image.
type InstanceBlockDeviceMapping struct {
// The device to which these mappings apply.
DeviceName *string
// Use to manage Amazon EBS-specific configuration for this mapping.
Ebs *EbsInstanceBlockDeviceSpecification
// Use to remove a mapping from the base image.
NoDevice *string
// Use to manage instance ephemeral devices.
VirtualName *string
noSmithyDocumentSerde
}
// Defines a custom base AMI and block device mapping configurations of an instance
// used for building and testing container images.
type InstanceConfiguration struct {
// Defines the block devices to attach for building an instance from this Image
// Builder AMI.
BlockDeviceMappings []InstanceBlockDeviceMapping
// The AMI ID to use as the base image for a container build and test instance. If
// not specified, Image Builder will use the appropriate ECS-optimized AMI as a
// base image.
Image *string
noSmithyDocumentSerde
}
// The instance metadata options that apply to the HTTP requests that pipeline
// builds use to launch EC2 build and test instances. For more information about
// instance metadata options, see Configure the instance metadata options
// (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html)
// in the Amazon EC2 User Guide for Linux instances, or Configure the instance
// metadata options
// (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html)
// in the Amazon EC2 Windows Guide for Windows instances.
type InstanceMetadataOptions struct {
// Limit the number of hops that an instance metadata request can traverse to reach
// its destination.
HttpPutResponseHopLimit *int32
// Indicates whether a signed token header is required for instance metadata
// retrieval requests. The values affect the response as follows:
//
// * required –
// When you retrieve the IAM role credentials, version 2.0 credentials are returned
// in all cases.
//
// * optional – You can include a signed token header in your
// request to retrieve instance metadata, or you can leave it out. If you include
// it, version 2.0 credentials are returned for the IAM role. Otherwise, version
// 1.0 credentials are returned.
//
// The default setting is optional.
HttpTokens *string
noSmithyDocumentSerde
}
// Describes the configuration for a launch permission. The launch permission
// modification request is sent to the Amazon EC2 ModifyImageAttribute
// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html)
// API on behalf of the user for each Region they have selected to distribute the
// AMI. To make an AMI public, set the launch permission authorized accounts to
// all. See the examples for making an AMI public at Amazon EC2
// ModifyImageAttribute
// (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html).
type LaunchPermissionConfiguration struct {
// The ARN for an Amazon Web Services Organization that you want to share your AMI
// with. For more information, see What is Organizations?
// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html).
OrganizationArns []string
// The ARN for an Organizations organizational unit (OU) that you want to share
// your AMI with. For more information about key concepts for Organizations, see
// Organizations terminology and concepts
// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html).
OrganizationalUnitArns []string
// The name of the group.
UserGroups []string
// The Amazon Web Services account ID.
UserIds []string
noSmithyDocumentSerde
}
// Identifies an Amazon EC2 launch template to use for a specific account.
type LaunchTemplateConfiguration struct {
// Identifies the Amazon EC2 launch template to use.
//
// This member is required.
LaunchTemplateId *string
// The account ID that this configuration applies to.
AccountId *string
// Set the specified Amazon EC2 launch template as the default launch template for
// the specified account.
SetDefaultVersion bool
noSmithyDocumentSerde
}
// Logging configuration defines where Image Builder uploads your logs.
type Logging struct {
// The Amazon S3 logging configuration.
S3Logs *S3Logs
noSmithyDocumentSerde
}
// The resources produced by this image.
type OutputResources struct {
// The Amazon EC2 AMIs created by this image.
Amis []Ami
// Container images that the pipeline has generated and stored in the output
// repository.
Containers []Container
noSmithyDocumentSerde
}
// Properties that configure export from your build instance to a compatible file
// format for your VM.
type S3ExportConfiguration struct {
// Export the updated image to one of the following supported disk image
// formats:
//
// * Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft
// Hyper-V virtualization products.
//
// * Stream-optimized ESX Virtual Machine Disk
// (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.
//
// *
// Raw – Raw format.
//
// This member is required.
DiskImageFormat DiskImageFormat
// The name of the role that grants VM Import/Export permission to export images to
// your S3 bucket.
//
// This member is required.
RoleName *string
// The S3 bucket in which to store the output disk images for your VM.
//
// This member is required.
S3Bucket *string
// The Amazon S3 path for the bucket where the output disk images for your VM are
// stored.
S3Prefix *string
noSmithyDocumentSerde
}
// Amazon S3 logging configuration.
type S3Logs struct {
// The S3 bucket in which to store the logs.
S3BucketName *string
// The Amazon S3 path to the bucket where the logs are stored.
S3KeyPrefix *string
noSmithyDocumentSerde
}
// A schedule configures how often and when a pipeline will automatically create a
// new image.
type Schedule struct {
// The condition configures when the pipeline should trigger a new image build.
// When the pipelineExecutionStartCondition is set to
// EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version
// filters on the base image or components in your image recipe, EC2 Image Builder
// will build a new image only when there are new versions of the image or
// components in your recipe that match the semantic version filter. When it is set
// to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON
// expression matches the current time. For semantic version syntax, see
// CreateComponent
// (https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html)
// in the EC2 Image Builder API Reference.
PipelineExecutionStartCondition PipelineExecutionStartCondition
// The cron expression determines how often EC2 Image Builder evaluates your
// pipelineExecutionStartCondition. For information on how to format a cron
// expression in Image Builder, see Use cron expressions in EC2 Image Builder
// (https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html).
ScheduleExpression *string
// The timezone that applies to the scheduling expression. For example, "Etc/UTC",
// "America/Los_Angeles" in the IANA timezone format
// (https://www.joda.org/joda-time/timezones.html). If not specified this defaults
// to UTC.
Timezone *string
noSmithyDocumentSerde
}
// Contains settings for the Systems Manager agent on your build instance.
type SystemsManagerAgent struct {
// Controls whether the Systems Manager agent is removed from your final build
// image, prior to creating the new AMI. If this is set to true, then the agent is
// removed from the final image. If it's set to false, then the agent is left in,
// so that it is included in the new AMI. The default value is false.
UninstallAfterBuild *bool
noSmithyDocumentSerde
}
// The container repository where the output container image is stored.
type TargetContainerRepository struct {
// The name of the container repository where the output container image is stored.
// This name is prefixed by the repository location.
//
// This member is required.
RepositoryName *string
// Specifies the service in which this image was registered.
//
// This member is required.
Service ContainerRepositoryService
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|