`pinpointEmailTemplate` Submodule

Constructs

PinpointEmailTemplate

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template aws_pinpoint_email_template}.

Initializers

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

new pinpointEmailTemplate.PinpointEmailTemplate(scope: Construct, id: string, config: PinpointEmailTemplateConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`PinpointEmailTemplateConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: PinpointEmailTemplateConfig

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".
`putEmailTemplate`	No description.
`resetEmailTemplate`	No description.
`resetTags`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

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.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: string

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

`index`^Optional

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".

`id`^Required

Type: string

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

`putEmailTemplate`

public putEmailTemplate(value: IResolvable | PinpointEmailTemplateEmailTemplate[]): void

`value`^Required

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplate[]

`resetEmailTemplate`

public resetEmailTemplate(): void

`resetTags`

public resetTags(): 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 PinpointEmailTemplate resource upon running "cdktf plan ".

`isConstruct`

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

pinpointEmailTemplate.PinpointEmailTemplate.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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

pinpointEmailTemplate.PinpointEmailTemplate.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

pinpointEmailTemplate.PinpointEmailTemplate.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

pinpointEmailTemplate.PinpointEmailTemplate.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing PinpointEmailTemplate that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the PinpointEmailTemplate 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.
`arn`	`string`	No description.
`emailTemplate`	`PinpointEmailTemplateEmailTemplateList`	No description.
`tagsAll`	`cdktf.StringMap`	No description.
`emailTemplateInput`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplate[]`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`templateNameInput`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`templateName`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`emailTemplate`^Required

public readonly emailTemplate: PinpointEmailTemplateEmailTemplateList;

Type: PinpointEmailTemplateEmailTemplateList

`tagsAll`^Required

public readonly tagsAll: StringMap;

Type: cdktf.StringMap

`emailTemplateInput`^Optional

public readonly emailTemplateInput: IResolvable | PinpointEmailTemplateEmailTemplate[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplate[]

`tagsInput`^Optional

public readonly tagsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`templateNameInput`^Optional

public readonly templateNameInput: string;

Type: string

`tags`^Required

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

`templateName`^Required

public readonly templateName: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

PinpointEmailTemplateConfig

Initializer

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

const pinpointEmailTemplateConfig: pinpointEmailTemplate.PinpointEmailTemplateConfig = { ... }

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.
`templateName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#template_name PinpointEmailTemplate#template_name}.
`emailTemplate`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplate[]`	email_template block.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#tags PinpointEmailTemplate#tags}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`templateName`^Required

public readonly templateName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#template_name PinpointEmailTemplate#template_name}.

`emailTemplate`^Optional

public readonly emailTemplate: IResolvable | PinpointEmailTemplateEmailTemplate[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplate[]

email_template block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#email_template PinpointEmailTemplate#email_template}

`tags`^Optional

public readonly tags: {[ key: string ]: string};

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#tags PinpointEmailTemplate#tags}.

PinpointEmailTemplateEmailTemplate

Initializer

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

const pinpointEmailTemplateEmailTemplate: pinpointEmailTemplate.PinpointEmailTemplateEmailTemplate = { ... }

Properties

Name	Type	Description
`defaultSubstitutions`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#default_substitutions PinpointEmailTemplate#default_substitutions}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#description PinpointEmailTemplate#description}.
`header`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplateHeader[]`	header block.
`htmlPart`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#html_part PinpointEmailTemplate#html_part}.
`recommenderId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#recommender_id PinpointEmailTemplate#recommender_id}.
`subject`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#subject PinpointEmailTemplate#subject}.
`textPart`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#text_part PinpointEmailTemplate#text_part}.

`defaultSubstitutions`^Optional

public readonly defaultSubstitutions: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#default_substitutions PinpointEmailTemplate#default_substitutions}.

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#description PinpointEmailTemplate#description}.

`header`^Optional

public readonly header: IResolvable | PinpointEmailTemplateEmailTemplateHeader[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplateHeader[]

header block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#header PinpointEmailTemplate#header}

`htmlPart`^Optional

public readonly htmlPart: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#html_part PinpointEmailTemplate#html_part}.

`recommenderId`^Optional

public readonly recommenderId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#recommender_id PinpointEmailTemplate#recommender_id}.

`subject`^Optional

public readonly subject: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#subject PinpointEmailTemplate#subject}.

`textPart`^Optional

public readonly textPart: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#text_part PinpointEmailTemplate#text_part}.

PinpointEmailTemplateEmailTemplateHeader

Initializer

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

const pinpointEmailTemplateEmailTemplateHeader: pinpointEmailTemplate.PinpointEmailTemplateEmailTemplateHeader = { ... }

Properties

Name	Type	Description
`name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#name PinpointEmailTemplate#name}.
`value`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#value PinpointEmailTemplate#value}.

`name`^Optional

public readonly name: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#name PinpointEmailTemplate#name}.

`value`^Optional

public readonly value: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/resources/pinpoint_email_template#value PinpointEmailTemplate#value}.

Classes

PinpointEmailTemplateEmailTemplateHeaderList

Initializers

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

new pinpointEmailTemplate.PinpointEmailTemplateEmailTemplateHeaderList(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

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.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

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): PinpointEmailTemplateEmailTemplateHeaderOutputReference

`index`^Required

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 \| PinpointEmailTemplateEmailTemplateHeader[]`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | PinpointEmailTemplateEmailTemplateHeader[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplateHeader[]

PinpointEmailTemplateEmailTemplateHeaderOutputReference

Initializers

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

new pinpointEmailTemplate.PinpointEmailTemplateEmailTemplateHeaderOutputReference(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

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.
`resetName`	No description.
`resetValue`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetName`

public resetName(): void

`resetValue`

public resetValue(): 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.
`nameInput`	`string`	No description.
`valueInput`	`string`	No description.
`name`	`string`	No description.
`value`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplateHeader`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`valueInput`^Optional

public readonly valueInput: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`value`^Required

public readonly value: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | PinpointEmailTemplateEmailTemplateHeader;

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplateHeader

PinpointEmailTemplateEmailTemplateList

Initializers

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

new pinpointEmailTemplate.PinpointEmailTemplateEmailTemplateList(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

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.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

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): PinpointEmailTemplateEmailTemplateOutputReference

`index`^Required

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 \| PinpointEmailTemplateEmailTemplate[]`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | PinpointEmailTemplateEmailTemplate[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplate[]

PinpointEmailTemplateEmailTemplateOutputReference

Initializers

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

new pinpointEmailTemplate.PinpointEmailTemplateEmailTemplateOutputReference(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

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.
`putHeader`	No description.
`resetDefaultSubstitutions`	No description.
`resetDescription`	No description.
`resetHeader`	No description.
`resetHtmlPart`	No description.
`resetRecommenderId`	No description.
`resetSubject`	No description.
`resetTextPart`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`putHeader`

public putHeader(value: IResolvable | PinpointEmailTemplateEmailTemplateHeader[]): void

`value`^Required

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplateHeader[]

`resetDefaultSubstitutions`

public resetDefaultSubstitutions(): void

`resetDescription`

public resetDescription(): void

`resetHeader`

public resetHeader(): void

`resetHtmlPart`

public resetHtmlPart(): void

`resetRecommenderId`

public resetRecommenderId(): void

`resetSubject`

public resetSubject(): void

`resetTextPart`

public resetTextPart(): 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.
`header`	`PinpointEmailTemplateEmailTemplateHeaderList`	No description.
`defaultSubstitutionsInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`headerInput`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplateHeader[]`	No description.
`htmlPartInput`	`string`	No description.
`recommenderIdInput`	`string`	No description.
`subjectInput`	`string`	No description.
`textPartInput`	`string`	No description.
`defaultSubstitutions`	`string`	No description.
`description`	`string`	No description.
`htmlPart`	`string`	No description.
`recommenderId`	`string`	No description.
`subject`	`string`	No description.
`textPart`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| PinpointEmailTemplateEmailTemplate`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`header`^Required

public readonly header: PinpointEmailTemplateEmailTemplateHeaderList;

Type: PinpointEmailTemplateEmailTemplateHeaderList

`defaultSubstitutionsInput`^Optional

public readonly defaultSubstitutionsInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`headerInput`^Optional

public readonly headerInput: IResolvable | PinpointEmailTemplateEmailTemplateHeader[];

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplateHeader[]

`htmlPartInput`^Optional

public readonly htmlPartInput: string;

Type: string

`recommenderIdInput`^Optional

public readonly recommenderIdInput: string;

Type: string

`subjectInput`^Optional

public readonly subjectInput: string;

Type: string

`textPartInput`^Optional

public readonly textPartInput: string;

Type: string

`defaultSubstitutions`^Required

public readonly defaultSubstitutions: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`htmlPart`^Required

public readonly htmlPart: string;

Type: string

`recommenderId`^Required

public readonly recommenderId: string;

Type: string

`subject`^Required

public readonly subject: string;

Type: string

`textPart`^Required

public readonly textPart: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | PinpointEmailTemplateEmailTemplate;

Type: cdktf.IResolvable | PinpointEmailTemplateEmailTemplate

Files

pinpointEmailTemplate.typescript.md

Latest commit

History

pinpointEmailTemplate.typescript.md

File metadata and controls

pinpointEmailTemplate Submodule

Constructs