Skip to content

Latest commit

 

History

History
3040 lines (1883 loc) · 125 KB

datasyncTask.md

File metadata and controls

3040 lines (1883 loc) · 125 KB

datasyncTask Submodule

Constructs

DatasyncTask

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

Initializers 

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

new datasyncTask.DatasyncTask(scope: Construct, id: string, config: DatasyncTaskConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DatasyncTaskConfig 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".
putExcludes No description.
putOptions No description.
putSchedule No description.
putTimeouts No description.
resetCloudwatchLogGroupArn No description.
resetExcludes No description.
resetId No description.
resetName No description.
resetOptions No description.
resetSchedule No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts 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".

putExcludes 
public putExcludes(value: DatasyncTaskExcludes): void
valueRequired
putOptions 
public putOptions(value: DatasyncTaskOptions): void
valueRequired
putSchedule 
public putSchedule(value: DatasyncTaskSchedule): void
valueRequired
putTimeouts 
public putTimeouts(value: DatasyncTaskTimeouts): void
valueRequired
resetCloudwatchLogGroupArn 
public resetCloudwatchLogGroupArn(): void
resetExcludes 
public resetExcludes(): void
resetId 
public resetId(): void
resetName 
public resetName(): void
resetOptions 
public resetOptions(): void
resetSchedule 
public resetSchedule(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTimeouts 
public resetTimeouts(): 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 DatasyncTask resource upon running "cdktf plan ".
isConstruct 
import { datasyncTask } from '@cdktf/aws-cdk'

datasyncTask.DatasyncTask.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

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

datasyncTask.DatasyncTask.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { datasyncTask } from '@cdktf/aws-cdk'

datasyncTask.DatasyncTask.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { datasyncTask } from '@cdktf/aws-cdk'

datasyncTask.DatasyncTask.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing DatasyncTask that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#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 DatasyncTask 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.
excludes DatasyncTaskExcludesOutputReference No description.
options DatasyncTaskOptionsOutputReference No description.
schedule DatasyncTaskScheduleOutputReference No description.
timeouts DatasyncTaskTimeoutsOutputReference No description.
cloudwatchLogGroupArnInput string No description.
destinationLocationArnInput string No description.
excludesInput DatasyncTaskExcludes No description.
idInput string No description.
nameInput string No description.
optionsInput DatasyncTaskOptions No description.
scheduleInput DatasyncTaskSchedule No description.
sourceLocationArnInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | DatasyncTaskTimeouts No description.
cloudwatchLogGroupArn string No description.
destinationLocationArn string No description.
id string No description.
name string No description.
sourceLocationArn string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: 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
excludesRequired 
public readonly excludes: DatasyncTaskExcludesOutputReference;
optionsRequired 
public readonly options: DatasyncTaskOptionsOutputReference;
scheduleRequired 
public readonly schedule: DatasyncTaskScheduleOutputReference;
timeoutsRequired 
public readonly timeouts: DatasyncTaskTimeoutsOutputReference;
cloudwatchLogGroupArnInputOptional 
public readonly cloudwatchLogGroupArnInput: string;
  • Type: string
destinationLocationArnInputOptional 
public readonly destinationLocationArnInput: string;
  • Type: string
excludesInputOptional 
public readonly excludesInput: DatasyncTaskExcludes;
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
optionsInputOptional 
public readonly optionsInput: DatasyncTaskOptions;
scheduleInputOptional 
public readonly scheduleInput: DatasyncTaskSchedule;
sourceLocationArnInputOptional 
public readonly sourceLocationArnInput: string;
  • Type: string
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 | DatasyncTaskTimeouts;
cloudwatchLogGroupArnRequired 
public readonly cloudwatchLogGroupArn: string;
  • Type: string
destinationLocationArnRequired 
public readonly destinationLocationArn: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
sourceLocationArnRequired 
public readonly sourceLocationArn: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

DatasyncTaskConfig

Initializer 

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

const datasyncTaskConfig: datasyncTask.DatasyncTaskConfig = { ... }

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.
destinationLocationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#destination_location_arn DatasyncTask#destination_location_arn}.
sourceLocationArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#source_location_arn DatasyncTask#source_location_arn}.
cloudwatchLogGroupArn string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#cloudwatch_log_group_arn DatasyncTask#cloudwatch_log_group_arn}.
excludes DatasyncTaskExcludes excludes block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#id DatasyncTask#id}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#name DatasyncTask#name}.
options DatasyncTaskOptions options block.
schedule DatasyncTaskSchedule schedule block.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#tags DatasyncTask#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#tags_all DatasyncTask#tags_all}.
timeouts DatasyncTaskTimeouts timeouts block.
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[]
destinationLocationArnRequired 
public readonly destinationLocationArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#destination_location_arn DatasyncTask#destination_location_arn}.

sourceLocationArnRequired 
public readonly sourceLocationArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#source_location_arn DatasyncTask#source_location_arn}.

cloudwatchLogGroupArnOptional 
public readonly cloudwatchLogGroupArn: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#cloudwatch_log_group_arn DatasyncTask#cloudwatch_log_group_arn}.

excludesOptional 
public readonly excludes: DatasyncTaskExcludes;

excludes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#excludes DatasyncTask#excludes}

idOptional 
public readonly id: string;
  • Type: string

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

nameOptional 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#name DatasyncTask#name}.

optionsOptional 
public readonly options: DatasyncTaskOptions;

options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#options DatasyncTask#options}

scheduleOptional 
public readonly schedule: DatasyncTaskSchedule;

schedule block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#schedule DatasyncTask#schedule}

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/datasync_task#tags DatasyncTask#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/datasync_task#tags_all DatasyncTask#tags_all}.

timeoutsOptional 
public readonly timeouts: DatasyncTaskTimeouts;

timeouts block.

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

DatasyncTaskExcludes

Initializer 

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

const datasyncTaskExcludes: datasyncTask.DatasyncTaskExcludes = { ... }

Properties

Name Type Description
filterType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#filter_type DatasyncTask#filter_type}.
value string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#value DatasyncTask#value}.
filterTypeOptional 
public readonly filterType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#filter_type DatasyncTask#filter_type}.

valueOptional 
public readonly value: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#value DatasyncTask#value}.

DatasyncTaskOptions

Initializer 

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

const datasyncTaskOptions: datasyncTask.DatasyncTaskOptions = { ... }

Properties

Name Type Description
atime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#atime DatasyncTask#atime}.
bytesPerSecond number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#bytes_per_second DatasyncTask#bytes_per_second}.
gid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#gid DatasyncTask#gid}.
logLevel string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#log_level DatasyncTask#log_level}.
mtime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#mtime DatasyncTask#mtime}.
overwriteMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#overwrite_mode DatasyncTask#overwrite_mode}.
posixPermissions string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#posix_permissions DatasyncTask#posix_permissions}.
preserveDeletedFiles string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#preserve_deleted_files DatasyncTask#preserve_deleted_files}.
preserveDevices string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#preserve_devices DatasyncTask#preserve_devices}.
taskQueueing string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#task_queueing DatasyncTask#task_queueing}.
transferMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#transfer_mode DatasyncTask#transfer_mode}.
uid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#uid DatasyncTask#uid}.
verifyMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#verify_mode DatasyncTask#verify_mode}.
atimeOptional 
public readonly atime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#atime DatasyncTask#atime}.

bytesPerSecondOptional 
public readonly bytesPerSecond: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#bytes_per_second DatasyncTask#bytes_per_second}.

gidOptional 
public readonly gid: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#gid DatasyncTask#gid}.

logLevelOptional 
public readonly logLevel: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#log_level DatasyncTask#log_level}.

mtimeOptional 
public readonly mtime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#mtime DatasyncTask#mtime}.

overwriteModeOptional 
public readonly overwriteMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#overwrite_mode DatasyncTask#overwrite_mode}.

posixPermissionsOptional 
public readonly posixPermissions: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#posix_permissions DatasyncTask#posix_permissions}.

preserveDeletedFilesOptional 
public readonly preserveDeletedFiles: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#preserve_deleted_files DatasyncTask#preserve_deleted_files}.

preserveDevicesOptional 
public readonly preserveDevices: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#preserve_devices DatasyncTask#preserve_devices}.

taskQueueingOptional 
public readonly taskQueueing: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#task_queueing DatasyncTask#task_queueing}.

transferModeOptional 
public readonly transferMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#transfer_mode DatasyncTask#transfer_mode}.

uidOptional 
public readonly uid: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#uid DatasyncTask#uid}.

verifyModeOptional 
public readonly verifyMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#verify_mode DatasyncTask#verify_mode}.

DatasyncTaskSchedule

Initializer 

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

const datasyncTaskSchedule: datasyncTask.DatasyncTaskSchedule = { ... }

Properties

Name Type Description
scheduleExpression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#schedule_expression DatasyncTask#schedule_expression}.
scheduleExpressionRequired 
public readonly scheduleExpression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#schedule_expression DatasyncTask#schedule_expression}.

DatasyncTaskTimeouts

Initializer 

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

const datasyncTaskTimeouts: datasyncTask.DatasyncTaskTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/datasync_task#create DatasyncTask#create}.
createOptional 
public readonly create: string;
  • Type: string

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

Classes

DatasyncTaskExcludesOutputReference

Initializers 

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

new datasyncTask.DatasyncTaskExcludesOutputReference(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.
resetFilterType No description.
resetValue 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.

resetFilterType 
public resetFilterType(): void
resetValue 
public resetValue(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
filterTypeInput string No description.
valueInput string No description.
filterType string No description.
value string No description.
internalValue DatasyncTaskExcludes 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
filterTypeInputOptional 
public readonly filterTypeInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string;
  • Type: string
filterTypeRequired 
public readonly filterType: string;
  • Type: string
valueRequired 
public readonly value: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DatasyncTaskExcludes;

DatasyncTaskOptionsOutputReference

Initializers 

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

new datasyncTask.DatasyncTaskOptionsOutputReference(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.
resetAtime No description.
resetBytesPerSecond No description.
resetGid No description.
resetLogLevel No description.
resetMtime No description.
resetOverwriteMode No description.
resetPosixPermissions No description.
resetPreserveDeletedFiles No description.
resetPreserveDevices No description.
resetTaskQueueing No description.
resetTransferMode No description.
resetUid No description.
resetVerifyMode 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.

resetAtime 
public resetAtime(): void
resetBytesPerSecond 
public resetBytesPerSecond(): void
resetGid 
public resetGid(): void
resetLogLevel 
public resetLogLevel(): void
resetMtime 
public resetMtime(): void
resetOverwriteMode 
public resetOverwriteMode(): void
resetPosixPermissions 
public resetPosixPermissions(): void
resetPreserveDeletedFiles 
public resetPreserveDeletedFiles(): void
resetPreserveDevices 
public resetPreserveDevices(): void
resetTaskQueueing 
public resetTaskQueueing(): void
resetTransferMode 
public resetTransferMode(): void
resetUid 
public resetUid(): void
resetVerifyMode 
public resetVerifyMode(): 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.
atimeInput string No description.
bytesPerSecondInput number No description.
gidInput string No description.
logLevelInput string No description.
mtimeInput string No description.
overwriteModeInput string No description.
posixPermissionsInput string No description.
preserveDeletedFilesInput string No description.
preserveDevicesInput string No description.
taskQueueingInput string No description.
transferModeInput string No description.
uidInput string No description.
verifyModeInput string No description.
atime string No description.
bytesPerSecond number No description.
gid string No description.
logLevel string No description.
mtime string No description.
overwriteMode string No description.
posixPermissions string No description.
preserveDeletedFiles string No description.
preserveDevices string No description.
taskQueueing string No description.
transferMode string No description.
uid string No description.
verifyMode string No description.
internalValue DatasyncTaskOptions 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
atimeInputOptional 
public readonly atimeInput: string;
  • Type: string
bytesPerSecondInputOptional 
public readonly bytesPerSecondInput: number;
  • Type: number
gidInputOptional 
public readonly gidInput: string;
  • Type: string
logLevelInputOptional 
public readonly logLevelInput: string;
  • Type: string
mtimeInputOptional 
public readonly mtimeInput: string;
  • Type: string
overwriteModeInputOptional 
public readonly overwriteModeInput: string;
  • Type: string
posixPermissionsInputOptional 
public readonly posixPermissionsInput: string;
  • Type: string
preserveDeletedFilesInputOptional 
public readonly preserveDeletedFilesInput: string;
  • Type: string
preserveDevicesInputOptional 
public readonly preserveDevicesInput: string;
  • Type: string
taskQueueingInputOptional 
public readonly taskQueueingInput: string;
  • Type: string
transferModeInputOptional 
public readonly transferModeInput: string;
  • Type: string
uidInputOptional 
public readonly uidInput: string;
  • Type: string
verifyModeInputOptional 
public readonly verifyModeInput: string;
  • Type: string
atimeRequired 
public readonly atime: string;
  • Type: string
bytesPerSecondRequired 
public readonly bytesPerSecond: number;
  • Type: number
gidRequired 
public readonly gid: string;
  • Type: string
logLevelRequired 
public readonly logLevel: string;
  • Type: string
mtimeRequired 
public readonly mtime: string;
  • Type: string
overwriteModeRequired 
public readonly overwriteMode: string;
  • Type: string
posixPermissionsRequired 
public readonly posixPermissions: string;
  • Type: string
preserveDeletedFilesRequired 
public readonly preserveDeletedFiles: string;
  • Type: string
preserveDevicesRequired 
public readonly preserveDevices: string;
  • Type: string
taskQueueingRequired 
public readonly taskQueueing: string;
  • Type: string
transferModeRequired 
public readonly transferMode: string;
  • Type: string
uidRequired 
public readonly uid: string;
  • Type: string
verifyModeRequired 
public readonly verifyMode: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DatasyncTaskOptions;

DatasyncTaskScheduleOutputReference

Initializers 

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

new datasyncTask.DatasyncTaskScheduleOutputReference(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.
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.

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.
scheduleExpressionInput string No description.
scheduleExpression string No description.
internalValue DatasyncTaskSchedule 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
scheduleExpressionInputOptional 
public readonly scheduleExpressionInput: string;
  • Type: string
scheduleExpressionRequired 
public readonly scheduleExpression: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DatasyncTaskSchedule;

DatasyncTaskTimeoutsOutputReference

Initializers 

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

new datasyncTask.DatasyncTaskTimeoutsOutputReference(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.
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

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.
create string No description.
internalValue cdktf.IResolvable | DatasyncTaskTimeouts 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
createRequired 
public readonly create: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DatasyncTaskTimeouts;