Package software.amazon.awscdk.cfnpropertymixins.services.appstream

Class CfnImageBuilderPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appstream.CfnImageBuilderPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.931Z")
@Stability(Stable)
public class CfnImageBuilderPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::AppStream::ImageBuilder resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.

The initial state of the image builder is PENDING . When it is ready, the state is RUNNING .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appstream.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnImageBuilderPropsMixin cfnImageBuilderPropsMixin = CfnImageBuilderPropsMixin.Builder.create(CfnImageBuilderMixinProps.builder()
         .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")
         .instanceType("instanceType")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnImageBuilderPropsMixin.AccessEndpointProperty	Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and WorkSpaces Applications.
static final class	CfnImageBuilderPropsMixin.Builder	A fluent builder for CfnImageBuilderPropsMixin.
static interface	CfnImageBuilderPropsMixin.DomainJoinInfoProperty	The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
static interface	CfnImageBuilderPropsMixin.VpcConfigProperty	The VPC configuration for the image builder.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnImageBuilderPropsMixin(CfnImageBuilderMixinProps props)	Create a mixin to apply properties to AWS::AppStream::ImageBuilder.
	CfnImageBuilderPropsMixin(CfnImageBuilderMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppStream::ImageBuilder.
protected	CfnImageBuilderPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnImageBuilderPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnImageBuilderMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnImageBuilderPropsMixin

protected CfnImageBuilderPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnImageBuilderPropsMixin

protected CfnImageBuilderPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnImageBuilderPropsMixin

@Stability(Stable)
public CfnImageBuilderPropsMixin(@NotNull
 CfnImageBuilderMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppStream::ImageBuilder.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnImageBuilderPropsMixin

@Stability(Stable)
public CfnImageBuilderPropsMixin(@NotNull
 CfnImageBuilderMixinProps props)

Create a mixin to apply properties to AWS::AppStream::ImageBuilder.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnImageBuilderMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()