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

Interface CreateImageBuilderRequest.Builder

All Superinterfaces:
AppStreamRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>, SdkBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateImageBuilderRequest
public static interface CreateImageBuilderRequest.Builder extends AppStreamRequest.Builder, SdkPojo, CopyableBuilder<CreateImageBuilderRequest.Builder,CreateImageBuilderRequest>

  • Method Details

    • name

      CreateImageBuilderRequest.Builder name(String name)

      A unique name for the image builder.

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

    • imageName

      CreateImageBuilderRequest.Builder imageName(String imageName)

      The name of the image used to create the image builder.

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

    • imageArn

      CreateImageBuilderRequest.Builder imageArn(String imageArn)

      The ARN of the public, private, or shared image to use.

      Parameters:
      imageArn - The ARN of the public, private, or shared image to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceType

      CreateImageBuilderRequest.Builder instanceType(String instanceType)

      The instance type to use when launching 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 to use when launching 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.

    • description

      CreateImageBuilderRequest.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

      CreateImageBuilderRequest.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

      CreateImageBuilderRequest.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC configuration for the image builder. You can specify only one subnet.

      Parameters:
      vpcConfig - The VPC configuration for the image builder. You can specify only one subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

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

      The VPC configuration for the image builder. You can specify only one subnet.

      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:

    • iamRoleArn

      CreateImageBuilderRequest.Builder iamRoleArn(String iamRoleArn)

      The Amazon Resource Name (ARN) of the IAM role to apply 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 Amazon Resource Name (ARN) of the IAM role to apply 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.

    • enableDefaultInternetAccess

      CreateImageBuilderRequest.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

      CreateImageBuilderRequest.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 CreateImageBuilderRequest.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:

    • appstreamAgentVersion

      CreateImageBuilderRequest.Builder appstreamAgentVersion(String appstreamAgentVersion)

      The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

      Parameters:
      appstreamAgentVersion - The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateImageBuilderRequest.Builder tags(Map<String,String> tags)

      The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

      _ . : / = + \ - @

      If you do not specify a value, the value is set to an empty string.

      For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

      Parameters:
      tags - The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

      _ . : / = + \ - @

      If you do not specify a value, the value is set to an empty string.

      For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

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

    • accessEndpoints

      CreateImageBuilderRequest.Builder accessEndpoints(Collection<AccessEndpoint> accessEndpoints)

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

      Parameters:
      accessEndpoints - The list of interface VPC endpoint (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

      CreateImageBuilderRequest.Builder accessEndpoints(AccessEndpoint... accessEndpoints)

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

      Parameters:
      accessEndpoints - The list of interface VPC endpoint (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

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

      The list of interface VPC endpoint (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:

    • overrideConfiguration

      CreateImageBuilderRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateImageBuilderRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.