Interface ICfnImageBuilderMixinProps

Properties for CfnImageBuilderPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.AppStream

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnImageBuilderMixinProps

Syntax (vb)

Public Interface ICfnImageBuilderMixinProps

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.CfnPropertyMixins.AWS.AppStream;

             var cfnImageBuilderMixinProps = new CfnImageBuilderMixinProps {
                 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",
                 InstanceType = "instanceType",
                 Name = "name",
                 RootVolumeConfig = new VolumeConfigProperty {
                     VolumeSizeInGb = 123
                 },
                 SoftwaresToInstall = new [] { "softwaresToInstall" },
                 SoftwaresToUninstall = new [] { "softwaresToUninstall" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SubnetIds = new [] { "subnetIds" }
                 }
             };

Synopsis

Properties

AccessEndpoints	The list of virtual private cloud (VPC) interface endpoint objects.
AppstreamAgentVersion	The version of the WorkSpaces Applications agent to use for this image builder.
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.
RootVolumeConfig	Properties for CfnImageBuilderPropsMixin.
SoftwaresToInstall	Properties for CfnImageBuilderPropsMixin.
SoftwaresToUninstall	Properties for CfnImageBuilderPropsMixin.
Tags	An array of key-value pairs.
VpcConfig	The VPC configuration for the image builder.

Properties

AccessEndpoints

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

object? AccessEndpoints { get; }

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

Type union: either IResolvable or (either IResolvable or CfnImageBuilderPropsMixin.IAccessEndpointProperty)[]

AppstreamAgentVersion

The version of the WorkSpaces Applications agent to use for this image builder.

string? AppstreamAgentVersion { get; }

Property Value

string

Remarks

To use the latest version of the WorkSpaces Applications agent, specify [LATEST].

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

Description

The description to display.

string? Description { get; }

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.

string? DisplayName { get; }

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.

object? DomainJoinInfo { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnImageBuilderPropsMixin.IDomainJoinInfoProperty

EnableDefaultInternetAccess

Enables or disables default internet access for the image builder.

object? EnableDefaultInternetAccess { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

IamRoleArn

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

string? IamRoleArn { get; }

Property Value

string

Remarks

To assume a role, the image builder calls the 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