Skip to content

Resource: awsDatasyncLocationObjectStorage

Manages a Object Storage Location within AWS DataSync.

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

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.datasyncLocationObjectStorage.DatasyncLocationObjectStorage(
  this,
  "example",
  {
    agentArns: ["${aws_datasync_agent.example.arn}"],
    bucketName: "example",
    serverHostname: "example",
  }
);

Argument Reference

The following arguments are supported:

  • agentArns - (Required) A list of DataSync Agent ARNs with which this location will be associated.
  • accessKey - (Optional) The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use accessKey and secretKey to provide the user name and password, respectively.
  • bucketName - (Required) The bucket on the self-managed object storage server that is used to read data from.
  • secretKey - (Optional) The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use accessKey and secretKey to provide the user name and password, respectively.
  • serverCertificate - (Optional) Specifies a certificate to authenticate with an object storage system that uses a private or self-signed certificate authority (CA). You must specify a Base64-encoded .pem file (for example, file:///home/user/.ssh/storage_sys_certificate.pem). The certificate can be up to 32768 bytes (before Base64 encoding).
  • serverHostname - (Required) The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.
  • serverProtocol - (Optional) The protocol that the object storage server uses to communicate. Valid values are http or https.
  • serverPort - (Optional) The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (http) or TCP 443 (https). You can specify a custom port if your self-managed object storage server requires one.
  • subdirectory - (Optional) A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.
  • tags - (Optional) Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of the DataSync Location.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
  • uri - The URL of the Object Storage location that was described.

Import

awsDatasyncLocationObjectStorage can be imported by using the Amazon Resource Name (ARN), e.g.,

$ terraform import aws_datasync_location_object_storage.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567