Interface CreateImportedImageRequest.Builder

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

  • Method Details

    • name

      CreateImportedImageRequest.Builder name(String name)

      A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.

      Parameters:
      name - A unique name for the imported image. The name must be between 1 and 100 characters and can contain letters, numbers, underscores, periods, and hyphens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceAmiId

      CreateImportedImageRequest.Builder sourceAmiId(String sourceAmiId)

      The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.

      Parameters:
      sourceAmiId - The ID of the EC2 AMI to import. The AMI must meet specific requirements including Windows Server 2022 Full Base, UEFI boot mode, TPM 2.0 support, and proper drivers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleArn

      CreateImportedImageRequest.Builder iamRoleArn(String iamRoleArn)

      The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.

      Parameters:
      iamRoleArn - The ARN of the IAM role that allows WorkSpaces Applications to access your AMI. The role must have permissions to modify image attributes and describe images, with a trust relationship allowing appstream.amazonaws.com to assume the role.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateImportedImageRequest.Builder description(String description)

      An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.

      Parameters:
      description - An optional description for the imported image. The description must match approved regex patterns and can be up to 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      CreateImportedImageRequest.Builder displayName(String displayName)

      An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.

      Parameters:
      displayName - An optional display name for the imported image. The display name must match approved regex patterns and can be up to 100 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

      The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.

      Parameters:
      tags - The tags to apply to the imported image. Tags help you organize and manage your WorkSpaces Applications resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeValidationConfig

      CreateImportedImageRequest.Builder runtimeValidationConfig(RuntimeValidationConfig runtimeValidationConfig)

      Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.

      Parameters:
      runtimeValidationConfig - Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeValidationConfig

      default CreateImportedImageRequest.Builder runtimeValidationConfig(Consumer<RuntimeValidationConfig.Builder> runtimeValidationConfig)

      Configuration for runtime validation of the imported image. When specified, WorkSpaces Applications provisions an instance to test streaming functionality, which helps ensure the image is suitable for use.

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

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

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

    • agentSoftwareVersion

      CreateImportedImageRequest.Builder agentSoftwareVersion(String agentSoftwareVersion)

      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.

      Parameters:
      agentSoftwareVersion - The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • agentSoftwareVersion

      CreateImportedImageRequest.Builder agentSoftwareVersion(AgentSoftwareVersion agentSoftwareVersion)

      The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.

      Parameters:
      agentSoftwareVersion - The version of the WorkSpaces Applications agent to use for the imported image. Choose CURRENT_LATEST to use the agent version available at the time of import, or ALWAYS_LATEST to automatically update to the latest agent version when new versions are released.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • appCatalogConfig

      CreateImportedImageRequest.Builder appCatalogConfig(Collection<ApplicationConfig> appCatalogConfig)

      Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.

      Parameters:
      appCatalogConfig - Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • appCatalogConfig

      CreateImportedImageRequest.Builder appCatalogConfig(ApplicationConfig... appCatalogConfig)

      Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.

      Parameters:
      appCatalogConfig - Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • appCatalogConfig

      CreateImportedImageRequest.Builder appCatalogConfig(Consumer<ApplicationConfig.Builder>... appCatalogConfig)

      Configuration for the application catalog of the imported image. This allows you to specify applications available for streaming, including their paths, icons, and launch parameters. This field contains sensitive data.

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

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

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

    • dryRun

      CreateImportedImageRequest.Builder dryRun(Boolean dryRun)

      When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.

      Parameters:
      dryRun - When set to true, performs validation checks without actually creating the imported image. Use this to verify your configuration before executing the actual import operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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