/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace AppStream { namespace Model { /** *

Describes an image.

See Also:

AWS API * Reference

*/ class Image { public: AWS_APPSTREAM_API Image(); AWS_APPSTREAM_API Image(Aws::Utils::Json::JsonView jsonValue); AWS_APPSTREAM_API Image& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_APPSTREAM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the image.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the image.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the image.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the image.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the image.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the image.

*/ inline Image& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the image.

*/ inline Image& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the image.

*/ inline Image& WithName(const char* value) { SetName(value); return *this;} /** *

The ARN of the image.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The ARN of the image.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The ARN of the image.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The ARN of the image.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The ARN of the image.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The ARN of the image.

*/ inline Image& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The ARN of the image.

*/ inline Image& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The ARN of the image.

*/ inline Image& WithArn(const char* value) { SetArn(value); return *this;} /** *

The ARN of the image from which this image was created.

*/ inline const Aws::String& GetBaseImageArn() const{ return m_baseImageArn; } /** *

The ARN of the image from which this image was created.

*/ inline bool BaseImageArnHasBeenSet() const { return m_baseImageArnHasBeenSet; } /** *

The ARN of the image from which this image was created.

*/ inline void SetBaseImageArn(const Aws::String& value) { m_baseImageArnHasBeenSet = true; m_baseImageArn = value; } /** *

The ARN of the image from which this image was created.

*/ inline void SetBaseImageArn(Aws::String&& value) { m_baseImageArnHasBeenSet = true; m_baseImageArn = std::move(value); } /** *

The ARN of the image from which this image was created.

*/ inline void SetBaseImageArn(const char* value) { m_baseImageArnHasBeenSet = true; m_baseImageArn.assign(value); } /** *

The ARN of the image from which this image was created.

*/ inline Image& WithBaseImageArn(const Aws::String& value) { SetBaseImageArn(value); return *this;} /** *

The ARN of the image from which this image was created.

*/ inline Image& WithBaseImageArn(Aws::String&& value) { SetBaseImageArn(std::move(value)); return *this;} /** *

The ARN of the image from which this image was created.

*/ inline Image& WithBaseImageArn(const char* value) { SetBaseImageArn(value); return *this;} /** *

The image name to display.

*/ inline const Aws::String& GetDisplayName() const{ return m_displayName; } /** *

The image name to display.

*/ inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; } /** *

The image name to display.

*/ inline void SetDisplayName(const Aws::String& value) { m_displayNameHasBeenSet = true; m_displayName = value; } /** *

The image name to display.

*/ inline void SetDisplayName(Aws::String&& value) { m_displayNameHasBeenSet = true; m_displayName = std::move(value); } /** *

The image name to display.

*/ inline void SetDisplayName(const char* value) { m_displayNameHasBeenSet = true; m_displayName.assign(value); } /** *

The image name to display.

*/ inline Image& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;} /** *

The image name to display.

*/ inline Image& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;} /** *

The image name to display.

*/ inline Image& WithDisplayName(const char* value) { SetDisplayName(value); return *this;} /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline const ImageState& GetState() const{ return m_state; } /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline void SetState(const ImageState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline void SetState(ImageState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline Image& WithState(const ImageState& value) { SetState(value); return *this;} /** *

The image starts in the PENDING state. If image creation * succeeds, the state is AVAILABLE. If image creation fails, the * state is FAILED.

*/ inline Image& WithState(ImageState&& value) { SetState(std::move(value)); return *this;} /** *

Indicates whether the image is public or private.

*/ inline const VisibilityType& GetVisibility() const{ return m_visibility; } /** *

Indicates whether the image is public or private.

*/ inline bool VisibilityHasBeenSet() const { return m_visibilityHasBeenSet; } /** *

Indicates whether the image is public or private.

*/ inline void SetVisibility(const VisibilityType& value) { m_visibilityHasBeenSet = true; m_visibility = value; } /** *

Indicates whether the image is public or private.

*/ inline void SetVisibility(VisibilityType&& value) { m_visibilityHasBeenSet = true; m_visibility = std::move(value); } /** *

Indicates whether the image is public or private.

*/ inline Image& WithVisibility(const VisibilityType& value) { SetVisibility(value); return *this;} /** *

Indicates whether the image is public or private.

*/ inline Image& WithVisibility(VisibilityType&& value) { SetVisibility(std::move(value)); return *this;} /** *

Indicates whether an image builder can be launched from this image.

*/ inline bool GetImageBuilderSupported() const{ return m_imageBuilderSupported; } /** *

Indicates whether an image builder can be launched from this image.

*/ inline bool ImageBuilderSupportedHasBeenSet() const { return m_imageBuilderSupportedHasBeenSet; } /** *

Indicates whether an image builder can be launched from this image.

*/ inline void SetImageBuilderSupported(bool value) { m_imageBuilderSupportedHasBeenSet = true; m_imageBuilderSupported = value; } /** *

Indicates whether an image builder can be launched from this image.

*/ inline Image& WithImageBuilderSupported(bool value) { SetImageBuilderSupported(value); return *this;} /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline const Aws::String& GetImageBuilderName() const{ return m_imageBuilderName; } /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline bool ImageBuilderNameHasBeenSet() const { return m_imageBuilderNameHasBeenSet; } /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline void SetImageBuilderName(const Aws::String& value) { m_imageBuilderNameHasBeenSet = true; m_imageBuilderName = value; } /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline void SetImageBuilderName(Aws::String&& value) { m_imageBuilderNameHasBeenSet = true; m_imageBuilderName = std::move(value); } /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline void SetImageBuilderName(const char* value) { m_imageBuilderNameHasBeenSet = true; m_imageBuilderName.assign(value); } /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline Image& WithImageBuilderName(const Aws::String& value) { SetImageBuilderName(value); return *this;} /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline Image& WithImageBuilderName(Aws::String&& value) { SetImageBuilderName(std::move(value)); return *this;} /** *

The name of the image builder that was used to create the private image. If * the image is shared, this value is null.

*/ inline Image& WithImageBuilderName(const char* value) { SetImageBuilderName(value); return *this;} /** *

The operating system platform of the image.

*/ inline const PlatformType& GetPlatform() const{ return m_platform; } /** *

The operating system platform of the image.

*/ inline bool PlatformHasBeenSet() const { return m_platformHasBeenSet; } /** *

The operating system platform of the image.

*/ inline void SetPlatform(const PlatformType& value) { m_platformHasBeenSet = true; m_platform = value; } /** *

The operating system platform of the image.

*/ inline void SetPlatform(PlatformType&& value) { m_platformHasBeenSet = true; m_platform = std::move(value); } /** *

The operating system platform of the image.

*/ inline Image& WithPlatform(const PlatformType& value) { SetPlatform(value); return *this;} /** *

The operating system platform of the image.

*/ inline Image& WithPlatform(PlatformType&& value) { SetPlatform(std::move(value)); return *this;} /** *

The description to display.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description to display.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description to display.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description to display.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description to display.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description to display.

*/ inline Image& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description to display.

*/ inline Image& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description to display.

*/ inline Image& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The reason why the last state change occurred.

*/ inline const ImageStateChangeReason& GetStateChangeReason() const{ return m_stateChangeReason; } /** *

The reason why the last state change occurred.

*/ inline bool StateChangeReasonHasBeenSet() const { return m_stateChangeReasonHasBeenSet; } /** *

The reason why the last state change occurred.

*/ inline void SetStateChangeReason(const ImageStateChangeReason& value) { m_stateChangeReasonHasBeenSet = true; m_stateChangeReason = value; } /** *

The reason why the last state change occurred.

*/ inline void SetStateChangeReason(ImageStateChangeReason&& value) { m_stateChangeReasonHasBeenSet = true; m_stateChangeReason = std::move(value); } /** *

The reason why the last state change occurred.

*/ inline Image& WithStateChangeReason(const ImageStateChangeReason& value) { SetStateChangeReason(value); return *this;} /** *

The reason why the last state change occurred.

*/ inline Image& WithStateChangeReason(ImageStateChangeReason&& value) { SetStateChangeReason(std::move(value)); return *this;} /** *

The applications associated with the image.

*/ inline const Aws::Vector& GetApplications() const{ return m_applications; } /** *

The applications associated with the image.

*/ inline bool ApplicationsHasBeenSet() const { return m_applicationsHasBeenSet; } /** *

The applications associated with the image.

*/ inline void SetApplications(const Aws::Vector& value) { m_applicationsHasBeenSet = true; m_applications = value; } /** *

The applications associated with the image.

*/ inline void SetApplications(Aws::Vector&& value) { m_applicationsHasBeenSet = true; m_applications = std::move(value); } /** *

The applications associated with the image.

*/ inline Image& WithApplications(const Aws::Vector& value) { SetApplications(value); return *this;} /** *

The applications associated with the image.

*/ inline Image& WithApplications(Aws::Vector&& value) { SetApplications(std::move(value)); return *this;} /** *

The applications associated with the image.

*/ inline Image& AddApplications(const Application& value) { m_applicationsHasBeenSet = true; m_applications.push_back(value); return *this; } /** *

The applications associated with the image.

*/ inline Image& AddApplications(Application&& value) { m_applicationsHasBeenSet = true; m_applications.push_back(std::move(value)); return *this; } /** *

The time the image was created.

*/ inline const Aws::Utils::DateTime& GetCreatedTime() const{ return m_createdTime; } /** *

The time the image was created.

*/ inline bool CreatedTimeHasBeenSet() const { return m_createdTimeHasBeenSet; } /** *

The time the image was created.

*/ inline void SetCreatedTime(const Aws::Utils::DateTime& value) { m_createdTimeHasBeenSet = true; m_createdTime = value; } /** *

The time the image was created.

*/ inline void SetCreatedTime(Aws::Utils::DateTime&& value) { m_createdTimeHasBeenSet = true; m_createdTime = std::move(value); } /** *

The time the image was created.

*/ inline Image& WithCreatedTime(const Aws::Utils::DateTime& value) { SetCreatedTime(value); return *this;} /** *

The time the image was created.

*/ inline Image& WithCreatedTime(Aws::Utils::DateTime&& value) { SetCreatedTime(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Utils::DateTime& GetPublicBaseImageReleasedDate() const{ return m_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.

*/ inline bool PublicBaseImageReleasedDateHasBeenSet() const { return m_publicBaseImageReleasedDateHasBeenSet; } /** *

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.

*/ inline void SetPublicBaseImageReleasedDate(const Aws::Utils::DateTime& value) { m_publicBaseImageReleasedDateHasBeenSet = true; m_publicBaseImageReleasedDate = value; } /** *

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.

*/ inline void SetPublicBaseImageReleasedDate(Aws::Utils::DateTime&& value) { m_publicBaseImageReleasedDateHasBeenSet = true; m_publicBaseImageReleasedDate = std::move(value); } /** *

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.

*/ inline Image& WithPublicBaseImageReleasedDate(const Aws::Utils::DateTime& value) { SetPublicBaseImageReleasedDate(value); return *this;} /** *

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.

*/ inline Image& WithPublicBaseImageReleasedDate(Aws::Utils::DateTime&& value) { SetPublicBaseImageReleasedDate(std::move(value)); return *this;} /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline const Aws::String& GetAppstreamAgentVersion() const{ return m_appstreamAgentVersion; } /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline bool AppstreamAgentVersionHasBeenSet() const { return m_appstreamAgentVersionHasBeenSet; } /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline void SetAppstreamAgentVersion(const Aws::String& value) { m_appstreamAgentVersionHasBeenSet = true; m_appstreamAgentVersion = value; } /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline void SetAppstreamAgentVersion(Aws::String&& value) { m_appstreamAgentVersionHasBeenSet = true; m_appstreamAgentVersion = std::move(value); } /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline void SetAppstreamAgentVersion(const char* value) { m_appstreamAgentVersionHasBeenSet = true; m_appstreamAgentVersion.assign(value); } /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline Image& WithAppstreamAgentVersion(const Aws::String& value) { SetAppstreamAgentVersion(value); return *this;} /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline Image& WithAppstreamAgentVersion(Aws::String&& value) { SetAppstreamAgentVersion(std::move(value)); return *this;} /** *

The version of the AppStream 2.0 agent to use for instances that are launched * from this image.

*/ inline Image& WithAppstreamAgentVersion(const char* value) { SetAppstreamAgentVersion(value); return *this;} /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline const ImagePermissions& GetImagePermissions() const{ return m_imagePermissions; } /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline bool ImagePermissionsHasBeenSet() const { return m_imagePermissionsHasBeenSet; } /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline void SetImagePermissions(const ImagePermissions& value) { m_imagePermissionsHasBeenSet = true; m_imagePermissions = value; } /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline void SetImagePermissions(ImagePermissions&& value) { m_imagePermissionsHasBeenSet = true; m_imagePermissions = std::move(value); } /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline Image& WithImagePermissions(const ImagePermissions& value) { SetImagePermissions(value); return *this;} /** *

The permissions to provide to the destination AWS account for the specified * image.

*/ inline Image& WithImagePermissions(ImagePermissions&& value) { SetImagePermissions(std::move(value)); return *this;} /** *

Describes the errors that are returned when a new image can't be created.

*/ inline const Aws::Vector& GetImageErrors() const{ return m_imageErrors; } /** *

Describes the errors that are returned when a new image can't be created.

*/ inline bool ImageErrorsHasBeenSet() const { return m_imageErrorsHasBeenSet; } /** *

Describes the errors that are returned when a new image can't be created.

*/ inline void SetImageErrors(const Aws::Vector& value) { m_imageErrorsHasBeenSet = true; m_imageErrors = value; } /** *

Describes the errors that are returned when a new image can't be created.

*/ inline void SetImageErrors(Aws::Vector&& value) { m_imageErrorsHasBeenSet = true; m_imageErrors = std::move(value); } /** *

Describes the errors that are returned when a new image can't be created.

*/ inline Image& WithImageErrors(const Aws::Vector& value) { SetImageErrors(value); return *this;} /** *

Describes the errors that are returned when a new image can't be created.

*/ inline Image& WithImageErrors(Aws::Vector&& value) { SetImageErrors(std::move(value)); return *this;} /** *

Describes the errors that are returned when a new image can't be created.

*/ inline Image& AddImageErrors(const ResourceError& value) { m_imageErrorsHasBeenSet = true; m_imageErrors.push_back(value); return *this; } /** *

Describes the errors that are returned when a new image can't be created.

*/ inline Image& AddImageErrors(ResourceError&& value) { m_imageErrorsHasBeenSet = true; m_imageErrors.push_back(std::move(value)); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_arn; bool m_arnHasBeenSet = false; Aws::String m_baseImageArn; bool m_baseImageArnHasBeenSet = false; Aws::String m_displayName; bool m_displayNameHasBeenSet = false; ImageState m_state; bool m_stateHasBeenSet = false; VisibilityType m_visibility; bool m_visibilityHasBeenSet = false; bool m_imageBuilderSupported; bool m_imageBuilderSupportedHasBeenSet = false; Aws::String m_imageBuilderName; bool m_imageBuilderNameHasBeenSet = false; PlatformType m_platform; bool m_platformHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; ImageStateChangeReason m_stateChangeReason; bool m_stateChangeReasonHasBeenSet = false; Aws::Vector m_applications; bool m_applicationsHasBeenSet = false; Aws::Utils::DateTime m_createdTime; bool m_createdTimeHasBeenSet = false; Aws::Utils::DateTime m_publicBaseImageReleasedDate; bool m_publicBaseImageReleasedDateHasBeenSet = false; Aws::String m_appstreamAgentVersion; bool m_appstreamAgentVersionHasBeenSet = false; ImagePermissions m_imagePermissions; bool m_imagePermissionsHasBeenSet = false; Aws::Vector m_imageErrors; bool m_imageErrorsHasBeenSet = false; }; } // namespace Model } // namespace AppStream } // namespace Aws