ImageBuilder class
Provides an AppStream image builder.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const testFleet = new aws.appstream.ImageBuilder("test_fleet", {
vpcConfig: {
subnetIds: [example.id],
},
name: "Name",
description: "Description of a ImageBuilder",
displayName: "Display name of a ImageBuilder",
enableDefaultInternetAccess: false,
imageName: "AppStream-WinServer2019-10-05-2022",
instanceType: "stream.standard.large",
tags: {
Name: "Example Image Builder",
},
});
import pulumi
import pulumi_aws as aws
test_fleet = aws.appstream.ImageBuilder("test_fleet",
vpc_config={
"subnet_ids": [example["id"]],
},
name="Name",
description="Description of a ImageBuilder",
display_name="Display name of a ImageBuilder",
enable_default_internet_access=False,
image_name="AppStream-WinServer2019-10-05-2022",
instance_type="stream.standard.large",
tags={
"Name": "Example Image Builder",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var testFleet = new Aws.AppStream.ImageBuilder("test_fleet", new()
{
VpcConfig = new Aws.AppStream.Inputs.ImageBuilderVpcConfigArgs
{
SubnetIds = new[]
{
example.Id,
},
},
Name = "Name",
Description = "Description of a ImageBuilder",
DisplayName = "Display name of a ImageBuilder",
EnableDefaultInternetAccess = false,
ImageName = "AppStream-WinServer2019-10-05-2022",
InstanceType = "stream.standard.large",
Tags =
{
{ "Name", "Example Image Builder" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appstream"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := appstream.NewImageBuilder(ctx, "test_fleet", &appstream.ImageBuilderArgs{
VpcConfig: &appstream.ImageBuilderVpcConfigArgs{
SubnetIds: pulumi.StringArray{
example.Id,
},
},
Name: pulumi.String("Name"),
Description: pulumi.String("Description of a ImageBuilder"),
DisplayName: pulumi.String("Display name of a ImageBuilder"),
EnableDefaultInternetAccess: pulumi.Bool(false),
ImageName: pulumi.String("AppStream-WinServer2019-10-05-2022"),
InstanceType: pulumi.String("stream.standard.large"),
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Image Builder"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_appstream_imagebuilder" "test_fleet" {
vpc_config = {
subnet_ids = [example.id]
}
name = "Name"
description = "Description of a ImageBuilder"
display_name = "Display name of a ImageBuilder"
enable_default_internet_access = false
image_name = "AppStream-WinServer2019-10-05-2022"
instance_type = "stream.standard.large"
tags = {
"Name" = "Example Image Builder"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appstream.ImageBuilder;
import com.pulumi.aws.appstream.ImageBuilderArgs;
import com.pulumi.aws.appstream.inputs.ImageBuilderVpcConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testFleet = new ImageBuilder("testFleet", ImageBuilderArgs.builder()
.vpcConfig(ImageBuilderVpcConfigArgs.builder()
.subnetIds(example.id())
.build())
.name("Name")
.description("Description of a ImageBuilder")
.displayName("Display name of a ImageBuilder")
.enableDefaultInternetAccess(false)
.imageName("AppStream-WinServer2019-10-05-2022")
.instanceType("stream.standard.large")
.tags(Map.of("Name", "Example Image Builder"))
.build());
}
}
resources:
testFleet:
type: aws:appstream:ImageBuilder
name: test_fleet
properties:
vpcConfig:
subnetIds:
- ${example.id}
name: Name
description: Description of a ImageBuilder
displayName: Display name of a ImageBuilder
enableDefaultInternetAccess: false
imageName: AppStream-WinServer2019-10-05-2022
instanceType: stream.standard.large
tags:
Name: Example Image Builder
Import
Using pulumi import, import aws.appstream.ImageBuilder using the name. For example:
$ pulumi import aws:appstream/imageBuilder:ImageBuilder example imageBuilderExample
Constructors
- ImageBuilder(String name, {ImageBuilderArgs? args, CustomResourceOptions? options})
-
Creates a new ImageBuilder.
nameThe Pulumi resource name.argsArguments used to configure this ImageBuilder. The set of arguments for ImageBuilder.optionsResource options controlling this resource's behavior. - ImageBuilder.reference(String urn)
- Creates a typed reference to an existing ImageBuilder resource.
Properties
-
accessEndpoints
↔ Output<
List< ImageBuilderAccessEndpoint> ?> -
Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below.
latefinal
-
appstreamAgentVersion
↔ Output<
String> -
Version of the AppStream 2.0 agent to use for this image builder.
latefinal
-
arn
↔ Output<
String> -
ARN of the appstream image builder.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTime
↔ Output<
String> -
Date and time, in UTC and extended RFC 3339 format, when the image builder was created.
latefinal
-
description
↔ Output<
String> -
Description to display.
latefinal
-
displayName
↔ Output<
String> -
Human-readable friendly name for the AppStream image builder.
latefinal
-
domainJoinInfo
↔ Output<
ImageBuilderDomainJoinInfo> -
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.
latefinal
-
enableDefaultInternetAccess
↔ Output<
bool> -
Enables or disables default internet access for the image builder.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
iamRoleArn
↔ Output<
String> -
ARN of the IAM role to apply to the image builder.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
-
imageArn
↔ Output<
String> -
ARN of the public, private, or shared image to use.
latefinal
-
imageName
↔ Output<
String> -
Name of the image used to create the image builder.
latefinal
-
instanceType
↔ Output<
String> -
Instance type to use when launching the image builder.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Unique name for the image builder.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String> -
State of the image builder. For valid values, refer to the AWS documentation.
latefinal
-
Map of tags to assign to the instance. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcConfig
↔ Output<
ImageBuilderVpcConfig> -
Configuration block for the VPC configuration for the image builder. See below.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ImageBuilderState? state, CustomResourceOptions? options}) → ImageBuilder -
Gets an existing ImageBuilder resource's state with the given
nameandid.