Class CfnImageBuilder
A CloudFormation AWS::AppStream::ImageBuilder
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.AWS.AppStream.dll
Syntax (csharp)
public class CfnImageBuilder : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImageBuilder
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::AppStream::ImageBuilder
resource creates an image builder for Amazon AppStream 2.0. An image builder is a virtual machine that is used to create an image.
The initial state of the image builder is PENDING
. When it is ready, the state is RUNNING
.
CloudformationResource: AWS::AppStream::ImageBuilder
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 cfnImageBuilder = new CfnImageBuilder(this, "MyCfnImageBuilder", 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
CfnImageBuilder(Construct, String, ICfnImageBuilderProps) | Create a new |
CfnImageBuilder(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImageBuilder(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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]. |
AttrStreamingUrl | The URL to start an image builder streaming session, returned as a string. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImageBuilder(Construct, String, ICfnImageBuilderProps)
Create a new AWS::AppStream::ImageBuilder
.
public CfnImageBuilder(Construct scope, string id, ICfnImageBuilderProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnImageBuilderProps
- resource properties.
CfnImageBuilder(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImageBuilder(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImageBuilder(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImageBuilder(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects.
public virtual object AccessEndpoints { get; set; }
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].
public virtual string AppstreamAgentVersion { get; set; }
Property Value
System.String
Remarks
AttrStreamingUrl
The URL to start an image builder streaming session, returned as a string.
public virtual string AttrStreamingUrl { get; }
Property Value
System.String
Remarks
CloudformationAttribute: StreamingUrl
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description to display.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DisplayName
The image builder name to display.
public virtual string DisplayName { get; set; }
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.
public virtual object DomainJoinInfo { get; set; }
Property Value
System.Object
Remarks
EnableDefaultInternetAccess
Enables or disables default internet access for the image builder.
public virtual object EnableDefaultInternetAccess { get; set; }
Property Value
System.Object
Remarks
IamRoleArn
The ARN of the IAM role that is applied to the image builder.
public virtual string IamRoleArn { get; set; }
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.
public virtual string ImageArn { get; set; }
Property Value
System.String
Remarks
ImageName
The name of the image used to create the image builder.
public virtual string ImageName { get; set; }
Property Value
System.String
Remarks
InstanceType
The instance type to use when launching the image builder. The following instance types are available:.
public virtual string InstanceType { get; set; }
Property Value
System.String
Remarks
Name
A unique name for the image builder.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs.
public virtual TagManager Tags { get; }
Property Value
Remarks
VpcConfig
The VPC configuration for the image builder.
public virtual object VpcConfig { get; set; }
Property Value
System.Object
Remarks
You can specify only one subnet.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>