class CfnImageBuilder (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppStream.CfnImageBuilder |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappstream#CfnImageBuilder |
![]() | software.amazon.awscdk.services.appstream.CfnImageBuilder |
![]() | aws_cdk.aws_appstream.CfnImageBuilder |
![]() | aws-cdk-lib » aws_appstream » CfnImageBuilder |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const cfnImageBuilder = new appstream.CfnImageBuilder(this, 'MyCfnImageBuilder', {
instanceType: 'instanceType',
name: 'name',
// the properties below are optional
accessEndpoints: [{
endpointType: 'endpointType',
vpceId: 'vpceId',
}],
appstreamAgentVersion: 'appstreamAgentVersion',
description: 'description',
displayName: 'displayName',
domainJoinInfo: {
directoryName: 'directoryName',
organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
},
enableDefaultInternetAccess: false,
iamRoleArn: 'iamRoleArn',
imageArn: 'imageArn',
imageName: 'imageName',
tags: [{
key: 'key',
value: 'value',
}],
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
},
});
Initializer
new CfnImageBuilder(scope: Construct, id: string, props: CfnImageBuilderProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Image Builder Props
Construct Props
Name | Type | Description |
---|---|---|
instance | string | The instance type to use when launching the image builder. The following instance types are available:. |
name | string | A unique name for the image builder. |
access | IResolvable | IResolvable | Access [] | The list of virtual private cloud (VPC) interface endpoint objects. |
appstream | string | 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? | string | The description to display. |
display | string | The image builder name to display. |
domain | IResolvable | Domain | The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. |
enable | boolean | IResolvable | Enables or disables default internet access for the image builder. |
iam | string | The ARN of the IAM role that is applied to the image builder. |
image | string | The ARN of the public, private, or shared image to use. |
image | string | The name of the image used to create the image builder. |
tags? | Cfn [] | An array of key-value pairs. |
vpc | IResolvable | Vpc | The VPC configuration for the image builder. |
instanceType
Type:
string
The instance type to use when launching the image builder. The following instance types are available:.
- stream.standard.small
- stream.standard.medium
- stream.standard.large
- stream.compute.large
- stream.compute.xlarge
- stream.compute.2xlarge
- stream.compute.4xlarge
- stream.compute.8xlarge
- stream.memory.large
- stream.memory.xlarge
- stream.memory.2xlarge
- stream.memory.4xlarge
- stream.memory.8xlarge
- stream.memory.z1d.large
- stream.memory.z1d.xlarge
- stream.memory.z1d.2xlarge
- stream.memory.z1d.3xlarge
- stream.memory.z1d.6xlarge
- stream.memory.z1d.12xlarge
- stream.graphics-design.large
- stream.graphics-design.xlarge
- stream.graphics-design.2xlarge
- stream.graphics-design.4xlarge
- stream.graphics-desktop.2xlarge
- stream.graphics.g4dn.xlarge
- stream.graphics.g4dn.2xlarge
- stream.graphics.g4dn.4xlarge
- stream.graphics.g4dn.8xlarge
- stream.graphics.g4dn.12xlarge
- stream.graphics.g4dn.16xlarge
- stream.graphics-pro.4xlarge
- stream.graphics-pro.8xlarge
- stream.graphics-pro.16xlarge
name
Type:
string
A unique name for the image builder.
accessEndpoints?
Type:
IResolvable
|
IResolvable
|
Access
[]
(optional)
The list of virtual private cloud (VPC) interface endpoint objects.
Administrators can connect to the image builder only through the specified endpoints.
appstreamAgentVersion?
Type:
string
(optional)
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?
Type:
string
(optional)
The description to display.
displayName?
Type:
string
(optional)
The image builder name to display.
domainJoinInfo?
Type:
IResolvable
|
Domain
(optional)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess?
Type:
boolean |
IResolvable
(optional)
Enables or disables default internet access for the image builder.
iamRoleArn?
Type:
string
(optional)
The ARN of the IAM role that is applied to the image builder.
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?
Type:
string
(optional)
The ARN of the public, private, or shared image to use.
imageName?
Type:
string
(optional)
The name of the image used to create the image builder.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs.
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
The VPC configuration for the image builder.
You can specify only one subnet.
Properties
Name | Type | Description |
---|---|---|
attr | string | The URL to start an image builder streaming session, returned as a string. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
instance | string | The instance type to use when launching the image builder. |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | A unique name for the image builder. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
access | IResolvable | IResolvable | Access [] | The list of virtual private cloud (VPC) interface endpoint objects. |
appstream | string | 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? | string | The description to display. |
display | string | The image builder name to display. |
domain | IResolvable | Domain | The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. |
enable | boolean | IResolvable | Enables or disables default internet access for the image builder. |
iam | string | The ARN of the IAM role that is applied to the image builder. |
image | string | The ARN of the public, private, or shared image to use. |
image | string | The name of the image used to create the image builder. |
tags | Cfn [] | An array of key-value pairs. |
vpc | IResolvable | Vpc | The VPC configuration for the image builder. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrStreamingUrl
Type:
string
The URL to start an image builder streaming session, returned as a string.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
instanceType
Type:
string
The instance type to use when launching the image builder.
The following instance types are available:.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
A unique name for the image builder.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
accessEndpoints?
Type:
IResolvable
|
IResolvable
|
Access
[]
(optional)
The list of virtual private cloud (VPC) interface endpoint objects.
appstreamAgentVersion?
Type:
string
(optional)
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?
Type:
string
(optional)
The description to display.
displayName?
Type:
string
(optional)
The image builder name to display.
domainJoinInfo?
Type:
IResolvable
|
Domain
(optional)
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
enableDefaultInternetAccess?
Type:
boolean |
IResolvable
(optional)
Enables or disables default internet access for the image builder.
iamRoleArn?
Type:
string
(optional)
The ARN of the IAM role that is applied to the image builder.
imageArn?
Type:
string
(optional)
The ARN of the public, private, or shared image to use.
imageName?
Type:
string
(optional)
The name of the image used to create the image builder.
tagsRaw?
Type:
Cfn
[]
(optional)
An array of key-value pairs.
vpcConfig?
Type:
IResolvable
|
Vpc
(optional)
The VPC configuration for the image builder.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }