Interface ICfnImageBuilderProps
Properties for defining a CfnImageBuilder
.
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public interface ICfnImageBuilderProps
Syntax (vb)
Public Interface ICfnImageBuilderProps
Remarks
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
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. |
Properties
AccessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects.
virtual object AccessEndpoints { get; }
Property Value
System.Object
Remarks
Administrators can connect to the image builder only through the specified endpoints.
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].
virtual string AppstreamAgentVersion { get; }
Property Value
System.String
Remarks
Description
The description to display.
virtual string Description { get; }
Property Value
System.String
Remarks
DisplayName
The image builder name to display.
virtual string DisplayName { get; }
Property Value
System.String
Remarks
DomainJoinInfo
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
virtual object DomainJoinInfo { get; }
Property Value
System.Object
Remarks
EnableDefaultInternetAccess
Enables or disables default internet access for the image builder.
virtual object EnableDefaultInternetAccess { get; }
Property Value
System.Object
Remarks
IamRoleArn
The ARN of the IAM role that is applied to the image builder.
virtual string IamRoleArn { get; }
Property Value
System.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 .
ImageArn
The ARN of the public, private, or shared image to use.
virtual string ImageArn { get; }
Property Value
System.String
Remarks
ImageName
The name of the image used to create the image builder.
virtual string ImageName { get; }
Property Value
System.String
Remarks
InstanceType
The instance type to use when launching the image builder. The following instance types are available:.
string InstanceType { get; }
Property Value
System.String
Remarks
Name
A unique name for the image builder.
string Name { get; }
Property Value
System.String
Remarks
Tags
VpcConfig
The VPC configuration for the image builder.
virtual object VpcConfig { get; }
Property Value
System.Object
Remarks
You can specify only one subnet.