Package software.amazon.awscdk.services.appstream

Interface CfnImageBuilderProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnImageBuilderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:43:30.155Z") @Stability(Stable) public interface CfnImageBuilderProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a `CfnImageBuilder`.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appstream.*;
 CfnImageBuilderProps cfnImageBuilderProps = CfnImageBuilderProps.builder()
         .instanceType("instanceType")
         .name("name")
         // the properties below are optional
         .accessEndpoints(List.of(AccessEndpointProperty.builder()
                 .endpointType("endpointType")
                 .vpceId("vpceId")
                 .build()))
         .appstreamAgentVersion("appstreamAgentVersion")
         .description("description")
         .displayName("displayName")
         .domainJoinInfo(DomainJoinInfoProperty.builder()
                 .directoryName("directoryName")
                 .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                 .build())
         .enableDefaultInternetAccess(false)
         .iamRoleArn("iamRoleArn")
         .imageArn("imageArn")
         .imageName("imageName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

  • Method Details

    • getInstanceType

      @Stability(Stable) @NotNull String getInstanceType()
      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

    • getName

      @Stability(Stable) @NotNull String getName()
      A unique name for the image builder.

    • getAccessEndpoints

      @Stability(Stable) @Nullable default Object getAccessEndpoints()
      The list of virtual private cloud (VPC) interface endpoint objects.

      Administrators can connect to the image builder only through the specified endpoints.

    • getAppstreamAgentVersion

      @Stability(Stable) @Nullable default String getAppstreamAgentVersion()
      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].

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description to display.

    • getDisplayName

      @Stability(Stable) @Nullable default String getDisplayName()
      The image builder name to display.

    • getDomainJoinInfo

      @Stability(Stable) @Nullable default Object getDomainJoinInfo()
      The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

    • getEnableDefaultInternetAccess

      @Stability(Stable) @Nullable default Object getEnableDefaultInternetAccess()
      Enables or disables default internet access for the image builder.

    • getIamRoleArn

      @Stability(Stable) @Nullable default String getIamRoleArn()
      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 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 .

    • getImageArn

      @Stability(Stable) @Nullable default String getImageArn()
      The ARN of the public, private, or shared image to use.

    • getImageName

      @Stability(Stable) @Nullable default String getImageName()
      The name of the image used to create the image builder.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs.

    • getVpcConfig

      @Stability(Stable) @Nullable default Object getVpcConfig()
      The VPC configuration for the image builder.

      You can specify only one subnet.

    • builder

      @Stability(Stable) static CfnImageBuilderProps.Builder builder()
      Returns:
      a CfnImageBuilderProps.Builder of CfnImageBuilderProps