Module datasync

@pulumi/aws > datasync

Index

datasync/agent.ts datasync/efsLocation.ts datasync/nfsLocation.ts datasync/s3Location.ts datasync/task.ts

class Agent

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.

constructor

new Agent(name: string, args?: AgentArgs, opts?: pulumi.CustomResourceOptions)

Create a Agent resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AgentState): Agent

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property activationKey

public activationKey: pulumi.Output<string>;

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.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the DataSync Agent.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddress

public ipAddress: pulumi.Output<string>;

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.

property name

public name: pulumi.Output<string>;

Name of the DataSync Agent.

property tags

public tags: pulumi.Output<Tags | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class EfsLocation

Manages an AWS DataSync EFS Location.

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

constructor

new EfsLocation(name: string, args: EfsLocationArgs, opts?: pulumi.CustomResourceOptions)

Create a EfsLocation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EfsLocationState): EfsLocation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property ec2Config

public ec2Config: pulumi.Output<{ ... }>;

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

property efsFileSystemArn

public efsFileSystemArn: pulumi.Output<ARN>;

Amazon Resource Name (ARN) of EFS File System.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property subdirectory

public subdirectory: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<Tags | undefined>;

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

property uri

public uri: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class NfsLocation

Manages an NFS Location within AWS DataSync.

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

constructor

new NfsLocation(name: string, args: NfsLocationArgs, opts?: pulumi.CustomResourceOptions)

Create a NfsLocation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NfsLocationState): NfsLocation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property onPremConfig

public onPremConfig: pulumi.Output<{ ... }>;

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

property serverHostname

public serverHostname: pulumi.Output<string>;

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

property subdirectory

public subdirectory: pulumi.Output<string>;

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

property tags

public tags: pulumi.Output<Tags | undefined>;

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

property uri

public uri: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class S3Location

Manages an S3 Location within AWS DataSync.

constructor

new S3Location(name: string, args: S3LocationArgs, opts?: pulumi.CustomResourceOptions)

Create a S3Location resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: S3LocationState): S3Location

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property s3BucketArn

public s3BucketArn: pulumi.Output<ARN>;

Amazon Resource Name (ARN) of the S3 Bucket.

property s3Config

public s3Config: pulumi.Output<{ ... }>;

Configuration block containing information for connecting to S3.

property subdirectory

public subdirectory: pulumi.Output<string>;

Prefix to perform actions as source or destination.

property tags

public tags: pulumi.Output<Tags | undefined>;

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

property uri

public uri: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Task

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.

constructor

new Task(name: string, args: TaskArgs, opts?: pulumi.CustomResourceOptions)

Create a Task resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TaskState): Task

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the DataSync Task.

property cloudwatchLogGroupArn

public cloudwatchLogGroupArn: pulumi.Output<ARN | undefined>;

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

property destinationLocationArn

public destinationLocationArn: pulumi.Output<ARN>;

Amazon Resource Name (ARN) of destination DataSync Location.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the DataSync Task.

property options

public options: pulumi.Output<{ ... } | undefined>;

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.

property sourceLocationArn

public sourceLocationArn: pulumi.Output<ARN>;

Amazon Resource Name (ARN) of source DataSync Location.

property tags

public tags: pulumi.Output<Tags | undefined>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface AgentArgs

The set of arguments for constructing a Agent resource.

property activationKey

activationKey?: pulumi.Input<string>;

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.

property ipAddress

ipAddress?: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

Name of the DataSync Agent.

property tags

tags?: pulumi.Input<Tags>;

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

interface AgentState

Input properties used for looking up and filtering Agent resources.

property activationKey

activationKey?: pulumi.Input<string>;

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.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the DataSync Agent.

property ipAddress

ipAddress?: pulumi.Input<string>;

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.

property name

name?: pulumi.Input<string>;

Name of the DataSync Agent.

property tags

tags?: pulumi.Input<Tags>;

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

interface EfsLocationArgs

The set of arguments for constructing a EfsLocation resource.

property ec2Config

ec2Config: pulumi.Input<{ ... }>;

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

property efsFileSystemArn

efsFileSystemArn: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of EFS File System.

property subdirectory

subdirectory?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

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

interface EfsLocationState

Input properties used for looking up and filtering EfsLocation resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property ec2Config

ec2Config?: pulumi.Input<{ ... }>;

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

property efsFileSystemArn

efsFileSystemArn?: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of EFS File System.

property subdirectory

subdirectory?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

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

property uri

uri?: pulumi.Input<string>;

interface NfsLocationArgs

The set of arguments for constructing a NfsLocation resource.

property onPremConfig

onPremConfig: pulumi.Input<{ ... }>;

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

property serverHostname

serverHostname: pulumi.Input<string>;

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

property subdirectory

subdirectory: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

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

interface NfsLocationState

Input properties used for looking up and filtering NfsLocation resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property onPremConfig

onPremConfig?: pulumi.Input<{ ... }>;

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

property serverHostname

serverHostname?: pulumi.Input<string>;

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

property subdirectory

subdirectory?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

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

property uri

uri?: pulumi.Input<string>;

interface S3LocationArgs

The set of arguments for constructing a S3Location resource.

property s3BucketArn

s3BucketArn: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of the S3 Bucket.

property s3Config

s3Config: pulumi.Input<{ ... }>;

Configuration block containing information for connecting to S3.

property subdirectory

subdirectory: pulumi.Input<string>;

Prefix to perform actions as source or destination.

property tags

tags?: pulumi.Input<Tags>;

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

interface S3LocationState

Input properties used for looking up and filtering S3Location resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the DataSync Location.

property s3BucketArn

s3BucketArn?: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of the S3 Bucket.

property s3Config

s3Config?: pulumi.Input<{ ... }>;

Configuration block containing information for connecting to S3.

property subdirectory

subdirectory?: pulumi.Input<string>;

Prefix to perform actions as source or destination.

property tags

tags?: pulumi.Input<Tags>;

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

property uri

uri?: pulumi.Input<string>;

interface TaskArgs

The set of arguments for constructing a Task resource.

property cloudwatchLogGroupArn

cloudwatchLogGroupArn?: pulumi.Input<ARN>;

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

property destinationLocationArn

destinationLocationArn: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of destination DataSync Location.

property name

name?: pulumi.Input<string>;

Name of the DataSync Task.

property options

options?: pulumi.Input<{ ... }>;

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.

property sourceLocationArn

sourceLocationArn: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of source DataSync Location.

property tags

tags?: pulumi.Input<Tags>;

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

interface TaskState

Input properties used for looking up and filtering Task resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the DataSync Task.

property cloudwatchLogGroupArn

cloudwatchLogGroupArn?: pulumi.Input<ARN>;

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

property destinationLocationArn

destinationLocationArn?: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of destination DataSync Location.

property name

name?: pulumi.Input<string>;

Name of the DataSync Task.

property options

options?: pulumi.Input<{ ... }>;

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.

property sourceLocationArn

sourceLocationArn?: pulumi.Input<ARN>;

Amazon Resource Name (ARN) of source DataSync Location.

property tags

tags?: pulumi.Input<Tags>;

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