Skip to content

Latest commit

 

History

History
2510 lines (1557 loc) · 116 KB

appstreamImageBuilder.md

File metadata and controls

2510 lines (1557 loc) · 116 KB

aws_appstream_image_builder

Refer to the Terraform Registory for docs: aws_appstream_image_builder.

appstreamImageBuilder Submodule

Constructs

AppstreamImageBuilder

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder aws_appstream_image_builder}.

Initializers 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

new appstreamImageBuilder.AppstreamImageBuilder(scope: Construct, id: string, config: AppstreamImageBuilderConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AppstreamImageBuilderConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putAccessEndpoint No description.
putDomainJoinInfo No description.
putVpcConfig No description.
resetAccessEndpoint No description.
resetAppstreamAgentVersion No description.
resetDescription No description.
resetDisplayName No description.
resetDomainJoinInfo No description.
resetEnableDefaultInternetAccess No description.
resetIamRoleArn No description.
resetId No description.
resetImageArn No description.
resetImageName No description.
resetTags No description.
resetTagsAll No description.
resetVpcConfig No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putAccessEndpoint 
public putAccessEndpoint(value: IResolvable | AppstreamImageBuilderAccessEndpoint[]): void
valueRequired
putDomainJoinInfo 
public putDomainJoinInfo(value: AppstreamImageBuilderDomainJoinInfo): void
valueRequired
putVpcConfig 
public putVpcConfig(value: AppstreamImageBuilderVpcConfig): void
valueRequired
resetAccessEndpoint 
public resetAccessEndpoint(): void
resetAppstreamAgentVersion 
public resetAppstreamAgentVersion(): void
resetDescription 
public resetDescription(): void
resetDisplayName 
public resetDisplayName(): void
resetDomainJoinInfo 
public resetDomainJoinInfo(): void
resetEnableDefaultInternetAccess 
public resetEnableDefaultInternetAccess(): void
resetIamRoleArn 
public resetIamRoleArn(): void
resetId 
public resetId(): void
resetImageArn 
public resetImageArn(): void
resetImageName 
public resetImageName(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetVpcConfig 
public resetVpcConfig(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { appstreamImageBuilder } from '@cdktf/aws-cdk'

appstreamImageBuilder.AppstreamImageBuilder.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { appstreamImageBuilder } from '@cdktf/aws-cdk'

appstreamImageBuilder.AppstreamImageBuilder.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { appstreamImageBuilder } from '@cdktf/aws-cdk'

appstreamImageBuilder.AppstreamImageBuilder.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
accessEndpoint AppstreamImageBuilderAccessEndpointList No description.
arn string No description.
createdTime string No description.
domainJoinInfo AppstreamImageBuilderDomainJoinInfoOutputReference No description.
state string No description.
vpcConfig AppstreamImageBuilderVpcConfigOutputReference No description.
accessEndpointInput cdktf.IResolvable | AppstreamImageBuilderAccessEndpoint[] No description.
appstreamAgentVersionInput string No description.
descriptionInput string No description.
displayNameInput string No description.
domainJoinInfoInput AppstreamImageBuilderDomainJoinInfo No description.
enableDefaultInternetAccessInput boolean | cdktf.IResolvable No description.
iamRoleArnInput string No description.
idInput string No description.
imageArnInput string No description.
imageNameInput string No description.
instanceTypeInput string No description.
nameInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
vpcConfigInput AppstreamImageBuilderVpcConfig No description.
appstreamAgentVersion string No description.
description string No description.
displayName string No description.
enableDefaultInternetAccess boolean | cdktf.IResolvable No description.
iamRoleArn string No description.
id string No description.
imageArn string No description.
imageName string No description.
instanceType string No description.
name string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
accessEndpointRequired 
public readonly accessEndpoint: AppstreamImageBuilderAccessEndpointList;
arnRequired 
public readonly arn: string;
  • Type: string
createdTimeRequired 
public readonly createdTime: string;
  • Type: string
domainJoinInfoRequired 
public readonly domainJoinInfo: AppstreamImageBuilderDomainJoinInfoOutputReference;
stateRequired 
public readonly state: string;
  • Type: string
vpcConfigRequired 
public readonly vpcConfig: AppstreamImageBuilderVpcConfigOutputReference;
accessEndpointInputOptional 
public readonly accessEndpointInput: IResolvable | AppstreamImageBuilderAccessEndpoint[];
appstreamAgentVersionInputOptional 
public readonly appstreamAgentVersionInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
displayNameInputOptional 
public readonly displayNameInput: string;
  • Type: string
domainJoinInfoInputOptional 
public readonly domainJoinInfoInput: AppstreamImageBuilderDomainJoinInfo;
enableDefaultInternetAccessInputOptional 
public readonly enableDefaultInternetAccessInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
iamRoleArnInputOptional 
public readonly iamRoleArnInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
imageArnInputOptional 
public readonly imageArnInput: string;
  • Type: string
imageNameInputOptional 
public readonly imageNameInput: string;
  • Type: string
instanceTypeInputOptional 
public readonly instanceTypeInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vpcConfigInputOptional 
public readonly vpcConfigInput: AppstreamImageBuilderVpcConfig;
appstreamAgentVersionRequired 
public readonly appstreamAgentVersion: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
displayNameRequired 
public readonly displayName: string;
  • Type: string
enableDefaultInternetAccessRequired 
public readonly enableDefaultInternetAccess: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
iamRoleArnRequired 
public readonly iamRoleArn: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
imageArnRequired 
public readonly imageArn: string;
  • Type: string
imageNameRequired 
public readonly imageName: string;
  • Type: string
instanceTypeRequired 
public readonly instanceType: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

AppstreamImageBuilderAccessEndpoint

Initializer 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

const appstreamImageBuilderAccessEndpoint: appstreamImageBuilder.AppstreamImageBuilderAccessEndpoint = { ... }

Properties

Name Type Description
endpointType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#endpoint_type AppstreamImageBuilder#endpoint_type}.
vpceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#vpce_id AppstreamImageBuilder#vpce_id}.
endpointTypeRequired 
public readonly endpointType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#endpoint_type AppstreamImageBuilder#endpoint_type}.

vpceIdOptional 
public readonly vpceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#vpce_id AppstreamImageBuilder#vpce_id}.

AppstreamImageBuilderConfig

Initializer 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

const appstreamImageBuilderConfig: appstreamImageBuilder.AppstreamImageBuilderConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
instanceType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#instance_type AppstreamImageBuilder#instance_type}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#name AppstreamImageBuilder#name}.
accessEndpoint cdktf.IResolvable | AppstreamImageBuilderAccessEndpoint[] access_endpoint block.
appstreamAgentVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#appstream_agent_version AppstreamImageBuilder#appstream_agent_version}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#description AppstreamImageBuilder#description}.
displayName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#display_name AppstreamImageBuilder#display_name}.
domainJoinInfo AppstreamImageBuilderDomainJoinInfo domain_join_info block.
enableDefaultInternetAccess boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#enable_default_internet_access AppstreamImageBuilder#enable_default_internet_access}.
iamRoleArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#iam_role_arn AppstreamImageBuilder#iam_role_arn}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#id AppstreamImageBuilder#id}.
imageArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#image_arn AppstreamImageBuilder#image_arn}.
imageName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#image_name AppstreamImageBuilder#image_name}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#tags AppstreamImageBuilder#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#tags_all AppstreamImageBuilder#tags_all}.
vpcConfig AppstreamImageBuilderVpcConfig vpc_config block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
instanceTypeRequired 
public readonly instanceType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#instance_type AppstreamImageBuilder#instance_type}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#name AppstreamImageBuilder#name}.

accessEndpointOptional 
public readonly accessEndpoint: IResolvable | AppstreamImageBuilderAccessEndpoint[];

access_endpoint block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#access_endpoint AppstreamImageBuilder#access_endpoint}

appstreamAgentVersionOptional 
public readonly appstreamAgentVersion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#appstream_agent_version AppstreamImageBuilder#appstream_agent_version}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#description AppstreamImageBuilder#description}.

displayNameOptional 
public readonly displayName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#display_name AppstreamImageBuilder#display_name}.

domainJoinInfoOptional 
public readonly domainJoinInfo: AppstreamImageBuilderDomainJoinInfo;

domain_join_info block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#domain_join_info AppstreamImageBuilder#domain_join_info}

enableDefaultInternetAccessOptional 
public readonly enableDefaultInternetAccess: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#enable_default_internet_access AppstreamImageBuilder#enable_default_internet_access}.

iamRoleArnOptional 
public readonly iamRoleArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#iam_role_arn AppstreamImageBuilder#iam_role_arn}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#id AppstreamImageBuilder#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

imageArnOptional 
public readonly imageArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#image_arn AppstreamImageBuilder#image_arn}.

imageNameOptional 
public readonly imageName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#image_name AppstreamImageBuilder#image_name}.

tagsOptional 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#tags AppstreamImageBuilder#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#tags_all AppstreamImageBuilder#tags_all}.

vpcConfigOptional 
public readonly vpcConfig: AppstreamImageBuilderVpcConfig;

vpc_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#vpc_config AppstreamImageBuilder#vpc_config}

AppstreamImageBuilderDomainJoinInfo

Initializer 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

const appstreamImageBuilderDomainJoinInfo: appstreamImageBuilder.AppstreamImageBuilderDomainJoinInfo = { ... }

Properties

Name Type Description
directoryName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#directory_name AppstreamImageBuilder#directory_name}.
organizationalUnitDistinguishedName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#organizational_unit_distinguished_name AppstreamImageBuilder#organizational_unit_distinguished_name}.
directoryNameOptional 
public readonly directoryName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#directory_name AppstreamImageBuilder#directory_name}.

organizationalUnitDistinguishedNameOptional 
public readonly organizationalUnitDistinguishedName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#organizational_unit_distinguished_name AppstreamImageBuilder#organizational_unit_distinguished_name}.

AppstreamImageBuilderVpcConfig

Initializer 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

const appstreamImageBuilderVpcConfig: appstreamImageBuilder.AppstreamImageBuilderVpcConfig = { ... }

Properties

Name Type Description
securityGroupIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#security_group_ids AppstreamImageBuilder#security_group_ids}.
subnetIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#subnet_ids AppstreamImageBuilder#subnet_ids}.
securityGroupIdsOptional 
public readonly securityGroupIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#security_group_ids AppstreamImageBuilder#security_group_ids}.

subnetIdsOptional 
public readonly subnetIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/appstream_image_builder#subnet_ids AppstreamImageBuilder#subnet_ids}.

Classes

AppstreamImageBuilderAccessEndpointList

Initializers 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

new appstreamImageBuilder.AppstreamImageBuilderAccessEndpointList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public get(index: number): AppstreamImageBuilderAccessEndpointOutputReference
indexRequired
  • Type: number

the index of the item to return.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
internalValue cdktf.IResolvable | AppstreamImageBuilderAccessEndpoint[] No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | AppstreamImageBuilderAccessEndpoint[];

AppstreamImageBuilderAccessEndpointOutputReference

Initializers 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

new appstreamImageBuilder.AppstreamImageBuilderAccessEndpointOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetVpceId No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetVpceId 
public resetVpceId(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
endpointTypeInput string No description.
vpceIdInput string No description.
endpointType string No description.
vpceId string No description.
internalValue cdktf.IResolvable | AppstreamImageBuilderAccessEndpoint No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
endpointTypeInputOptional 
public readonly endpointTypeInput: string;
  • Type: string
vpceIdInputOptional 
public readonly vpceIdInput: string;
  • Type: string
endpointTypeRequired 
public readonly endpointType: string;
  • Type: string
vpceIdRequired 
public readonly vpceId: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | AppstreamImageBuilderAccessEndpoint;

AppstreamImageBuilderDomainJoinInfoOutputReference

Initializers 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

new appstreamImageBuilder.AppstreamImageBuilderDomainJoinInfoOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetDirectoryName No description.
resetOrganizationalUnitDistinguishedName No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDirectoryName 
public resetDirectoryName(): void
resetOrganizationalUnitDistinguishedName 
public resetOrganizationalUnitDistinguishedName(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
directoryNameInput string No description.
organizationalUnitDistinguishedNameInput string No description.
directoryName string No description.
organizationalUnitDistinguishedName string No description.
internalValue AppstreamImageBuilderDomainJoinInfo No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
directoryNameInputOptional 
public readonly directoryNameInput: string;
  • Type: string
organizationalUnitDistinguishedNameInputOptional 
public readonly organizationalUnitDistinguishedNameInput: string;
  • Type: string
directoryNameRequired 
public readonly directoryName: string;
  • Type: string
organizationalUnitDistinguishedNameRequired 
public readonly organizationalUnitDistinguishedName: string;
  • Type: string
internalValueOptional 
public readonly internalValue: AppstreamImageBuilderDomainJoinInfo;

AppstreamImageBuilderVpcConfigOutputReference

Initializers 

import { appstreamImageBuilder } from '@cdktf/aws-cdk'

new appstreamImageBuilder.AppstreamImageBuilderVpcConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetSecurityGroupIds No description.
resetSubnetIds No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetSecurityGroupIds 
public resetSecurityGroupIds(): void
resetSubnetIds 
public resetSubnetIds(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
securityGroupIdsInput string[] No description.
subnetIdsInput string[] No description.
securityGroupIds string[] No description.
subnetIds string[] No description.
internalValue AppstreamImageBuilderVpcConfig No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
securityGroupIdsInputOptional 
public readonly securityGroupIdsInput: string[];
  • Type: string[]
subnetIdsInputOptional 
public readonly subnetIdsInput: string[];
  • Type: string[]
securityGroupIdsRequired 
public readonly securityGroupIds: string[];
  • Type: string[]
subnetIdsRequired 
public readonly subnetIds: string[];
  • Type: string[]
internalValueOptional 
public readonly internalValue: AppstreamImageBuilderVpcConfig;