Class CfnImageBuilder
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.
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnImageBuilder : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnImageBuilder
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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(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 |
CfnImageBuilder(Construct, String, ICfnImageBuilderProps) |
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. |
Name | A unique name for the image builder. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnImageBuilder(Construct, String, ICfnImageBuilderProps)
public CfnImageBuilder(Construct scope, string id, ICfnImageBuilderProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnImageBuilderProps
Resource properties.
Properties
AccessEndpoints
The list of virtual private cloud (VPC) interface endpoint objects.
public virtual object AccessEndpoints { get; set; }
Property Value
System.Object
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
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
DisplayName
The image builder name to display.
public virtual string DisplayName { get; set; }
Property Value
System.String
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
EnableDefaultInternetAccess
Enables or disables default internet access for the image builder.
public virtual object EnableDefaultInternetAccess { get; set; }
Property Value
System.Object
IamRoleArn
The ARN of the IAM role that is applied to the image builder.
public virtual string IamRoleArn { get; set; }
Property Value
System.String
ImageArn
The ARN of the public, private, or shared image to use.
public virtual string ImageArn { get; set; }
Property Value
System.String
ImageName
The name of the image used to create the image builder.
public virtual string ImageName { get; set; }
Property Value
System.String
InstanceType
The instance type to use when launching the image builder.
public virtual string InstanceType { get; set; }
Property Value
System.String
Remarks
The following instance types are available:.
Name
A unique name for the image builder.
public virtual string Name { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VpcConfig
The VPC configuration for the image builder.
public virtual object VpcConfig { get; set; }
Property Value
System.Object
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>