All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.appstream.model.CreateImageBuilderRequest Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon AppStream module holds the client classes that are used for communicating with Amazon AppStream.

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.appstream.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateImageBuilderRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

* A unique name for the image builder. *

*/ private String name; /** *

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

*/ private String imageName; /** *

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

*/ private String imageArn; /** *

* 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 *

    *
  • *
*/ private String instanceType; /** *

* The description to display. *

*/ private String description; /** *

* The image builder name to display. *

*/ private String displayName; /** *

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

*/ private VpcConfig vpcConfig; /** *

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

*/ private String iamRoleArn; /** *

* Enables or disables default internet access for the image builder. *

*/ private Boolean enableDefaultInternetAccess; /** *

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

*/ private DomainJoinInfo domainJoinInfo; /** *

* 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]. *

*/ private String appstreamAgentVersion; /** *

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

*/ private java.util.Map tags; /** *

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

*/ private java.util.List accessEndpoints; /** *

* A unique name for the image builder. *

* * @param name * A unique name for the image builder. */ public void setName(String name) { this.name = name; } /** *

* A unique name for the image builder. *

* * @return A unique name for the image builder. */ public String getName() { return this.name; } /** *

* A unique name for the image builder. *

* * @param name * A unique name for the image builder. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withName(String name) { setName(name); return this; } /** *

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

* * @param imageName * The name of the image used to create the image builder. */ public void setImageName(String imageName) { this.imageName = imageName; } /** *

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

* * @return The name of the image used to create the image builder. */ public String getImageName() { return this.imageName; } /** *

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

* * @param imageName * The name of the image used to create the image builder. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withImageName(String imageName) { setImageName(imageName); return this; } /** *

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

* * @param imageArn * The ARN of the public, private, or shared image to use. */ public void setImageArn(String imageArn) { this.imageArn = imageArn; } /** *

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

* * @return The ARN of the public, private, or shared image to use. */ public String getImageArn() { return this.imageArn; } /** *

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

* * @param imageArn * The ARN of the public, private, or shared image to use. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withImageArn(String imageArn) { setImageArn(imageArn); return this; } /** *

* 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 *

    *
  • *
* * @param 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 *

    *
  • */ public void setInstanceType(String instanceType) { this.instanceType = 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 *

      *
    • *
    * * @return 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 *

      *
    • */ public String getInstanceType() { return this.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 *

        *
      • *
      * * @param 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 *

        *
      • * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withInstanceType(String instanceType) { setInstanceType(instanceType); return this; } /** *

        * The description to display. *

        * * @param description * The description to display. */ public void setDescription(String description) { this.description = description; } /** *

        * The description to display. *

        * * @return The description to display. */ public String getDescription() { return this.description; } /** *

        * The description to display. *

        * * @param description * The description to display. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withDescription(String description) { setDescription(description); return this; } /** *

        * The image builder name to display. *

        * * @param displayName * The image builder name to display. */ public void setDisplayName(String displayName) { this.displayName = displayName; } /** *

        * The image builder name to display. *

        * * @return The image builder name to display. */ public String getDisplayName() { return this.displayName; } /** *

        * The image builder name to display. *

        * * @param displayName * The image builder name to display. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withDisplayName(String displayName) { setDisplayName(displayName); return this; } /** *

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

        * * @param vpcConfig * The VPC configuration for the image builder. You can specify only one subnet. */ public void setVpcConfig(VpcConfig vpcConfig) { this.vpcConfig = vpcConfig; } /** *

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

        * * @return The VPC configuration for the image builder. You can specify only one subnet. */ public VpcConfig getVpcConfig() { return this.vpcConfig; } /** *

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

        * * @param vpcConfig * The VPC configuration for the image builder. You can specify only one subnet. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withVpcConfig(VpcConfig vpcConfig) { setVpcConfig(vpcConfig); return this; } /** *

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

        * * @param 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. */ public void setIamRoleArn(String iamRoleArn) { this.iamRoleArn = 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. *

        * * @return 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. */ public String getIamRoleArn() { return this.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. *

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withIamRoleArn(String iamRoleArn) { setIamRoleArn(iamRoleArn); return this; } /** *

        * Enables or disables default internet access for the image builder. *

        * * @param enableDefaultInternetAccess * Enables or disables default internet access for the image builder. */ public void setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess) { this.enableDefaultInternetAccess = enableDefaultInternetAccess; } /** *

        * Enables or disables default internet access for the image builder. *

        * * @return Enables or disables default internet access for the image builder. */ public Boolean getEnableDefaultInternetAccess() { return this.enableDefaultInternetAccess; } /** *

        * Enables or disables default internet access for the image builder. *

        * * @param enableDefaultInternetAccess * Enables or disables default internet access for the image builder. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess) { setEnableDefaultInternetAccess(enableDefaultInternetAccess); return this; } /** *

        * Enables or disables default internet access for the image builder. *

        * * @return Enables or disables default internet access for the image builder. */ public Boolean isEnableDefaultInternetAccess() { return this.enableDefaultInternetAccess; } /** *

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

        * * @param domainJoinInfo * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft * Active Directory domain. */ public void setDomainJoinInfo(DomainJoinInfo domainJoinInfo) { this.domainJoinInfo = domainJoinInfo; } /** *

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

        * * @return The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft * Active Directory domain. */ public DomainJoinInfo getDomainJoinInfo() { return this.domainJoinInfo; } /** *

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

        * * @param domainJoinInfo * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft * Active Directory domain. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withDomainJoinInfo(DomainJoinInfo domainJoinInfo) { setDomainJoinInfo(domainJoinInfo); return this; } /** *

        * 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]. *

        * * @param 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]. */ public void setAppstreamAgentVersion(String appstreamAgentVersion) { this.appstreamAgentVersion = 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]. *

        * * @return 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]. */ public String getAppstreamAgentVersion() { return this.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]. *

        * * @param 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]. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withAppstreamAgentVersion(String appstreamAgentVersion) { setAppstreamAgentVersion(appstreamAgentVersion); return this; } /** *

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

        * * @return 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. */ public java.util.Map getTags() { return 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. *

        * * @param 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. */ public void setTags(java.util.Map tags) { this.tags = 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. *

        * * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withTags(java.util.Map tags) { setTags(tags); return this; } /** * Add a single Tags entry * * @see CreateImageBuilderRequest#withTags * @returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest addTagsEntry(String key, String value) { if (null == this.tags) { this.tags = new java.util.HashMap(); } if (this.tags.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tags.put(key, value); return this; } /** * Removes all the entries added into Tags. * * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest clearTagsEntries() { this.tags = null; return this; } /** *

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

        * * @return The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image * builder only through the specified endpoints. */ public java.util.List getAccessEndpoints() { return accessEndpoints; } /** *

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

        * * @param accessEndpoints * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image * builder only through the specified endpoints. */ public void setAccessEndpoints(java.util.Collection accessEndpoints) { if (accessEndpoints == null) { this.accessEndpoints = null; return; } this.accessEndpoints = new java.util.ArrayList(accessEndpoints); } /** *

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

        *

        * NOTE: This method appends the values to the existing list (if any). Use * {@link #setAccessEndpoints(java.util.Collection)} or {@link #withAccessEndpoints(java.util.Collection)} if you * want to override the existing values. *

        * * @param accessEndpoints * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image * builder only through the specified endpoints. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withAccessEndpoints(AccessEndpoint... accessEndpoints) { if (this.accessEndpoints == null) { setAccessEndpoints(new java.util.ArrayList(accessEndpoints.length)); } for (AccessEndpoint ele : accessEndpoints) { this.accessEndpoints.add(ele); } return this; } /** *

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

        * * @param accessEndpoints * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image * builder only through the specified endpoints. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateImageBuilderRequest withAccessEndpoints(java.util.Collection accessEndpoints) { setAccessEndpoints(accessEndpoints); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getImageName() != null) sb.append("ImageName: ").append(getImageName()).append(","); if (getImageArn() != null) sb.append("ImageArn: ").append(getImageArn()).append(","); if (getInstanceType() != null) sb.append("InstanceType: ").append(getInstanceType()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getDisplayName() != null) sb.append("DisplayName: ").append(getDisplayName()).append(","); if (getVpcConfig() != null) sb.append("VpcConfig: ").append(getVpcConfig()).append(","); if (getIamRoleArn() != null) sb.append("IamRoleArn: ").append(getIamRoleArn()).append(","); if (getEnableDefaultInternetAccess() != null) sb.append("EnableDefaultInternetAccess: ").append(getEnableDefaultInternetAccess()).append(","); if (getDomainJoinInfo() != null) sb.append("DomainJoinInfo: ").append(getDomainJoinInfo()).append(","); if (getAppstreamAgentVersion() != null) sb.append("AppstreamAgentVersion: ").append(getAppstreamAgentVersion()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getAccessEndpoints() != null) sb.append("AccessEndpoints: ").append(getAccessEndpoints()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateImageBuilderRequest == false) return false; CreateImageBuilderRequest other = (CreateImageBuilderRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getImageName() == null ^ this.getImageName() == null) return false; if (other.getImageName() != null && other.getImageName().equals(this.getImageName()) == false) return false; if (other.getImageArn() == null ^ this.getImageArn() == null) return false; if (other.getImageArn() != null && other.getImageArn().equals(this.getImageArn()) == false) return false; if (other.getInstanceType() == null ^ this.getInstanceType() == null) return false; if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getDisplayName() == null ^ this.getDisplayName() == null) return false; if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false) return false; if (other.getVpcConfig() == null ^ this.getVpcConfig() == null) return false; if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == false) return false; if (other.getIamRoleArn() == null ^ this.getIamRoleArn() == null) return false; if (other.getIamRoleArn() != null && other.getIamRoleArn().equals(this.getIamRoleArn()) == false) return false; if (other.getEnableDefaultInternetAccess() == null ^ this.getEnableDefaultInternetAccess() == null) return false; if (other.getEnableDefaultInternetAccess() != null && other.getEnableDefaultInternetAccess().equals(this.getEnableDefaultInternetAccess()) == false) return false; if (other.getDomainJoinInfo() == null ^ this.getDomainJoinInfo() == null) return false; if (other.getDomainJoinInfo() != null && other.getDomainJoinInfo().equals(this.getDomainJoinInfo()) == false) return false; if (other.getAppstreamAgentVersion() == null ^ this.getAppstreamAgentVersion() == null) return false; if (other.getAppstreamAgentVersion() != null && other.getAppstreamAgentVersion().equals(this.getAppstreamAgentVersion()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getAccessEndpoints() == null ^ this.getAccessEndpoints() == null) return false; if (other.getAccessEndpoints() != null && other.getAccessEndpoints().equals(this.getAccessEndpoints()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getImageName() == null) ? 0 : getImageName().hashCode()); hashCode = prime * hashCode + ((getImageArn() == null) ? 0 : getImageArn().hashCode()); hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode()); hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode()); hashCode = prime * hashCode + ((getIamRoleArn() == null) ? 0 : getIamRoleArn().hashCode()); hashCode = prime * hashCode + ((getEnableDefaultInternetAccess() == null) ? 0 : getEnableDefaultInternetAccess().hashCode()); hashCode = prime * hashCode + ((getDomainJoinInfo() == null) ? 0 : getDomainJoinInfo().hashCode()); hashCode = prime * hashCode + ((getAppstreamAgentVersion() == null) ? 0 : getAppstreamAgentVersion().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getAccessEndpoints() == null) ? 0 : getAccessEndpoints().hashCode()); return hashCode; } @Override public CreateImageBuilderRequest clone() { return (CreateImageBuilderRequest) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy