Class CfnImageBuilderProps

Properties for defining a CfnImageBuilder.

Inheritance

object

CfnImageBuilderProps

Implements

ICfnImageBuilderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppStream

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnImageBuilderProps : ICfnImageBuilderProps

Syntax (vb)

Public Class CfnImageBuilderProps Implements ICfnImageBuilderProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppStream;

             var cfnImageBuilderProps = new CfnImageBuilderProps {
                 InstanceType = "instanceType",
                 Name = "name",

                 // the properties below are optional
                 AccessEndpoints = new [] { new AccessEndpointProperty {
                     EndpointType = "endpointType",
                     VpceId = "vpceId"
                 } },
                 AppstreamAgentVersion = "appstreamAgentVersion",
                 Description = "description",
                 DisplayName = "displayName",
                 DomainJoinInfo = new DomainJoinInfoProperty {
                     DirectoryName = "directoryName",
                     OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName"
                 },
                 EnableDefaultInternetAccess = false,
                 IamRoleArn = "iamRoleArn",
                 ImageArn = "imageArn",
                 ImageName = "imageName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Constructors

CfnImageBuilderProps()

Properties for defining a CfnImageBuilder.

Properties

AccessEndpoints	The list of virtual private cloud (VPC) interface endpoint objects.
AppstreamAgentVersion	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].
Description	The description to display.
DisplayName	The image builder name to display.
DomainJoinInfo	The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
EnableDefaultInternetAccess	Enables or disables default internet access for the image builder.
IamRoleArn	The ARN of the IAM role that is applied to the image builder.
ImageArn	The ARN of the public, private, or shared image to use.
ImageName	The name of the image used to create the image builder.
InstanceType	The instance type to use when launching the image builder. The following instance types are available:.
Name	A unique name for the image builder.
Tags	An array of key-value pairs.
VpcConfig	The VPC configuration for the image builder.

Constructors

CfnImageBuilderProps()

Properties for defining a CfnImageBuilder.

public CfnImageBuilderProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppStream;

             var cfnImageBuilderProps = new CfnImageBuilderProps {
                 InstanceType = "instanceType",
                 Name = "name",

                 // the properties below are optional
                 AccessEndpoints = new [] { new AccessEndpointProperty {
                     EndpointType = "endpointType",
                     VpceId = "vpceId"
                 } },
                 AppstreamAgentVersion = "appstreamAgentVersion",
                 Description = "description",
                 DisplayName = "displayName",
                 DomainJoinInfo = new DomainJoinInfoProperty {
                     DirectoryName = "directoryName",
                     OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName"
                 },
                 EnableDefaultInternetAccess = false,
                 IamRoleArn = "iamRoleArn",
                 ImageArn = "imageArn",
                 ImageName = "imageName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Properties

AccessEndpoints

The list of virtual private cloud (VPC) interface endpoint objects.

public object? AccessEndpoints { get; set; }

Property Value

object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-accessendpoints

AppstreamAgentVersion

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].

public string? AppstreamAgentVersion { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-appstreamagentversion

Description

The description to display.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-description

DisplayName

The image builder name to display.

public string? DisplayName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-displayname

DomainJoinInfo

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

public object? DomainJoinInfo { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-domainjoininfo

EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

public object? EnableDefaultInternetAccess { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-enabledefaultinternetaccess

IamRoleArn

The ARN of the IAM role that is applied to the image builder.

public string? IamRoleArn { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-iamrolearn

ImageArn

The ARN of the public, private, or shared image to use.

public string? ImageArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagearn

ImageName

The name of the image used to create the image builder.

public string? ImageName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-imagename

InstanceType

The instance type to use when launching the image builder. The following instance types are available:.

public string InstanceType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-instancetype

Name

A unique name for the image builder.

public string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-name

Tags

An array of key-value pairs.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-tags

VpcConfig

The VPC configuration for the image builder.

public object? VpcConfig { get; set; }

Property Value

object

Remarks

You can specify only one subnet.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-imagebuilder.html#cfn-appstream-imagebuilder-vpcconfig

Implements

ICfnImageBuilderProps