Skip to content

Latest commit

 

History

History
3018 lines (1861 loc) · 120 KB

amiCopy.typescript.md

File metadata and controls

3018 lines (1861 loc) · 120 KB

amiCopy Submodule

Constructs

AmiCopy

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy aws_ami_copy}.

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopy(scope: Construct, id: string, config: AmiCopyConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config AmiCopyConfig 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.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putEbsBlockDevice No description.
putEphemeralBlockDevice No description.
putTimeouts No description.
resetDeprecationTime No description.
resetDescription No description.
resetDestinationOutpostArn No description.
resetEbsBlockDevice No description.
resetEncrypted No description.
resetEphemeralBlockDevice No description.
resetId No description.
resetKmsKeyId No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts 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.

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

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

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
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putEbsBlockDevice 
public putEbsBlockDevice(value: IResolvable | AmiCopyEbsBlockDevice[]): void
valueRequired
putEphemeralBlockDevice 
public putEphemeralBlockDevice(value: IResolvable | AmiCopyEphemeralBlockDevice[]): void
valueRequired
putTimeouts 
public putTimeouts(value: AmiCopyTimeouts): void
valueRequired
resetDeprecationTime 
public resetDeprecationTime(): void
resetDescription 
public resetDescription(): void
resetDestinationOutpostArn 
public resetDestinationOutpostArn(): void
resetEbsBlockDevice 
public resetEbsBlockDevice(): void
resetEncrypted 
public resetEncrypted(): void
resetEphemeralBlockDevice 
public resetEphemeralBlockDevice(): void
resetId 
public resetId(): void
resetKmsKeyId 
public resetKmsKeyId(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTimeouts 
public resetTimeouts(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a AmiCopy resource upon running "cdktf plan ".
isConstruct 
import { amiCopy } from '@cdktf/provider-aws'

amiCopy.AmiCopy.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 { amiCopy } from '@cdktf/provider-aws'

amiCopy.AmiCopy.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { amiCopy } from '@cdktf/provider-aws'

amiCopy.AmiCopy.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { amiCopy } from '@cdktf/provider-aws'

amiCopy.AmiCopy.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a AmiCopy resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the AmiCopy to import.

importFromIdRequired
  • Type: string

The id of the existing AmiCopy that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the AmiCopy to import is found.

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.
architecture string No description.
arn string No description.
bootMode string No description.
ebsBlockDevice AmiCopyEbsBlockDeviceList No description.
enaSupport cdktf.IResolvable No description.
ephemeralBlockDevice AmiCopyEphemeralBlockDeviceList No description.
hypervisor string No description.
imageLocation string No description.
imageOwnerAlias string No description.
imageType string No description.
imdsSupport string No description.
kernelId string No description.
manageEbsSnapshots cdktf.IResolvable No description.
ownerId string No description.
platform string No description.
platformDetails string No description.
public cdktf.IResolvable No description.
ramdiskId string No description.
rootDeviceName string No description.
rootSnapshotId string No description.
sriovNetSupport string No description.
timeouts AmiCopyTimeoutsOutputReference No description.
tpmSupport string No description.
uefiData string No description.
usageOperation string No description.
virtualizationType string No description.
deprecationTimeInput string No description.
descriptionInput string No description.
destinationOutpostArnInput string No description.
ebsBlockDeviceInput cdktf.IResolvable | AmiCopyEbsBlockDevice[] No description.
encryptedInput boolean | cdktf.IResolvable No description.
ephemeralBlockDeviceInput cdktf.IResolvable | AmiCopyEphemeralBlockDevice[] No description.
idInput string No description.
kmsKeyIdInput string No description.
nameInput string No description.
sourceAmiIdInput string No description.
sourceAmiRegionInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | AmiCopyTimeouts No description.
deprecationTime string No description.
description string No description.
destinationOutpostArn string No description.
encrypted boolean | cdktf.IResolvable No description.
id string No description.
kmsKeyId string No description.
name string No description.
sourceAmiId string No description.
sourceAmiRegion 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[]
architectureRequired 
public readonly architecture: string;
  • Type: string
arnRequired 
public readonly arn: string;
  • Type: string
bootModeRequired 
public readonly bootMode: string;
  • Type: string
ebsBlockDeviceRequired 
public readonly ebsBlockDevice: AmiCopyEbsBlockDeviceList;
enaSupportRequired 
public readonly enaSupport: IResolvable;
  • Type: cdktf.IResolvable
ephemeralBlockDeviceRequired 
public readonly ephemeralBlockDevice: AmiCopyEphemeralBlockDeviceList;
hypervisorRequired 
public readonly hypervisor: string;
  • Type: string
imageLocationRequired 
public readonly imageLocation: string;
  • Type: string
imageOwnerAliasRequired 
public readonly imageOwnerAlias: string;
  • Type: string
imageTypeRequired 
public readonly imageType: string;
  • Type: string
imdsSupportRequired 
public readonly imdsSupport: string;
  • Type: string
kernelIdRequired 
public readonly kernelId: string;
  • Type: string
manageEbsSnapshotsRequired 
public readonly manageEbsSnapshots: IResolvable;
  • Type: cdktf.IResolvable
ownerIdRequired 
public readonly ownerId: string;
  • Type: string
platformRequired 
public readonly platform: string;
  • Type: string
platformDetailsRequired 
public readonly platformDetails: string;
  • Type: string
publicRequired 
public readonly public: IResolvable;
  • Type: cdktf.IResolvable
ramdiskIdRequired 
public readonly ramdiskId: string;
  • Type: string
rootDeviceNameRequired 
public readonly rootDeviceName: string;
  • Type: string
rootSnapshotIdRequired 
public readonly rootSnapshotId: string;
  • Type: string
sriovNetSupportRequired 
public readonly sriovNetSupport: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: AmiCopyTimeoutsOutputReference;
tpmSupportRequired 
public readonly tpmSupport: string;
  • Type: string
uefiDataRequired 
public readonly uefiData: string;
  • Type: string
usageOperationRequired 
public readonly usageOperation: string;
  • Type: string
virtualizationTypeRequired 
public readonly virtualizationType: string;
  • Type: string
deprecationTimeInputOptional 
public readonly deprecationTimeInput: string;
  • Type: string
descriptionInputOptional 
public readonly descriptionInput: string;
  • Type: string
destinationOutpostArnInputOptional 
public readonly destinationOutpostArnInput: string;
  • Type: string
ebsBlockDeviceInputOptional 
public readonly ebsBlockDeviceInput: IResolvable | AmiCopyEbsBlockDevice[];
encryptedInputOptional 
public readonly encryptedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
ephemeralBlockDeviceInputOptional 
public readonly ephemeralBlockDeviceInput: IResolvable | AmiCopyEphemeralBlockDevice[];
idInputOptional 
public readonly idInput: string;
  • Type: string
kmsKeyIdInputOptional 
public readonly kmsKeyIdInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
sourceAmiIdInputOptional 
public readonly sourceAmiIdInput: string;
  • Type: string
sourceAmiRegionInputOptional 
public readonly sourceAmiRegionInput: 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}
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | AmiCopyTimeouts;
deprecationTimeRequired 
public readonly deprecationTime: string;
  • Type: string
descriptionRequired 
public readonly description: string;
  • Type: string
destinationOutpostArnRequired 
public readonly destinationOutpostArn: string;
  • Type: string
encryptedRequired 
public readonly encrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
kmsKeyIdRequired 
public readonly kmsKeyId: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
sourceAmiIdRequired 
public readonly sourceAmiId: string;
  • Type: string
sourceAmiRegionRequired 
public readonly sourceAmiRegion: 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

AmiCopyConfig

Initializer 

import { amiCopy } from '@cdktf/provider-aws'

const amiCopyConfig: amiCopy.AmiCopyConfig = { ... }

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.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#name AmiCopy#name}.
sourceAmiId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#source_ami_id AmiCopy#source_ami_id}.
sourceAmiRegion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#source_ami_region AmiCopy#source_ami_region}.
deprecationTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#deprecation_time AmiCopy#deprecation_time}.
description string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#description AmiCopy#description}.
destinationOutpostArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#destination_outpost_arn AmiCopy#destination_outpost_arn}.
ebsBlockDevice cdktf.IResolvable | AmiCopyEbsBlockDevice[] ebs_block_device block.
encrypted boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#encrypted AmiCopy#encrypted}.
ephemeralBlockDevice cdktf.IResolvable | AmiCopyEphemeralBlockDevice[] ephemeral_block_device block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#id AmiCopy#id}.
kmsKeyId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#kms_key_id AmiCopy#kms_key_id}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#tags AmiCopy#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#tags_all AmiCopy#tags_all}.
timeouts AmiCopyTimeouts timeouts 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[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#name AmiCopy#name}.

sourceAmiIdRequired 
public readonly sourceAmiId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#source_ami_id AmiCopy#source_ami_id}.

sourceAmiRegionRequired 
public readonly sourceAmiRegion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#source_ami_region AmiCopy#source_ami_region}.

deprecationTimeOptional 
public readonly deprecationTime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#deprecation_time AmiCopy#deprecation_time}.

descriptionOptional 
public readonly description: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#description AmiCopy#description}.

destinationOutpostArnOptional 
public readonly destinationOutpostArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#destination_outpost_arn AmiCopy#destination_outpost_arn}.

ebsBlockDeviceOptional 
public readonly ebsBlockDevice: IResolvable | AmiCopyEbsBlockDevice[];

ebs_block_device block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#ebs_block_device AmiCopy#ebs_block_device}

encryptedOptional 
public readonly encrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#encrypted AmiCopy#encrypted}.

ephemeralBlockDeviceOptional 
public readonly ephemeralBlockDevice: IResolvable | AmiCopyEphemeralBlockDevice[];

ephemeral_block_device block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#ephemeral_block_device AmiCopy#ephemeral_block_device}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#id AmiCopy#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.

kmsKeyIdOptional 
public readonly kmsKeyId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#kms_key_id AmiCopy#kms_key_id}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#tags AmiCopy#tags}.

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#tags_all AmiCopy#tags_all}.

timeoutsOptional 
public readonly timeouts: AmiCopyTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#timeouts AmiCopy#timeouts}

AmiCopyEbsBlockDevice

Initializer 

import { amiCopy } from '@cdktf/provider-aws'

const amiCopyEbsBlockDevice: amiCopy.AmiCopyEbsBlockDevice = { ... }

AmiCopyEphemeralBlockDevice

Initializer 

import { amiCopy } from '@cdktf/provider-aws'

const amiCopyEphemeralBlockDevice: amiCopy.AmiCopyEphemeralBlockDevice = { ... }

AmiCopyTimeouts

Initializer 

import { amiCopy } from '@cdktf/provider-aws'

const amiCopyTimeouts: amiCopy.AmiCopyTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#create AmiCopy#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#delete AmiCopy#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#update AmiCopy#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#create AmiCopy#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#delete AmiCopy#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/ami_copy#update AmiCopy#update}.

Classes

AmiCopyEbsBlockDeviceList

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopyEbsBlockDeviceList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
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): AmiCopyEbsBlockDeviceOutputReference
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 | AmiCopyEbsBlockDevice[] 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 | AmiCopyEbsBlockDevice[];

AmiCopyEbsBlockDeviceOutputReference

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopyEbsBlockDeviceOutputReference(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.
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.

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.
deleteOnTermination cdktf.IResolvable No description.
deviceName string No description.
encrypted cdktf.IResolvable No description.
iops number No description.
outpostArn string No description.
snapshotId string No description.
throughput number No description.
volumeSize number No description.
volumeType string No description.
internalValue cdktf.IResolvable | AmiCopyEbsBlockDevice 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
deleteOnTerminationRequired 
public readonly deleteOnTermination: IResolvable;
  • Type: cdktf.IResolvable
deviceNameRequired 
public readonly deviceName: string;
  • Type: string
encryptedRequired 
public readonly encrypted: IResolvable;
  • Type: cdktf.IResolvable
iopsRequired 
public readonly iops: number;
  • Type: number
outpostArnRequired 
public readonly outpostArn: string;
  • Type: string
snapshotIdRequired 
public readonly snapshotId: string;
  • Type: string
throughputRequired 
public readonly throughput: number;
  • Type: number
volumeSizeRequired 
public readonly volumeSize: number;
  • Type: number
volumeTypeRequired 
public readonly volumeType: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | AmiCopyEbsBlockDevice;

AmiCopyEphemeralBlockDeviceList

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopyEphemeralBlockDeviceList(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
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string
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): AmiCopyEphemeralBlockDeviceOutputReference
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 | AmiCopyEphemeralBlockDevice[] 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 | AmiCopyEphemeralBlockDevice[];

AmiCopyEphemeralBlockDeviceOutputReference

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopyEphemeralBlockDeviceOutputReference(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.
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.

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.
deviceName string No description.
virtualName string No description.
internalValue cdktf.IResolvable | AmiCopyEphemeralBlockDevice 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
deviceNameRequired 
public readonly deviceName: string;
  • Type: string
virtualNameRequired 
public readonly virtualName: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | AmiCopyEphemeralBlockDevice;

AmiCopyTimeoutsOutputReference

Initializers 

import { amiCopy } from '@cdktf/provider-aws'

new amiCopy.AmiCopyTimeoutsOutputReference(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.
resetCreate No description.
resetDelete No description.
resetUpdate 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.

resetCreate 
public resetCreate(): void
resetDelete 
public resetDelete(): void
resetUpdate 
public resetUpdate(): 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.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | AmiCopyTimeouts 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
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | AmiCopyTimeouts;