Interface CfnImageBuilderProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnImageBuilderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-17T19:20:23.434Z")
@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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnImageBuilderProps
static final class
An implementation forCfnImageBuilderProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnImageBuilderProps.Builder
builder()
default Object
The list of virtual private cloud (VPC) interface endpoint objects.default String
The version of the AppStream 2.0 agent to use for this image builder.default String
The description to display.default String
The image builder name to display.default Object
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.default Object
Enables or disables default internet access for the image builder.default String
The ARN of the IAM role that is applied to the image builder.default String
The ARN of the public, private, or shared image to use.default String
The name of the image used to create the image builder.The instance type to use when launching the image builder.getName()
A unique name for the image builder.getTags()
An array of key-value pairs.default Object
The VPC configuration for the image builder.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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
- See Also:
-
getName
A unique name for the image builder.- See Also:
-
getAccessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects.Administrators can connect to the image builder only through the specified endpoints.
- See Also:
-
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].- See Also:
-
getDescription
The description to display.- See Also:
-
getDisplayName
The image builder name to display.- See Also:
-
getDomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.- See Also:
-
getEnableDefaultInternetAccess
Enables or disables default internet access for the image builder.- See Also:
-
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 .
- See Also:
-
getImageArn
The ARN of the public, private, or shared image to use.- See Also:
-
getImageName
The name of the image used to create the image builder.- See Also:
-
getTags
An array of key-value pairs.- See Also:
-
getVpcConfig
The VPC configuration for the image builder.You can specify only one subnet.
- See Also:
-
builder
- Returns:
- a
CfnImageBuilderProps.Builder
ofCfnImageBuilderProps
-