Interface Image.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Image.Builder,
,Image> SdkBuilder<Image.Builder,
,Image> SdkPojo
- Enclosing class:
Image
-
Method Summary
Modifier and TypeMethodDescriptionapplications
(Collection<Application> applications) The applications associated with the image.applications
(Consumer<Application.Builder>... applications) The applications associated with the image.applications
(Application... applications) The applications associated with the image.appstreamAgentVersion
(String appstreamAgentVersion) The version of the AppStream 2.0 agent to use for instances that are launched from this image.The ARN of the image.baseImageArn
(String baseImageArn) The ARN of the image from which this image was created.createdTime
(Instant createdTime) The time the image was created.description
(String description) The description to display.displayName
(String displayName) The image name to display.imageBuilderName
(String imageBuilderName) The name of the image builder that was used to create the private image.imageBuilderSupported
(Boolean imageBuilderSupported) Indicates whether an image builder can be launched from this image.imageErrors
(Collection<ResourceError> imageErrors) Describes the errors that are returned when a new image can't be created.imageErrors
(Consumer<ResourceError.Builder>... imageErrors) Describes the errors that are returned when a new image can't be created.imageErrors
(ResourceError... imageErrors) Describes the errors that are returned when a new image can't be created.default Image.Builder
imagePermissions
(Consumer<ImagePermissions.Builder> imagePermissions) The permissions to provide to the destination AWS account for the specified image.imagePermissions
(ImagePermissions imagePermissions) The permissions to provide to the destination AWS account for the specified image.The name of the image.The operating system platform of the image.platform
(PlatformType platform) The operating system platform of the image.publicBaseImageReleasedDate
(Instant publicBaseImageReleasedDate) The release date of the public base image.The image starts in thePENDING
state.state
(ImageState state) The image starts in thePENDING
state.default Image.Builder
stateChangeReason
(Consumer<ImageStateChangeReason.Builder> stateChangeReason) The reason why the last state change occurred.stateChangeReason
(ImageStateChangeReason stateChangeReason) The reason why the last state change occurred.visibility
(String visibility) Indicates whether the image is public or private.visibility
(VisibilityType visibility) Indicates whether the image is public or private.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
-
name
The name of the image.
- Parameters:
name
- The name of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The ARN of the image.
- Parameters:
arn
- The ARN of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
baseImageArn
The ARN of the image from which this image was created.
- Parameters:
baseImageArn
- The ARN of the image from which this image was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
The image name to display.
- Parameters:
displayName
- The image name to display.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.- Parameters:
state
- The image starts in thePENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.- Parameters:
state
- The image starts in thePENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
visibility
Indicates whether the image is public or private.
- Parameters:
visibility
- Indicates whether the image is public or private.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
visibility
Indicates whether the image is public or private.
- Parameters:
visibility
- Indicates whether the image is public or private.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageBuilderSupported
Indicates whether an image builder can be launched from this image.
- Parameters:
imageBuilderSupported
- Indicates whether an image builder can be launched from this image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageBuilderName
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
- Parameters:
imageBuilderName
- The name of the image builder that was used to create the private image. If the image is shared, this value is null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platform
The operating system platform of the image.
- Parameters:
platform
- The operating system platform of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platform
The operating system platform of the image.
- Parameters:
platform
- The operating system platform of the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
The description to display.
- Parameters:
description
- The description to display.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateChangeReason
The reason why the last state change occurred.
- Parameters:
stateChangeReason
- The reason why the last state change occurred.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateChangeReason
The reason why the last state change occurred.
This is a convenience method that creates an instance of theImageStateChangeReason.Builder
avoiding the need to create one manually viaImageStateChangeReason.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostateChangeReason(ImageStateChangeReason)
.- Parameters:
stateChangeReason
- a consumer that will call methods onImageStateChangeReason.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
applications
The applications associated with the image.
- Parameters:
applications
- The applications associated with the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applications
The applications associated with the image.
- Parameters:
applications
- The applications associated with the image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
applications
The applications associated with the image.
This is a convenience method that creates an instance of theApplication.Builder
avoiding the need to create one manually viaApplication.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toapplications(List<Application>)
.- Parameters:
applications
- a consumer that will call methods onApplication.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdTime
The time the image was created.
- Parameters:
createdTime
- The time the image was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publicBaseImageReleasedDate
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
- Parameters:
publicBaseImageReleasedDate
- The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appstreamAgentVersion
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
- Parameters:
appstreamAgentVersion
- The version of the AppStream 2.0 agent to use for instances that are launched from this image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imagePermissions
The permissions to provide to the destination AWS account for the specified image.
- Parameters:
imagePermissions
- The permissions to provide to the destination AWS account for the specified image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imagePermissions
The permissions to provide to the destination AWS account for the specified image.
This is a convenience method that creates an instance of theImagePermissions.Builder
avoiding the need to create one manually viaImagePermissions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimagePermissions(ImagePermissions)
.- Parameters:
imagePermissions
- a consumer that will call methods onImagePermissions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageErrors
Describes the errors that are returned when a new image can't be created.
- Parameters:
imageErrors
- Describes the errors that are returned when a new image can't be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageErrors
Describes the errors that are returned when a new image can't be created.
- Parameters:
imageErrors
- Describes the errors that are returned when a new image can't be created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageErrors
Describes the errors that are returned when a new image can't be created.
This is a convenience method that creates an instance of theResourceError.Builder
avoiding the need to create one manually viaResourceError.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimageErrors(List<ResourceError>)
.- Parameters:
imageErrors
- a consumer that will call methods onResourceError.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-