datasync

class pulumi_aws.datasync.Agent(resource_name, opts=None, activation_key=None, ip_address=None, name=None, tags=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, Terraform 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, Terraform 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 Terraform 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, Terraform 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 Terraform is running.

name = None

Name of the DataSync Agent.

tags = None

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, __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.
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.

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.

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, __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.
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.

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.

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, __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.
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.

subdirectory = None

Prefix to perform actions as source or destination.

tags = None

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

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, __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 Terraform 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.
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.

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.

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