Skip to content

Latest commit

 

History

History
867 lines (542 loc) · 35.5 KB

dataAwsEfsMountTarget.md

File metadata and controls

867 lines (542 loc) · 35.5 KB

data_aws_efs_mount_target

Refer to the Terraform Registory for docs: data_aws_efs_mount_target.

dataAwsEfsMountTarget Submodule

Constructs

DataAwsEfsMountTarget

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target aws_efs_mount_target}.

Initializers

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

new dataAwsEfsMountTarget.DataAwsEfsMountTarget(scope: Construct, id: string, config?: DataAwsEfsMountTargetConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataAwsEfsMountTargetConfig 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


configOptional

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resetAccessPointId No description.
resetFileSystemId No description.
resetId No description.
resetMountTargetId No description.

toString
public toString(): string

Returns a string representation of this construct.

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

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

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

Adds this resource to the terraform JSON output.

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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

resetAccessPointId
public resetAccessPointId(): void
resetFileSystemId
public resetFileSystemId(): void
resetId
public resetId(): void
resetMountTargetId
public resetMountTargetId(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.

isConstruct
import { dataAwsEfsMountTarget } from '@cdktf/aws-cdk'

dataAwsEfsMountTarget.DataAwsEfsMountTarget.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 { dataAwsEfsMountTarget } from '@cdktf/aws-cdk'

dataAwsEfsMountTarget.DataAwsEfsMountTarget.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataAwsEfsMountTarget } from '@cdktf/aws-cdk'

dataAwsEfsMountTarget.DataAwsEfsMountTarget.isTerraformDataSource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
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.
availabilityZoneId string No description.
availabilityZoneName string No description.
dnsName string No description.
fileSystemArn string No description.
ipAddress string No description.
mountTargetDnsName string No description.
networkInterfaceId string No description.
ownerId string No description.
securityGroups string[] No description.
subnetId string No description.
accessPointIdInput string No description.
fileSystemIdInput string No description.
idInput string No description.
mountTargetIdInput string No description.
accessPointId string No description.
fileSystemId string No description.
id string No description.
mountTargetId 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

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

availabilityZoneIdRequired
public readonly availabilityZoneId: string;
  • Type: string

availabilityZoneNameRequired
public readonly availabilityZoneName: string;
  • Type: string

dnsNameRequired
public readonly dnsName: string;
  • Type: string

fileSystemArnRequired
public readonly fileSystemArn: string;
  • Type: string

ipAddressRequired
public readonly ipAddress: string;
  • Type: string

mountTargetDnsNameRequired
public readonly mountTargetDnsName: string;
  • Type: string

networkInterfaceIdRequired
public readonly networkInterfaceId: string;
  • Type: string

ownerIdRequired
public readonly ownerId: string;
  • Type: string

securityGroupsRequired
public readonly securityGroups: string[];
  • Type: string[]

subnetIdRequired
public readonly subnetId: string;
  • Type: string

accessPointIdInputOptional
public readonly accessPointIdInput: string;
  • Type: string

fileSystemIdInputOptional
public readonly fileSystemIdInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

mountTargetIdInputOptional
public readonly mountTargetIdInput: string;
  • Type: string

accessPointIdRequired
public readonly accessPointId: string;
  • Type: string

fileSystemIdRequired
public readonly fileSystemId: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

mountTargetIdRequired
public readonly mountTargetId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataAwsEfsMountTargetConfig

Initializer

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

const dataAwsEfsMountTargetConfig: dataAwsEfsMountTarget.DataAwsEfsMountTargetConfig = { ... }

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.
accessPointId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#access_point_id DataAwsEfsMountTarget#access_point_id}.
fileSystemId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#file_system_id DataAwsEfsMountTarget#file_system_id}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#id DataAwsEfsMountTarget#id}.
mountTargetId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#mount_target_id DataAwsEfsMountTarget#mount_target_id}.

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[]

accessPointIdOptional
public readonly accessPointId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#access_point_id DataAwsEfsMountTarget#access_point_id}.


fileSystemIdOptional
public readonly fileSystemId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#file_system_id DataAwsEfsMountTarget#file_system_id}.


idOptional
public readonly id: string;
  • Type: string

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


mountTargetIdOptional
public readonly mountTargetId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/efs_mount_target#mount_target_id DataAwsEfsMountTarget#mount_target_id}.