Package software.amazon.awssdk.services.appstream.model

Interface ImageBuilder.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ImageBuilder.Builder,ImageBuilder>, SdkBuilder<ImageBuilder.Builder,ImageBuilder>, SdkPojo
Enclosing class:
ImageBuilder
public static interface ImageBuilder.Builder extends SdkPojo, CopyableBuilder<ImageBuilder.Builder,ImageBuilder>

  • Method Details

    • name

      ImageBuilder.Builder name(String name)

      The name of the image builder.

      Parameters:
      name - The name of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      ImageBuilder.Builder arn(String arn)

      The ARN for the image builder.

      Parameters:
      arn - The ARN for the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageArn

      ImageBuilder.Builder imageArn(String imageArn)

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

      Parameters:
      imageArn - The ARN of the image from which this builder was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ImageBuilder.Builder description(String 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.

    • displayName

      ImageBuilder.Builder displayName(String displayName)

      The image builder name to display.

      Parameters:
      displayName - The image builder name to display.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      ImageBuilder.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC configuration of the image builder.

      Parameters:
      vpcConfig - The VPC configuration of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default ImageBuilder.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC configuration of the image builder.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceType

      ImageBuilder.Builder instanceType(String instanceType)

      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

      Parameters:
      instanceType - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platform

      ImageBuilder.Builder platform(String platform)

      The operating system platform of the image builder.

      Parameters:
      platform - The operating system platform of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      ImageBuilder.Builder platform(PlatformType platform)

      The operating system platform of the image builder.

      Parameters:
      platform - The operating system platform of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iamRoleArn

      ImageBuilder.Builder iamRoleArn(String iamRoleArn)

      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.

      Parameters:
      iamRoleArn - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ImageBuilder.Builder state(String state)

      The state of the image builder.

      Parameters:
      state - The state of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ImageBuilder.Builder state(ImageBuilderState state)

      The state of the image builder.

      Parameters:
      state - The state of the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateChangeReason

      ImageBuilder.Builder stateChangeReason(ImageBuilderStateChangeReason 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

      default ImageBuilder.Builder stateChangeReason(Consumer<ImageBuilderStateChangeReason.Builder> stateChangeReason)

      The reason why the last state change occurred.

      This is a convenience method that creates an instance of the ImageBuilderStateChangeReason.Builder avoiding the need to create one manually via ImageBuilderStateChangeReason.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stateChangeReason(ImageBuilderStateChangeReason).

      Parameters:
      stateChangeReason - a consumer that will call methods on ImageBuilderStateChangeReason.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTime

      ImageBuilder.Builder createdTime(Instant createdTime)

      The time stamp when the image builder was created.

      Parameters:
      createdTime - The time stamp when the image builder was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableDefaultInternetAccess

      ImageBuilder.Builder enableDefaultInternetAccess(Boolean enableDefaultInternetAccess)

      Enables or disables default internet access for the image builder.

      Parameters:
      enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainJoinInfo

      ImageBuilder.Builder domainJoinInfo(DomainJoinInfo domainJoinInfo)

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

      Parameters:
      domainJoinInfo - The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainJoinInfo

      default ImageBuilder.Builder domainJoinInfo(Consumer<DomainJoinInfo.Builder> domainJoinInfo)

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

      This is a convenience method that creates an instance of the DomainJoinInfo.Builder avoiding the need to create one manually via DomainJoinInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to domainJoinInfo(DomainJoinInfo).

      Parameters:
      domainJoinInfo - a consumer that will call methods on DomainJoinInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkAccessConfiguration

      ImageBuilder.Builder networkAccessConfiguration(NetworkAccessConfiguration networkAccessConfiguration)
      Sets the value of the NetworkAccessConfiguration property for this object.
      Parameters:
      networkAccessConfiguration - The new value for the NetworkAccessConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkAccessConfiguration

      default ImageBuilder.Builder networkAccessConfiguration(Consumer<NetworkAccessConfiguration.Builder> networkAccessConfiguration)
      Sets the value of the NetworkAccessConfiguration property for this object. This is a convenience method that creates an instance of the NetworkAccessConfiguration.Builder avoiding the need to create one manually via NetworkAccessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkAccessConfiguration(NetworkAccessConfiguration).

      Parameters:
      networkAccessConfiguration - a consumer that will call methods on NetworkAccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • imageBuilderErrors

      ImageBuilder.Builder imageBuilderErrors(Collection<ResourceError> imageBuilderErrors)

      The image builder errors.

      Parameters:
      imageBuilderErrors - The image builder errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageBuilderErrors

      ImageBuilder.Builder imageBuilderErrors(ResourceError... imageBuilderErrors)

      The image builder errors.

      Parameters:
      imageBuilderErrors - The image builder errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageBuilderErrors

      ImageBuilder.Builder imageBuilderErrors(Consumer<ResourceError.Builder>... imageBuilderErrors)

      The image builder errors.

      This is a convenience method that creates an instance of the ResourceError.Builder avoiding the need to create one manually via ResourceError.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageBuilderErrors(List<ResourceError>).

      Parameters:
      imageBuilderErrors - a consumer that will call methods on ResourceError.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appstreamAgentVersion

      ImageBuilder.Builder appstreamAgentVersion(String appstreamAgentVersion)

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

      Parameters:
      appstreamAgentVersion - The version of the AppStream 2.0 agent that is currently being used by the image builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessEndpoints

      ImageBuilder.Builder accessEndpoints(Collection<AccessEndpoint> accessEndpoints)

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

      Parameters:
      accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessEndpoints

      ImageBuilder.Builder accessEndpoints(AccessEndpoint... accessEndpoints)

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

      Parameters:
      accessEndpoints - The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessEndpoints

      ImageBuilder.Builder accessEndpoints(Consumer<AccessEndpoint.Builder>... accessEndpoints)

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

      This is a convenience method that creates an instance of the AccessEndpoint.Builder avoiding the need to create one manually via AccessEndpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessEndpoints(List<AccessEndpoint>).

      Parameters:
      accessEndpoints - a consumer that will call methods on AccessEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • latestAppstreamAgentVersion

      ImageBuilder.Builder latestAppstreamAgentVersion(String latestAppstreamAgentVersion)

      Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

      Parameters:
      latestAppstreamAgentVersion - Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • latestAppstreamAgentVersion

      ImageBuilder.Builder latestAppstreamAgentVersion(LatestAppstreamAgentVersion latestAppstreamAgentVersion)

      Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.

      Parameters:
      latestAppstreamAgentVersion - Indicates whether the image builder is using the latest AppStream 2.0 agent version or not.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: