Resource: awsAppstreamImageBuilder
Provides an AppStream image builder.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.appstreamImageBuilder.AppstreamImageBuilder(this, "test_fleet", {
description: "Description of a ImageBuilder",
displayName: "Display name of a ImageBuilder",
enableDefaultInternetAccess: false,
imageName: "AppStream-WinServer2019-10-05-2022",
instanceType: "stream.standard.large",
name: "Name",
tags: {
Name: "Example Image Builder",
},
vpcConfig: {
subnetIds: ["${aws_subnet.example.id}"],
},
});
Argument Reference
The following arguments are required:
instanceType
- (Required) Instance type to use when launching the image builder.name
- (Required) Unique name for the image builder.
The following arguments are optional:
accessEndpoint
- (Optional) Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.appstreamAgentVersion
- (Optional) Version of the AppStream 2.0 agent to use for this image builder.description
- (Optional) Description to display.displayName
- (Optional) Human-readable friendly name for the AppStream image builder.domainJoinInfo
- (Optional) Configuration block for the name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. See below.enableDefaultInternetAccess
- (Optional) Enables or disables default internet access for the image builder.iamRoleArn
- (Optional) ARN of the IAM role to apply to the image builder.imageArn
- (Optional, Required ifimageName
not provided) ARN of the public, private, or shared image to use.imageName
- (Optional, Required ifimageArn
not provided) Name of the image used to create the image builder.vpcConfig
- (Optional) Configuration block for the VPC configuration for the image builder. See below.tags
- (Optional) Map of tags to assign to the instance. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
accessEndpoint
The accessEndpoint
block supports the following arguments:
endpointType
- (Required) Type of interface endpoint.vpceId
- (Optional) Identifier (ID) of the VPC in which the interface endpoint is used.
domainJoinInfo
The domainJoinInfo
block supports the following arguments:
directoryName
- (Optional) Fully qualified name of the directory (for example, corp.example.com).organizationalUnitDistinguishedName
- (Optional) Distinguished name of the organizational unit for computer accounts.
vpcConfig
The vpcConfig
block supports the following arguments:
securityGroupIds
- (Optional) Identifiers of the security groups for the image builder or image builder.subnetIds
- (Optional) Identifiers of the subnets to which a network interface is attached from the image builder instance or image builder instance.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- ARN of the appstream image builder.createdTime
- Date and time, in UTC and extended RFC 3339 format, when the image builder was created.id
- Name of the image builder.state
- State of the image builder. Can be:pending
,UPDATING_AGENT
,running
,stopping
,stopped
,rebooting
,snapshotting
,deleting
,failed
,updating
,PENDING_QUALIFICATION
tagsAll
- Map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
awsAppstreamImageBuilder
can be imported using the name
, e.g.,