Skip to content

Latest commit

 

History

History
2182 lines (1339 loc) · 102 KB

dataIonoscloudNfsShare.typescript.md

File metadata and controls

2182 lines (1339 loc) · 102 KB

dataIonoscloudNfsShare Submodule

Constructs

DataIonoscloudNfsShare

Represents a {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share ionoscloud_nfs_share}.

Initializers

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

new dataIonoscloudNfsShare.DataIonoscloudNfsShare(scope: Construct, id: string, config: DataIonoscloudNfsShareConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataIonoscloudNfsShareConfig 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 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.
putClientGroups No description.
resetClientGroups No description.
resetGid No description.
resetId No description.
resetLocation No description.
resetName No description.
resetPartialMatch No description.
resetQuota No description.
resetUid 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

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}
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

putClientGroups
public putClientGroups(value: IResolvable | DataIonoscloudNfsShareClientGroups[]): void
valueRequired

resetClientGroups
public resetClientGroups(): void
resetGid
public resetGid(): void
resetId
public resetId(): void
resetLocation
public resetLocation(): void
resetName
public resetName(): void
resetPartialMatch
public resetPartialMatch(): void
resetQuota
public resetQuota(): void
resetUid
public resetUid(): 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 DataIonoscloudNfsShare resource upon running "cdktf plan ".

isConstruct
import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

dataIonoscloudNfsShare.DataIonoscloudNfsShare.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 { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

dataIonoscloudNfsShare.DataIonoscloudNfsShare.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformDataSource
import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

dataIonoscloudNfsShare.DataIonoscloudNfsShare.isTerraformDataSource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

dataIonoscloudNfsShare.DataIonoscloudNfsShare.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing DataIonoscloudNfsShare that should be imported.

Refer to the {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#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 DataIonoscloudNfsShare 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.
clientGroups DataIonoscloudNfsShareClientGroupsList No description.
nfsPath string No description.
clientGroupsInput cdktf.IResolvable | DataIonoscloudNfsShareClientGroups[] No description.
clusterIdInput string No description.
gidInput number No description.
idInput string No description.
locationInput string No description.
nameInput string No description.
partialMatchInput boolean | cdktf.IResolvable No description.
quotaInput number No description.
uidInput number No description.
clusterId string No description.
gid number No description.
id string No description.
location string No description.
name string No description.
partialMatch boolean | cdktf.IResolvable No description.
quota number No description.
uid number 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

clientGroupsRequired
public readonly clientGroups: DataIonoscloudNfsShareClientGroupsList;

nfsPathRequired
public readonly nfsPath: string;
  • Type: string

clientGroupsInputOptional
public readonly clientGroupsInput: IResolvable | DataIonoscloudNfsShareClientGroups[];

clusterIdInputOptional
public readonly clusterIdInput: string;
  • Type: string

gidInputOptional
public readonly gidInput: number;
  • Type: number

idInputOptional
public readonly idInput: string;
  • Type: string

locationInputOptional
public readonly locationInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

partialMatchInputOptional
public readonly partialMatchInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

quotaInputOptional
public readonly quotaInput: number;
  • Type: number

uidInputOptional
public readonly uidInput: number;
  • Type: number

clusterIdRequired
public readonly clusterId: string;
  • Type: string

gidRequired
public readonly gid: number;
  • Type: number

idRequired
public readonly id: string;
  • Type: string

locationRequired
public readonly location: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

partialMatchRequired
public readonly partialMatch: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

quotaRequired
public readonly quota: number;
  • Type: number

uidRequired
public readonly uid: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

DataIonoscloudNfsShareClientGroups

Initializer

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

const dataIonoscloudNfsShareClientGroups: dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroups = { ... }

Properties

Name Type Description
description string Optional description for the clients groups.
hosts string[] A singular host allowed to connect to the share.
ipNetworks string[] The allowed host or network to which the export is being shared.
nfs cdktf.IResolvable | DataIonoscloudNfsShareClientGroupsNfs[] nfs block.

descriptionOptional
public readonly description: string;
  • Type: string

Optional description for the clients groups.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#description DataIonoscloudNfsShare#description}


hostsOptional
public readonly hosts: string[];
  • Type: string[]

A singular host allowed to connect to the share.

The host can be specified as IP address and can be either IPv4 or IPv6.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#hosts DataIonoscloudNfsShare#hosts}


ipNetworksOptional
public readonly ipNetworks: string[];
  • Type: string[]

The allowed host or network to which the export is being shared.

The IP address can be either IPv4 or IPv6 and has to be given with CIDR notation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#ip_networks DataIonoscloudNfsShare#ip_networks}


nfsOptional
public readonly nfs: IResolvable | DataIonoscloudNfsShareClientGroupsNfs[];

nfs block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#nfs DataIonoscloudNfsShare#nfs}


DataIonoscloudNfsShareClientGroupsNfs

Initializer

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

const dataIonoscloudNfsShareClientGroupsNfs: dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroupsNfs = { ... }

Properties

Name Type Description
squash string The squash mode for the export.

squashOptional
public readonly squash: string;
  • Type: string

The squash mode for the export.

The squash mode can be: none - No squash mode. no mapping, root-anonymous - Map root user to anonymous uid, all-anonymous - Map all users to anonymous uid.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#squash DataIonoscloudNfsShare#squash}


DataIonoscloudNfsShareConfig

Initializer

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

const dataIonoscloudNfsShareConfig: dataIonoscloudNfsShare.DataIonoscloudNfsShareConfig = { ... }

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.
clusterId string The ID of the Network File Storage Cluster.
clientGroups cdktf.IResolvable | DataIonoscloudNfsShareClientGroups[] client_groups block.
gid number The group ID that will own the exported directory. If not set, anonymous (512) will be used.
id string The ID of the Network File Storage Share.
location string The location of the Network File Storage Cluster. Available locations: 'de/fra, 'de/txl'.
name string The name of the Network File Storage Share.
partialMatch boolean | cdktf.IResolvable Whether partial matching is allowed or not when using the name filter.
quota number The quota in MiB for the export.
uid number The user ID that will own the exported directory. If not set, anonymous (512) will be used.

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

clusterIdRequired
public readonly clusterId: string;
  • Type: string

The ID of the Network File Storage Cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#cluster_id DataIonoscloudNfsShare#cluster_id}


clientGroupsOptional
public readonly clientGroups: IResolvable | DataIonoscloudNfsShareClientGroups[];

client_groups block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#client_groups DataIonoscloudNfsShare#client_groups}


gidOptional
public readonly gid: number;
  • Type: number

The group ID that will own the exported directory. If not set, anonymous (512) will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#gid DataIonoscloudNfsShare#gid}


idOptional
public readonly id: string;
  • Type: string

The ID of the Network File Storage Share.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#id DataIonoscloudNfsShare#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.


locationOptional
public readonly location: string;
  • Type: string

The location of the Network File Storage Cluster. Available locations: 'de/fra, 'de/txl'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#location DataIonoscloudNfsShare#location}


nameOptional
public readonly name: string;
  • Type: string

The name of the Network File Storage Share.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#name DataIonoscloudNfsShare#name}


partialMatchOptional
public readonly partialMatch: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether partial matching is allowed or not when using the name filter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#partial_match DataIonoscloudNfsShare#partial_match}


quotaOptional
public readonly quota: number;
  • Type: number

The quota in MiB for the export.

The quota can restrict the amount of data that can be stored within the export. The quota can be disabled using 0.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#quota DataIonoscloudNfsShare#quota}


uidOptional
public readonly uid: number;
  • Type: number

The user ID that will own the exported directory. If not set, anonymous (512) will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/ionos-cloud/ionoscloud/6.6.3/docs/data-sources/nfs_share#uid DataIonoscloudNfsShare#uid}


Classes

DataIonoscloudNfsShareClientGroupsList

Initializers

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

new dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroupsList(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): DataIonoscloudNfsShareClientGroupsOutputReference
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 | DataIonoscloudNfsShareClientGroups[] 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 | DataIonoscloudNfsShareClientGroups[];

DataIonoscloudNfsShareClientGroupsNfsList

Initializers

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

new dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroupsNfsList(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): DataIonoscloudNfsShareClientGroupsNfsOutputReference
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 | DataIonoscloudNfsShareClientGroupsNfs[] 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 | DataIonoscloudNfsShareClientGroupsNfs[];

DataIonoscloudNfsShareClientGroupsNfsOutputReference

Initializers

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

new dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroupsNfsOutputReference(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.
resetSquash 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.

resetSquash
public resetSquash(): 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.
squashInput string No description.
squash string No description.
internalValue cdktf.IResolvable | DataIonoscloudNfsShareClientGroupsNfs 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

squashInputOptional
public readonly squashInput: string;
  • Type: string

squashRequired
public readonly squash: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | DataIonoscloudNfsShareClientGroupsNfs;

DataIonoscloudNfsShareClientGroupsOutputReference

Initializers

import { dataIonoscloudNfsShare } from '@cdktf/provider-ionoscloud'

new dataIonoscloudNfsShare.DataIonoscloudNfsShareClientGroupsOutputReference(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.
putNfs No description.
resetDescription No description.
resetHosts No description.
resetIpNetworks No description.
resetNfs 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.

putNfs
public putNfs(value: IResolvable | DataIonoscloudNfsShareClientGroupsNfs[]): void
valueRequired

resetDescription
public resetDescription(): void
resetHosts
public resetHosts(): void
resetIpNetworks
public resetIpNetworks(): void
resetNfs
public resetNfs(): 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.
nfs DataIonoscloudNfsShareClientGroupsNfsList No description.
descriptionInput string No description.
hostsInput string[] No description.
ipNetworksInput string[] No description.
nfsInput cdktf.IResolvable | DataIonoscloudNfsShareClientGroupsNfs[] No description.
description string No description.
hosts string[] No description.
ipNetworks string[] No description.
internalValue cdktf.IResolvable | DataIonoscloudNfsShareClientGroups 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

nfsRequired
public readonly nfs: DataIonoscloudNfsShareClientGroupsNfsList;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

hostsInputOptional
public readonly hostsInput: string[];
  • Type: string[]

ipNetworksInputOptional
public readonly ipNetworksInput: string[];
  • Type: string[]

nfsInputOptional
public readonly nfsInput: IResolvable | DataIonoscloudNfsShareClientGroupsNfs[];

descriptionRequired
public readonly description: string;
  • Type: string

hostsRequired
public readonly hosts: string[];
  • Type: string[]

ipNetworksRequired
public readonly ipNetworks: string[];
  • Type: string[]

internalValueOptional
public readonly internalValue: IResolvable | DataIonoscloudNfsShareClientGroups;