Skip to content

Latest commit

 

History

History
2668 lines (1665 loc) · 128 KB

storagegatewaySmbFileShare.md

File metadata and controls

2668 lines (1665 loc) · 128 KB

storagegatewaySmbFileShare Submodule

Constructs

StoragegatewaySmbFileShare

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share aws_storagegateway_smb_file_share}.

Initializers

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

new storagegatewaySmbFileShare.StoragegatewaySmbFileShare(scope: Construct, id: string, config: StoragegatewaySmbFileShareConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config StoragegatewaySmbFileShareConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putCacheAttributes No description.
putTimeouts No description.
resetAccessBasedEnumeration No description.
resetAdminUserList No description.
resetAuditDestinationArn No description.
resetAuthentication No description.
resetBucketRegion No description.
resetCacheAttributes No description.
resetCaseSensitivity No description.
resetDefaultStorageClass No description.
resetFileShareName No description.
resetGuessMimeTypeEnabled No description.
resetId No description.
resetInvalidUserList No description.
resetKmsEncrypted No description.
resetKmsKeyArn No description.
resetNotificationPolicy No description.
resetObjectAcl No description.
resetOplocksEnabled No description.
resetReadOnly No description.
resetRequesterPays No description.
resetSmbAclEnabled No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.
resetValidUserList No description.
resetVpcEndpointDnsName No description.

toString
public toString(): string

Returns a string representation of this construct.

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

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

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

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

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

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

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

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

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

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

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

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

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

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

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

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

moveFromId
public moveFromId(id: string): void

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

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

idRequired
  • Type: string

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


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

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putCacheAttributes
public putCacheAttributes(value: StoragegatewaySmbFileShareCacheAttributes): void
valueRequired

putTimeouts
public putTimeouts(value: StoragegatewaySmbFileShareTimeouts): void
valueRequired

resetAccessBasedEnumeration
public resetAccessBasedEnumeration(): void
resetAdminUserList
public resetAdminUserList(): void
resetAuditDestinationArn
public resetAuditDestinationArn(): void
resetAuthentication
public resetAuthentication(): void
resetBucketRegion
public resetBucketRegion(): void
resetCacheAttributes
public resetCacheAttributes(): void
resetCaseSensitivity
public resetCaseSensitivity(): void
resetDefaultStorageClass
public resetDefaultStorageClass(): void
resetFileShareName
public resetFileShareName(): void
resetGuessMimeTypeEnabled
public resetGuessMimeTypeEnabled(): void
resetId
public resetId(): void
resetInvalidUserList
public resetInvalidUserList(): void
resetKmsEncrypted
public resetKmsEncrypted(): void
resetKmsKeyArn
public resetKmsKeyArn(): void
resetNotificationPolicy
public resetNotificationPolicy(): void
resetObjectAcl
public resetObjectAcl(): void
resetOplocksEnabled
public resetOplocksEnabled(): void
resetReadOnly
public resetReadOnly(): void
resetRequesterPays
public resetRequesterPays(): void
resetSmbAclEnabled
public resetSmbAclEnabled(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetTimeouts
public resetTimeouts(): void
resetValidUserList
public resetValidUserList(): void
resetVpcEndpointDnsName
public resetVpcEndpointDnsName(): 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 StoragegatewaySmbFileShare resource upon running "cdktf plan ".

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

storagegatewaySmbFileShare.StoragegatewaySmbFileShare.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


isTerraformElement
import { storagegatewaySmbFileShare } from '@cdktf/aws-cdk'

storagegatewaySmbFileShare.StoragegatewaySmbFileShare.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { storagegatewaySmbFileShare } from '@cdktf/aws-cdk'

storagegatewaySmbFileShare.StoragegatewaySmbFileShare.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { storagegatewaySmbFileShare } from '@cdktf/aws-cdk'

storagegatewaySmbFileShare.StoragegatewaySmbFileShare.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing StoragegatewaySmbFileShare that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_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 StoragegatewaySmbFileShare 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.
cacheAttributes StoragegatewaySmbFileShareCacheAttributesOutputReference No description.
fileshareId string No description.
path string No description.
timeouts StoragegatewaySmbFileShareTimeoutsOutputReference No description.
accessBasedEnumerationInput boolean | cdktf.IResolvable No description.
adminUserListInput string[] No description.
auditDestinationArnInput string No description.
authenticationInput string No description.
bucketRegionInput string No description.
cacheAttributesInput StoragegatewaySmbFileShareCacheAttributes No description.
caseSensitivityInput string No description.
defaultStorageClassInput string No description.
fileShareNameInput string No description.
gatewayArnInput string No description.
guessMimeTypeEnabledInput boolean | cdktf.IResolvable No description.
idInput string No description.
invalidUserListInput string[] No description.
kmsEncryptedInput boolean | cdktf.IResolvable No description.
kmsKeyArnInput string No description.
locationArnInput string No description.
notificationPolicyInput string No description.
objectAclInput string No description.
oplocksEnabledInput boolean | cdktf.IResolvable No description.
readOnlyInput boolean | cdktf.IResolvable No description.
requesterPaysInput boolean | cdktf.IResolvable No description.
roleArnInput string No description.
smbAclEnabledInput boolean | cdktf.IResolvable No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | StoragegatewaySmbFileShareTimeouts No description.
validUserListInput string[] No description.
vpcEndpointDnsNameInput string No description.
accessBasedEnumeration boolean | cdktf.IResolvable No description.
adminUserList string[] No description.
auditDestinationArn string No description.
authentication string No description.
bucketRegion string No description.
caseSensitivity string No description.
defaultStorageClass string No description.
fileShareName string No description.
gatewayArn string No description.
guessMimeTypeEnabled boolean | cdktf.IResolvable No description.
id string No description.
invalidUserList string[] No description.
kmsEncrypted boolean | cdktf.IResolvable No description.
kmsKeyArn string No description.
locationArn string No description.
notificationPolicy string No description.
objectAcl string No description.
oplocksEnabled boolean | cdktf.IResolvable No description.
readOnly boolean | cdktf.IResolvable No description.
requesterPays boolean | cdktf.IResolvable No description.
roleArn string No description.
smbAclEnabled boolean | cdktf.IResolvable No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
validUserList string[] No description.
vpcEndpointDnsName string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

arnRequired
public readonly arn: string;
  • Type: string

cacheAttributesRequired
public readonly cacheAttributes: StoragegatewaySmbFileShareCacheAttributesOutputReference;

fileshareIdRequired
public readonly fileshareId: string;
  • Type: string

pathRequired
public readonly path: string;
  • Type: string

timeoutsRequired
public readonly timeouts: StoragegatewaySmbFileShareTimeoutsOutputReference;

accessBasedEnumerationInputOptional
public readonly accessBasedEnumerationInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

adminUserListInputOptional
public readonly adminUserListInput: string[];
  • Type: string[]

auditDestinationArnInputOptional
public readonly auditDestinationArnInput: string;
  • Type: string

authenticationInputOptional
public readonly authenticationInput: string;
  • Type: string

bucketRegionInputOptional
public readonly bucketRegionInput: string;
  • Type: string

cacheAttributesInputOptional
public readonly cacheAttributesInput: StoragegatewaySmbFileShareCacheAttributes;

caseSensitivityInputOptional
public readonly caseSensitivityInput: string;
  • Type: string

defaultStorageClassInputOptional
public readonly defaultStorageClassInput: string;
  • Type: string

fileShareNameInputOptional
public readonly fileShareNameInput: string;
  • Type: string

gatewayArnInputOptional
public readonly gatewayArnInput: string;
  • Type: string

guessMimeTypeEnabledInputOptional
public readonly guessMimeTypeEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

invalidUserListInputOptional
public readonly invalidUserListInput: string[];
  • Type: string[]

kmsEncryptedInputOptional
public readonly kmsEncryptedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

kmsKeyArnInputOptional
public readonly kmsKeyArnInput: string;
  • Type: string

locationArnInputOptional
public readonly locationArnInput: string;
  • Type: string

notificationPolicyInputOptional
public readonly notificationPolicyInput: string;
  • Type: string

objectAclInputOptional
public readonly objectAclInput: string;
  • Type: string

oplocksEnabledInputOptional
public readonly oplocksEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

readOnlyInputOptional
public readonly readOnlyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

requesterPaysInputOptional
public readonly requesterPaysInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

roleArnInputOptional
public readonly roleArnInput: string;
  • Type: string

smbAclEnabledInputOptional
public readonly smbAclEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | StoragegatewaySmbFileShareTimeouts;

validUserListInputOptional
public readonly validUserListInput: string[];
  • Type: string[]

vpcEndpointDnsNameInputOptional
public readonly vpcEndpointDnsNameInput: string;
  • Type: string

accessBasedEnumerationRequired
public readonly accessBasedEnumeration: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

adminUserListRequired
public readonly adminUserList: string[];
  • Type: string[]

auditDestinationArnRequired
public readonly auditDestinationArn: string;
  • Type: string

authenticationRequired
public readonly authentication: string;
  • Type: string

bucketRegionRequired
public readonly bucketRegion: string;
  • Type: string

caseSensitivityRequired
public readonly caseSensitivity: string;
  • Type: string

defaultStorageClassRequired
public readonly defaultStorageClass: string;
  • Type: string

fileShareNameRequired
public readonly fileShareName: string;
  • Type: string

gatewayArnRequired
public readonly gatewayArn: string;
  • Type: string

guessMimeTypeEnabledRequired
public readonly guessMimeTypeEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

idRequired
public readonly id: string;
  • Type: string

invalidUserListRequired
public readonly invalidUserList: string[];
  • Type: string[]

kmsEncryptedRequired
public readonly kmsEncrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

kmsKeyArnRequired
public readonly kmsKeyArn: string;
  • Type: string

locationArnRequired
public readonly locationArn: string;
  • Type: string

notificationPolicyRequired
public readonly notificationPolicy: string;
  • Type: string

objectAclRequired
public readonly objectAcl: string;
  • Type: string

oplocksEnabledRequired
public readonly oplocksEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

readOnlyRequired
public readonly readOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

requesterPaysRequired
public readonly requesterPays: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

roleArnRequired
public readonly roleArn: string;
  • Type: string

smbAclEnabledRequired
public readonly smbAclEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

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

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

validUserListRequired
public readonly validUserList: string[];
  • Type: string[]

vpcEndpointDnsNameRequired
public readonly vpcEndpointDnsName: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

StoragegatewaySmbFileShareCacheAttributes

Initializer

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

const storagegatewaySmbFileShareCacheAttributes: storagegatewaySmbFileShare.StoragegatewaySmbFileShareCacheAttributes = { ... }

Properties

Name Type Description
cacheStaleTimeoutInSeconds number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#cache_stale_timeout_in_seconds StoragegatewaySmbFileShare#cache_stale_timeout_in_seconds}.

cacheStaleTimeoutInSecondsOptional
public readonly cacheStaleTimeoutInSeconds: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#cache_stale_timeout_in_seconds StoragegatewaySmbFileShare#cache_stale_timeout_in_seconds}.


StoragegatewaySmbFileShareConfig

Initializer

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

const storagegatewaySmbFileShareConfig: storagegatewaySmbFileShare.StoragegatewaySmbFileShareConfig = { ... }

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.
gatewayArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#gateway_arn StoragegatewaySmbFileShare#gateway_arn}.
locationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#location_arn StoragegatewaySmbFileShare#location_arn}.
roleArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#role_arn StoragegatewaySmbFileShare#role_arn}.
accessBasedEnumeration boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#access_based_enumeration StoragegatewaySmbFileShare#access_based_enumeration}.
adminUserList string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#admin_user_list StoragegatewaySmbFileShare#admin_user_list}.
auditDestinationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#audit_destination_arn StoragegatewaySmbFileShare#audit_destination_arn}.
authentication string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#authentication StoragegatewaySmbFileShare#authentication}.
bucketRegion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#bucket_region StoragegatewaySmbFileShare#bucket_region}.
cacheAttributes StoragegatewaySmbFileShareCacheAttributes cache_attributes block.
caseSensitivity string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#case_sensitivity StoragegatewaySmbFileShare#case_sensitivity}.
defaultStorageClass string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#default_storage_class StoragegatewaySmbFileShare#default_storage_class}.
fileShareName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#file_share_name StoragegatewaySmbFileShare#file_share_name}.
guessMimeTypeEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#guess_mime_type_enabled StoragegatewaySmbFileShare#guess_mime_type_enabled}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#id StoragegatewaySmbFileShare#id}.
invalidUserList string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#invalid_user_list StoragegatewaySmbFileShare#invalid_user_list}.
kmsEncrypted boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#kms_encrypted StoragegatewaySmbFileShare#kms_encrypted}.
kmsKeyArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#kms_key_arn StoragegatewaySmbFileShare#kms_key_arn}.
notificationPolicy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#notification_policy StoragegatewaySmbFileShare#notification_policy}.
objectAcl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#object_acl StoragegatewaySmbFileShare#object_acl}.
oplocksEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#oplocks_enabled StoragegatewaySmbFileShare#oplocks_enabled}.
readOnly boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#read_only StoragegatewaySmbFileShare#read_only}.
requesterPays boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#requester_pays StoragegatewaySmbFileShare#requester_pays}.
smbAclEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#smb_acl_enabled StoragegatewaySmbFileShare#smb_acl_enabled}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#tags StoragegatewaySmbFileShare#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#tags_all StoragegatewaySmbFileShare#tags_all}.
timeouts StoragegatewaySmbFileShareTimeouts timeouts block.
validUserList string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#valid_user_list StoragegatewaySmbFileShare#valid_user_list}.
vpcEndpointDnsName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#vpc_endpoint_dns_name StoragegatewaySmbFileShare#vpc_endpoint_dns_name}.

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

gatewayArnRequired
public readonly gatewayArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#gateway_arn StoragegatewaySmbFileShare#gateway_arn}.


locationArnRequired
public readonly locationArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#location_arn StoragegatewaySmbFileShare#location_arn}.


roleArnRequired
public readonly roleArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#role_arn StoragegatewaySmbFileShare#role_arn}.


accessBasedEnumerationOptional
public readonly accessBasedEnumeration: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#access_based_enumeration StoragegatewaySmbFileShare#access_based_enumeration}.


adminUserListOptional
public readonly adminUserList: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#admin_user_list StoragegatewaySmbFileShare#admin_user_list}.


auditDestinationArnOptional
public readonly auditDestinationArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#audit_destination_arn StoragegatewaySmbFileShare#audit_destination_arn}.


authenticationOptional
public readonly authentication: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#authentication StoragegatewaySmbFileShare#authentication}.


bucketRegionOptional
public readonly bucketRegion: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#bucket_region StoragegatewaySmbFileShare#bucket_region}.


cacheAttributesOptional
public readonly cacheAttributes: StoragegatewaySmbFileShareCacheAttributes;

cache_attributes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#cache_attributes StoragegatewaySmbFileShare#cache_attributes}


caseSensitivityOptional
public readonly caseSensitivity: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#case_sensitivity StoragegatewaySmbFileShare#case_sensitivity}.


defaultStorageClassOptional
public readonly defaultStorageClass: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#default_storage_class StoragegatewaySmbFileShare#default_storage_class}.


fileShareNameOptional
public readonly fileShareName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#file_share_name StoragegatewaySmbFileShare#file_share_name}.


guessMimeTypeEnabledOptional
public readonly guessMimeTypeEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#guess_mime_type_enabled StoragegatewaySmbFileShare#guess_mime_type_enabled}.


idOptional
public readonly id: string;
  • Type: string

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


invalidUserListOptional
public readonly invalidUserList: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#invalid_user_list StoragegatewaySmbFileShare#invalid_user_list}.


kmsEncryptedOptional
public readonly kmsEncrypted: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#kms_encrypted StoragegatewaySmbFileShare#kms_encrypted}.


kmsKeyArnOptional
public readonly kmsKeyArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#kms_key_arn StoragegatewaySmbFileShare#kms_key_arn}.


notificationPolicyOptional
public readonly notificationPolicy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#notification_policy StoragegatewaySmbFileShare#notification_policy}.


objectAclOptional
public readonly objectAcl: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#object_acl StoragegatewaySmbFileShare#object_acl}.


oplocksEnabledOptional
public readonly oplocksEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#oplocks_enabled StoragegatewaySmbFileShare#oplocks_enabled}.


readOnlyOptional
public readonly readOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#read_only StoragegatewaySmbFileShare#read_only}.


requesterPaysOptional
public readonly requesterPays: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#requester_pays StoragegatewaySmbFileShare#requester_pays}.


smbAclEnabledOptional
public readonly smbAclEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#smb_acl_enabled StoragegatewaySmbFileShare#smb_acl_enabled}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#tags StoragegatewaySmbFileShare#tags}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#tags_all StoragegatewaySmbFileShare#tags_all}.


timeoutsOptional
public readonly timeouts: StoragegatewaySmbFileShareTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#timeouts StoragegatewaySmbFileShare#timeouts}


validUserListOptional
public readonly validUserList: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#valid_user_list StoragegatewaySmbFileShare#valid_user_list}.


vpcEndpointDnsNameOptional
public readonly vpcEndpointDnsName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#vpc_endpoint_dns_name StoragegatewaySmbFileShare#vpc_endpoint_dns_name}.


StoragegatewaySmbFileShareTimeouts

Initializer

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

const storagegatewaySmbFileShareTimeouts: storagegatewaySmbFileShare.StoragegatewaySmbFileShareTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#create StoragegatewaySmbFileShare#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#delete StoragegatewaySmbFileShare#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#update StoragegatewaySmbFileShare#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#create StoragegatewaySmbFileShare#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#delete StoragegatewaySmbFileShare#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/storagegateway_smb_file_share#update StoragegatewaySmbFileShare#update}.


Classes

StoragegatewaySmbFileShareCacheAttributesOutputReference

Initializers

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

new storagegatewaySmbFileShare.StoragegatewaySmbFileShareCacheAttributesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCacheStaleTimeoutInSeconds 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.

resetCacheStaleTimeoutInSeconds
public resetCacheStaleTimeoutInSeconds(): 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.
cacheStaleTimeoutInSecondsInput number No description.
cacheStaleTimeoutInSeconds number No description.
internalValue StoragegatewaySmbFileShareCacheAttributes 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

cacheStaleTimeoutInSecondsInputOptional
public readonly cacheStaleTimeoutInSecondsInput: number;
  • Type: number

cacheStaleTimeoutInSecondsRequired
public readonly cacheStaleTimeoutInSeconds: number;
  • Type: number

internalValueOptional
public readonly internalValue: StoragegatewaySmbFileShareCacheAttributes;

StoragegatewaySmbFileShareTimeoutsOutputReference

Initializers

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

new storagegatewaySmbFileShare.StoragegatewaySmbFileShareTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.

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

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

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

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

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

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

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

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

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | StoragegatewaySmbFileShareTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | StoragegatewaySmbFileShareTimeouts;