datasync

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.datasync.Agent(resource_name, opts=None, activation_key=None, ip_address=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an AWS DataSync Agent deployed on premises.

NOTE: One of activation_key or ip_address must be provided for resource creation (agent activation). Neither is required for resource import. If using ip_address, this provider must be able to make an HTTP (port 80) GET request to the specified IP address from where it is running. The agent will turn off that HTTP server after activation.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • activation_key (pulumi.Input[str]) – DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.

  • ip_address (pulumi.Input[str]) – DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.

  • name (pulumi.Input[str]) – Name of the DataSync Agent.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Agent.

activation_key = None

DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.

arn = None

Amazon Resource Name (ARN) of the DataSync Agent.

ip_address = None

DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.

name = None

Name of the DataSync Agent.

tags = None

Key-value pairs of resource tags to assign to the DataSync Agent.

static get(resource_name, id, opts=None, activation_key=None, arn=None, ip_address=None, name=None, tags=None)

Get an existing Agent resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • activation_key (pulumi.Input[str]) – DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.

  • arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the DataSync Agent.

  • ip_address (pulumi.Input[str]) – DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.

  • name (pulumi.Input[str]) – Name of the DataSync Agent.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Agent.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.datasync.EfsLocation(resource_name, opts=None, ec2_config=None, efs_file_system_arn=None, subdirectory=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an AWS DataSync EFS Location.

NOTE: The EFS File System must have a mounted EFS Mount Target before creating this resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • ec2_config (pulumi.Input[dict]) – Configuration block containing EC2 configurations for connecting to the EFS File System.

  • efs_file_system_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of EFS File System.

  • subdirectory (pulumi.Input[str]) – Subdirectory to perform actions as source or destination. Default /.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The ec2_config object supports the following:

  • securityGroupArns (pulumi.Input[list]) - List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.

  • subnetArn (pulumi.Input[str]) - Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

arn = None

Amazon Resource Name (ARN) of the DataSync Location.

ec2_config = None

Configuration block containing EC2 configurations for connecting to the EFS File System.

  • securityGroupArns (list) - List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.

  • subnetArn (str) - Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

efs_file_system_arn = None

Amazon Resource Name (ARN) of EFS File System.

subdirectory = None

Subdirectory to perform actions as source or destination. Default /.

tags = None

Key-value pairs of resource tags to assign to the DataSync Location.

static get(resource_name, id, opts=None, arn=None, ec2_config=None, efs_file_system_arn=None, subdirectory=None, tags=None, uri=None)

Get an existing EfsLocation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the DataSync Location.

  • ec2_config (pulumi.Input[dict]) – Configuration block containing EC2 configurations for connecting to the EFS File System.

  • efs_file_system_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of EFS File System.

  • subdirectory (pulumi.Input[str]) – Subdirectory to perform actions as source or destination. Default /.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The ec2_config object supports the following:

  • securityGroupArns (pulumi.Input[list]) - List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.

  • subnetArn (pulumi.Input[str]) - Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.datasync.NfsLocation(resource_name, opts=None, on_prem_config=None, server_hostname=None, subdirectory=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an NFS Location within AWS DataSync.

NOTE: The DataSync Agents must be available before creating this resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • on_prem_config (pulumi.Input[dict]) – Configuration block containing information for connecting to the NFS File System.

  • server_hostname (pulumi.Input[str]) – Specifies the IP address or DNS name of the NFS server. The DataSync Agent(s) use this to mount the NFS server.

  • subdirectory (pulumi.Input[str]) – Subdirectory to perform actions as source or destination. Should be exported by the NFS server.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The on_prem_config object supports the following:

  • agentArns (pulumi.Input[list]) - List of Amazon Resource Names (ARNs) of the DataSync Agents used to connect to the NFS server.

arn = None

Amazon Resource Name (ARN) of the DataSync Location.

on_prem_config = None

Configuration block containing information for connecting to the NFS File System.

  • agentArns (list) - List of Amazon Resource Names (ARNs) of the DataSync Agents used to connect to the NFS server.

server_hostname = None

Specifies the IP address or DNS name of the NFS server. The DataSync Agent(s) use this to mount the NFS server.

subdirectory = None

Subdirectory to perform actions as source or destination. Should be exported by the NFS server.

tags = None

Key-value pairs of resource tags to assign to the DataSync Location.

static get(resource_name, id, opts=None, arn=None, on_prem_config=None, server_hostname=None, subdirectory=None, tags=None, uri=None)

Get an existing NfsLocation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the DataSync Location.

  • on_prem_config (pulumi.Input[dict]) – Configuration block containing information for connecting to the NFS File System.

  • server_hostname (pulumi.Input[str]) – Specifies the IP address or DNS name of the NFS server. The DataSync Agent(s) use this to mount the NFS server.

  • subdirectory (pulumi.Input[str]) – Subdirectory to perform actions as source or destination. Should be exported by the NFS server.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The on_prem_config object supports the following:

  • agentArns (pulumi.Input[list]) - List of Amazon Resource Names (ARNs) of the DataSync Agents used to connect to the NFS server.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.datasync.S3Location(resource_name, opts=None, s3_bucket_arn=None, s3_config=None, subdirectory=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an S3 Location within AWS DataSync.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • s3_bucket_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the S3 Bucket.

  • s3_config (pulumi.Input[dict]) – Configuration block containing information for connecting to S3.

  • subdirectory (pulumi.Input[str]) – Prefix to perform actions as source or destination.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The s3_config object supports the following:

  • bucketAccessRoleArn (pulumi.Input[str]) - Amazon Resource Names (ARN) of the IAM Role used to connect to the S3 Bucket.

arn = None

Amazon Resource Name (ARN) of the DataSync Location.

s3_bucket_arn = None

Amazon Resource Name (ARN) of the S3 Bucket.

s3_config = None

Configuration block containing information for connecting to S3.

  • bucketAccessRoleArn (str) - Amazon Resource Names (ARN) of the IAM Role used to connect to the S3 Bucket.

subdirectory = None

Prefix to perform actions as source or destination.

tags = None

Key-value pairs of resource tags to assign to the DataSync Location.

static get(resource_name, id, opts=None, arn=None, s3_bucket_arn=None, s3_config=None, subdirectory=None, tags=None, uri=None)

Get an existing S3Location resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the DataSync Location.

  • s3_bucket_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the S3 Bucket.

  • s3_config (pulumi.Input[dict]) – Configuration block containing information for connecting to S3.

  • subdirectory (pulumi.Input[str]) – Prefix to perform actions as source or destination.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Location.

The s3_config object supports the following:

  • bucketAccessRoleArn (pulumi.Input[str]) - Amazon Resource Names (ARN) of the IAM Role used to connect to the S3 Bucket.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.datasync.Task(resource_name, opts=None, cloudwatch_log_group_arn=None, destination_location_arn=None, name=None, options=None, source_location_arn=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an AWS DataSync Task, which represents a configuration for synchronization. Starting an execution of these DataSync Tasks (actually synchronizing files) is performed outside of this resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cloudwatch_log_group_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.

  • destination_location_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of destination DataSync Location.

  • name (pulumi.Input[str]) – Name of the DataSync Task.

  • options (pulumi.Input[dict]) – Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.

  • source_location_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of source DataSync Location.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Task.

The options object supports the following:

  • atime (pulumi.Input[str]) - A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.

  • bytesPerSecond (pulumi.Input[float]) - Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).

  • gid (pulumi.Input[str]) - Group identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • mtime (pulumi.Input[str]) - A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.

  • posixPermissions (pulumi.Input[str]) - Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: BEST_EFFORT, NONE, PRESERVE. Default: PRESERVE.

  • preserveDeletedFiles (pulumi.Input[str]) - Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.

  • preserveDevices (pulumi.Input[str]) - Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).

  • uid (pulumi.Input[str]) - User identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • verifyMode (pulumi.Input[str]) - Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT. Default: POINT_IN_TIME_CONSISTENT.

arn = None

Amazon Resource Name (ARN) of the DataSync Task.

cloudwatch_log_group_arn = None

Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.

destination_location_arn = None

Amazon Resource Name (ARN) of destination DataSync Location.

name = None

Name of the DataSync Task.

options = None

Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.

  • atime (str) - A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.

  • bytesPerSecond (float) - Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).

  • gid (str) - Group identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • mtime (str) - A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.

  • posixPermissions (str) - Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: BEST_EFFORT, NONE, PRESERVE. Default: PRESERVE.

  • preserveDeletedFiles (str) - Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.

  • preserveDevices (str) - Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).

  • uid (str) - User identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • verifyMode (str) - Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT. Default: POINT_IN_TIME_CONSISTENT.

source_location_arn = None

Amazon Resource Name (ARN) of source DataSync Location.

tags = None

Key-value pairs of resource tags to assign to the DataSync Task.

static get(resource_name, id, opts=None, arn=None, cloudwatch_log_group_arn=None, destination_location_arn=None, name=None, options=None, source_location_arn=None, tags=None)

Get an existing Task resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the DataSync Task.

  • cloudwatch_log_group_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.

  • destination_location_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of destination DataSync Location.

  • name (pulumi.Input[str]) – Name of the DataSync Task.

  • options (pulumi.Input[dict]) – Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.

  • source_location_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of source DataSync Location.

  • tags (pulumi.Input[dict]) – Key-value pairs of resource tags to assign to the DataSync Task.

The options object supports the following:

  • atime (pulumi.Input[str]) - A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.

  • bytesPerSecond (pulumi.Input[float]) - Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).

  • gid (pulumi.Input[str]) - Group identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • mtime (pulumi.Input[str]) - A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.

  • posixPermissions (pulumi.Input[str]) - Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: BEST_EFFORT, NONE, PRESERVE. Default: PRESERVE.

  • preserveDeletedFiles (pulumi.Input[str]) - Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.

  • preserveDevices (pulumi.Input[str]) - Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).

  • uid (pulumi.Input[str]) - User identifier of the file’s owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).

  • verifyMode (pulumi.Input[str]) - Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT. Default: POINT_IN_TIME_CONSISTENT.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str