`dataAwsEksAddon` Submodule

Constructs

DataAwsEksAddon

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon aws_eks_addon}.

Initializers

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

new dataAwsEksAddon.DataAwsEksAddon(scope: Construct, id: string, config: DataAwsEksAddonConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`DataAwsEksAddonConfig`	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: DataAwsEksAddonConfig

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`	Adds this resource to the terraform JSON output.
`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.
`resetId`	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

Adds this resource to the terraform JSON output.

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`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(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`resetId`

public resetId(): void

`resetTags`

public resetTags(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformDataSource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a DataAwsEksAddon resource upon running "cdktf plan ".

`isConstruct`

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

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

dataAwsEksAddon.DataAwsEksAddon.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformDataSource`

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

dataAwsEksAddon.DataAwsEksAddon.isTerraformDataSource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

dataAwsEksAddon.DataAwsEksAddon.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataAwsEksAddon 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 DataAwsEksAddon to import.

`importFromId`^Required

Type: string

The id of the existing DataAwsEksAddon that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#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 DataAwsEksAddon 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.
`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.
`addonVersion`	`string`	No description.
`arn`	`string`	No description.
`configurationValues`	`string`	No description.
`createdAt`	`string`	No description.
`modifiedAt`	`string`	No description.
`serviceAccountRoleArn`	`string`	No description.
`addonNameInput`	`string`	No description.
`clusterNameInput`	`string`	No description.
`idInput`	`string`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`addonName`	`string`	No description.
`clusterName`	`string`	No description.
`id`	`string`	No description.
`tags`	`{[ key: string ]: 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

`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

`addonVersion`^Required

public readonly addonVersion: string;

Type: string

`arn`^Required

public readonly arn: string;

Type: string

`configurationValues`^Required

public readonly configurationValues: string;

Type: string

`createdAt`^Required

public readonly createdAt: string;

Type: string

`modifiedAt`^Required

public readonly modifiedAt: string;

Type: string

`serviceAccountRoleArn`^Required

public readonly serviceAccountRoleArn: string;

Type: string

`addonNameInput`^Optional

public readonly addonNameInput: string;

Type: string

`clusterNameInput`^Optional

public readonly clusterNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`addonName`^Required

public readonly addonName: string;

Type: string

`clusterName`^Required

public readonly clusterName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`tags`^Required

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

Type: {[ key: string ]: string}

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DataAwsEksAddonConfig

Initializer

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

const dataAwsEksAddonConfig: dataAwsEksAddon.DataAwsEksAddonConfig = { ... }

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.
`addonName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#addon_name DataAwsEksAddon#addon_name}.
`clusterName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#cluster_name DataAwsEksAddon#cluster_name}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#id DataAwsEksAddon#id}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#tags DataAwsEksAddon#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[]

`addonName`^Required

public readonly addonName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#addon_name DataAwsEksAddon#addon_name}.

`clusterName`^Required

public readonly clusterName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#cluster_name DataAwsEksAddon#cluster_name}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.70.0/docs/data-sources/eks_addon#id DataAwsEksAddon#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.

`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/data-sources/eks_addon#tags DataAwsEksAddon#tags}.

Files

dataAwsEksAddon.typescript.md

Latest commit

History

dataAwsEksAddon.typescript.md

File metadata and controls

dataAwsEksAddon Submodule

Constructs