Struct aws_sdk_appstream::types::ImageBuilder

#[non_exhaustive]
pub struct ImageBuilder {

    pub name: Option<String>,
    pub arn: Option<String>,
    pub image_arn: Option<String>,
    pub description: Option<String>,
    pub display_name: Option<String>,
    pub vpc_config: Option<VpcConfig>,
    pub instance_type: Option<String>,
    pub platform: Option<PlatformType>,
    pub iam_role_arn: Option<String>,
    pub state: Option<ImageBuilderState>,
    pub state_change_reason: Option<ImageBuilderStateChangeReason>,
    pub created_time: Option<DateTime>,
    pub enable_default_internet_access: Option<bool>,
    pub domain_join_info: Option<DomainJoinInfo>,
    pub network_access_configuration: Option<NetworkAccessConfiguration>,
    pub image_builder_errors: Option<Vec<ResourceError>>,
    pub appstream_agent_version: Option<String>,
    pub access_endpoints: Option<Vec<AccessEndpoint>>,
}

Describes a virtual machine that is used to create an image.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the image builder.

arn: Option<String>

The ARN for the image builder.

image_arn: Option<String>

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

description: Option<String>

The description to display.

display_name: Option<String>

The image builder name to display.

vpc_config: Option<VpcConfig>

The VPC configuration of the image builder.

instance_type: Option<String>

The instance type for the image builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

platform: Option<PlatformType>

The operating system platform of the image builder.

iam_role_arn: Option<String>

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

state: Option<ImageBuilderState>

The state of the image builder.

state_change_reason: Option<ImageBuilderStateChangeReason>

The reason why the last state change occurred.

created_time: Option<DateTime>

The time stamp when the image builder was created.

enable_default_internet_access: Option<bool>

Enables or disables default internet access for the image builder.

domain_join_info: Option<DomainJoinInfo>

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

network_access_configuration: Option<NetworkAccessConfiguration>

Describes the network details of the fleet or image builder instance.

image_builder_errors: Option<Vec<ResourceError>>

The image builder errors.

appstream_agent_version: Option<String>

The version of the AppStream 2.0 agent that is currently being used by the image builder.

access_endpoints: Option<Vec<AccessEndpoint>>

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

Implementations

impl ImageBuilder

pub fn name(&self) -> Option<&str>

The name of the image builder.

pub fn arn(&self) -> Option<&str>

The ARN for the image builder.

pub fn image_arn(&self) -> Option<&str>

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

pub fn description(&self) -> Option<&str>

The description to display.

pub fn display_name(&self) -> Option<&str>

The image builder name to display.

pub fn vpc_config(&self) -> Option<&VpcConfig>

The VPC configuration of the image builder.

pub fn instance_type(&self) -> Option<&str>

The instance type for the image builder. The following instance types are available:

• stream.standard.small

• stream.standard.medium

• stream.standard.large

• stream.compute.large

• stream.compute.xlarge

• stream.compute.2xlarge

• stream.compute.4xlarge

• stream.compute.8xlarge

• stream.memory.large

• stream.memory.xlarge

• stream.memory.2xlarge

• stream.memory.4xlarge

• stream.memory.8xlarge

• stream.memory.z1d.large

• stream.memory.z1d.xlarge

• stream.memory.z1d.2xlarge

• stream.memory.z1d.3xlarge

• stream.memory.z1d.6xlarge

• stream.memory.z1d.12xlarge

• stream.graphics-design.large

• stream.graphics-design.xlarge

• stream.graphics-design.2xlarge

• stream.graphics-design.4xlarge

• stream.graphics-desktop.2xlarge

• stream.graphics.g4dn.xlarge

• stream.graphics.g4dn.2xlarge

• stream.graphics.g4dn.4xlarge

• stream.graphics.g4dn.8xlarge

• stream.graphics.g4dn.12xlarge

• stream.graphics.g4dn.16xlarge

• stream.graphics-pro.4xlarge

• stream.graphics-pro.8xlarge

• stream.graphics-pro.16xlarge

pub fn platform(&self) -> Option<&PlatformType>

The operating system platform of the image builder.

pub fn iam_role_arn(&self) -> Option<&str>

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

pub fn state(&self) -> Option<&ImageBuilderState>

The state of the image builder.

pub fn state_change_reason(&self) -> Option<&ImageBuilderStateChangeReason>

The reason why the last state change occurred.

pub fn created_time(&self) -> Option<&DateTime>

The time stamp when the image builder was created.

pub fn enable_default_internet_access(&self) -> Option<bool>

Enables or disables default internet access for the image builder.

pub fn domain_join_info(&self) -> Option<&DomainJoinInfo>

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

pub fn network_access_configuration( &self ) -> Option<&NetworkAccessConfiguration>

Describes the network details of the fleet or image builder instance.

pub fn image_builder_errors(&self) -> &[ResourceError]

The image builder errors.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .image_builder_errors.is_none().

pub fn appstream_agent_version(&self) -> Option<&str>

The version of the AppStream 2.0 agent that is currently being used by the image builder.

pub fn access_endpoints(&self) -> &[AccessEndpoint]

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .access_endpoints.is_none().

impl ImageBuilder

pub fn builder() -> ImageBuilderBuilder

Creates a new builder-style object to manufacture ImageBuilder.

Trait Implementations

impl Clone for ImageBuilder

fn clone(&self) -> ImageBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ImageBuilder

fn eq(&self, other: &ImageBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImageBuilder