Interface Image.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Image.Builder,
,Image> SdkBuilder<Image.Builder,
,Image> SdkPojo
- Enclosing class:
Image
-
Method Summary
Modifier and TypeMethodDescriptionarchitecture
(String architecture) The architecture of the image.architecture
(ArchitectureValues architecture) The architecture of the image.blockDeviceMappings
(Collection<BlockDeviceMapping> blockDeviceMappings) Any block device mapping entries.blockDeviceMappings
(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) Any block device mapping entries.blockDeviceMappings
(BlockDeviceMapping... blockDeviceMappings) Any block device mapping entries.The boot mode of the image.bootMode
(BootModeValues bootMode) The boot mode of the image.creationDate
(String creationDate) The date and time the image was created.deprecationTime
(String deprecationTime) The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.deregistrationProtection
(String deregistrationProtection) Indicates whether deregistration protection is enabled for the AMI.description
(String description) The description of the AMI that was provided during image creation.enaSupport
(Boolean enaSupport) Specifies whether enhanced networking with ENA is enabled.hypervisor
(String hypervisor) The hypervisor type of the image.hypervisor
(HypervisorType hypervisor) The hypervisor type of the image.The ID of the AMI.imageLocation
(String imageLocation) The location of the AMI.imageOwnerAlias
(String imageOwnerAlias) The owner alias (amazon
|aws-marketplace
).The type of image.imageType
(ImageTypeValues imageType) The type of image.imdsSupport
(String imdsSupport) Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.imdsSupport
(ImdsSupportValues imdsSupport) Ifv2.0
, it indicates that IMDSv2 is specified in the AMI.The kernel associated with the image, if any.lastLaunchedTime
(String lastLaunchedTime) The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance.The name of the AMI that was provided during image creation.The ID of the Amazon Web Services account that owns the image.This value is set towindows
for Windows AMIs; otherwise, it is blank.platform
(PlatformValues platform) This value is set towindows
for Windows AMIs; otherwise, it is blank.platformDetails
(String platformDetails) The platform details associated with the billing code of the AMI.productCodes
(Collection<ProductCode> productCodes) Any product codes associated with the AMI.productCodes
(Consumer<ProductCode.Builder>... productCodes) Any product codes associated with the AMI.productCodes
(ProductCode... productCodes) Any product codes associated with the AMI.publicLaunchPermissions
(Boolean publicLaunchPermissions) Indicates whether the image has public launch permissions.The RAM disk associated with the image, if any.rootDeviceName
(String rootDeviceName) The device name of the root device volume (for example,/dev/sda1
).rootDeviceType
(String rootDeviceType) The type of root device used by the AMI.rootDeviceType
(DeviceType rootDeviceType) The type of root device used by the AMI.sourceInstanceId
(String sourceInstanceId) The ID of the instance that the AMI was created from if the AMI was created using CreateImage.sriovNetSupport
(String sriovNetSupport) Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.The current state of the AMI.state
(ImageState state) The current state of the AMI.default Image.Builder
stateReason
(Consumer<StateReason.Builder> stateReason) The reason for the state change.stateReason
(StateReason stateReason) The reason for the state change.tags
(Collection<Tag> tags) Any tags assigned to the image.tags
(Consumer<Tag.Builder>... tags) Any tags assigned to the image.Any tags assigned to the image.tpmSupport
(String tpmSupport) If the image is configured for NitroTPM support, the value isv2.0
.tpmSupport
(TpmSupportValues tpmSupport) If the image is configured for NitroTPM support, the value isv2.0
.usageOperation
(String usageOperation) The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.virtualizationType
(String virtualizationType) The type of virtualization of the AMI.virtualizationType
(VirtualizationType virtualizationType) The type of virtualization of the AMI.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
architecture
The architecture of the image.
- Parameters:
architecture
- The architecture of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
architecture
The architecture of the image.
- Parameters:
architecture
- The architecture of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationDate
The date and time the image was created.
- Parameters:
creationDate
- The date and time the image was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageId
The ID of the AMI.
- Parameters:
imageId
- The ID of the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageLocation
The location of the AMI.
- Parameters:
imageLocation
- The location of the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageType
The type of image.
- Parameters:
imageType
- The type of image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageType
The type of image.
- Parameters:
imageType
- The type of image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kernelId
The kernel associated with the image, if any. Only applicable for machine images.
- Parameters:
kernelId
- The kernel associated with the image, if any. Only applicable for machine images.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownerId
The ID of the Amazon Web Services account that owns the image.
- Parameters:
ownerId
- The ID of the Amazon Web Services account that owns the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platform
This value is set to
windows
for Windows AMIs; otherwise, it is blank.- Parameters:
platform
- This value is set towindows
for Windows AMIs; otherwise, it is blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platform
This value is set to
windows
for Windows AMIs; otherwise, it is blank.- Parameters:
platform
- This value is set towindows
for Windows AMIs; otherwise, it is blank.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platformDetails
The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.
- Parameters:
platformDetails
- The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
usageOperation
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.- Parameters:
usageOperation
- The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.usageOperation
corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productCodes
Any product codes associated with the AMI.
- Parameters:
productCodes
- Any product codes associated with the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productCodes
Any product codes associated with the AMI.
- Parameters:
productCodes
- Any product codes associated with the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
productCodes
Any product codes associated with the AMI.
This is a convenience method that creates an instance of theProductCode.Builder
avoiding the need to create one manually viaProductCode.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toproductCodes(List<ProductCode>)
.- Parameters:
productCodes
- a consumer that will call methods onProductCode.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
ramdiskId
The RAM disk associated with the image, if any. Only applicable for machine images.
- Parameters:
ramdiskId
- The RAM disk associated with the image, if any. Only applicable for machine images.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- Parameters:
state
- The current state of the AMI. If the state isavailable
, the image is successfully registered and can be used to launch an instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state of the AMI. If the state is
available
, the image is successfully registered and can be used to launch an instance.- Parameters:
state
- The current state of the AMI. If the state isavailable
, the image is successfully registered and can be used to launch an instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
blockDeviceMappings
Any block device mapping entries.
- Parameters:
blockDeviceMappings
- Any block device mapping entries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
Any block device mapping entries.
- Parameters:
blockDeviceMappings
- Any block device mapping entries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
Any block device mapping entries.
This is a convenience method that creates an instance of theBlockDeviceMapping.Builder
avoiding the need to create one manually viaBlockDeviceMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toblockDeviceMappings(List<BlockDeviceMapping>)
.- Parameters:
blockDeviceMappings
- a consumer that will call methods onBlockDeviceMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
The description of the AMI that was provided during image creation.
- Parameters:
description
- The description of the AMI that was provided during image creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enaSupport
Specifies whether enhanced networking with ENA is enabled.
- Parameters:
enaSupport
- Specifies whether enhanced networking with ENA is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hypervisor
The hypervisor type of the image. Only
xen
is supported.ovm
is not supported.- Parameters:
hypervisor
- The hypervisor type of the image. Onlyxen
is supported.ovm
is not supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hypervisor
The hypervisor type of the image. Only
xen
is supported.ovm
is not supported.- Parameters:
hypervisor
- The hypervisor type of the image. Onlyxen
is supported.ovm
is not supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageOwnerAlias
The owner alias (
amazon
|aws-marketplace
).- Parameters:
imageOwnerAlias
- The owner alias (amazon
|aws-marketplace
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the AMI that was provided during image creation.
- Parameters:
name
- The name of the AMI that was provided during image creation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rootDeviceName
The device name of the root device volume (for example,
/dev/sda1
).- Parameters:
rootDeviceName
- The device name of the root device volume (for example,/dev/sda1
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rootDeviceType
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- Parameters:
rootDeviceType
- The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rootDeviceType
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
- Parameters:
rootDeviceType
- The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sriovNetSupport
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
- Parameters:
sriovNetSupport
- Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateReason
The reason for the state change.
- Parameters:
stateReason
- The reason for the state change.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateReason
The reason for the state change.
This is a convenience method that creates an instance of theStateReason.Builder
avoiding the need to create one manually viaStateReason.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostateReason(StateReason)
.- Parameters:
stateReason
- a consumer that will call methods onStateReason.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Any tags assigned to the image.
- Parameters:
tags
- Any tags assigned to the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Any tags assigned to the image.
- Parameters:
tags
- Any tags assigned to the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Any tags assigned to the image.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
virtualizationType
The type of virtualization of the AMI.
- Parameters:
virtualizationType
- The type of virtualization of the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
virtualizationType
The type of virtualization of the AMI.
- Parameters:
virtualizationType
- The type of virtualization of the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bootMode
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
- Parameters:
bootMode
- The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bootMode
The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.
- Parameters:
bootMode
- The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tpmSupport
If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.- Parameters:
tpmSupport
- If the image is configured for NitroTPM support, the value isv2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tpmSupport
If the image is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.- Parameters:
tpmSupport
- If the image is configured for NitroTPM support, the value isv2.0
. For more information, see NitroTPM in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deprecationTime
The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
- Parameters:
deprecationTime
- The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imdsSupport
If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.- Parameters:
imdsSupport
- Ifv2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imdsSupport
If
v2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.- Parameters:
imdsSupport
- Ifv2.0
, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokens
automatically set torequired
so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimit
is set to2
. For more information, see Configure the AMI in the Amazon EC2 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceInstanceId
The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.
- Parameters:
sourceInstanceId
- The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deregistrationProtection
Indicates whether deregistration protection is enabled for the AMI.
- Parameters:
deregistrationProtection
- Indicates whether deregistration protection is enabled for the AMI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastLaunchedTime
The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime
data is available starting April 2017.- Parameters:
lastLaunchedTime
- The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.lastLaunchedTime
data is available starting April 2017.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicLaunchPermissions
Indicates whether the image has public launch permissions. The value is
true
if this image has public launch permissions orfalse
if it has only implicit and explicit launch permissions.- Parameters:
publicLaunchPermissions
- Indicates whether the image has public launch permissions. The value istrue
if this image has public launch permissions orfalse
if it has only implicit and explicit launch permissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-