AWS::DataSync::LocationObjectStorage

The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a Location for Object Storage.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationObjectStorage",
  "Properties" : {
      "AccessKey" : String,
      "AgentArns" : [ String, ... ],
      "BucketName" : String,
      "SecretKey" : String,
      "ServerHostname" : String,
      "ServerPort" : Integer,
      "ServerProtocol" : String,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationObjectStorage
Properties: 
  AccessKey: String
  AgentArns: 
    - String
  BucketName: String
  SecretKey: String
  ServerHostname: String
  ServerPort: Integer
  ServerProtocol: String
  Subdirectory: String
  Tags: 
    - Tag

Properties

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.

Required: No

Type: String

Minimum: 8

Maximum: 200

Pattern: ^.+$

Update requires: No interruption

AgentArns

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Required: Yes

Type: List of String

Maximum: 4

Update requires: No interruption

BucketName

The bucket on the self-managed object storage server that is used to read data from.

Required: Yes

Type: String

Minimum: 3

Maximum: 63

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Update requires: Replacement

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.

Required: No

Type: String

Minimum: 8

Maximum: 200

Pattern: ^.+$

Update requires: No interruption

ServerHostname

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.

Required: Yes

Type: String

Maximum: 255

Pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

Update requires: Replacement

ServerPort

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 65536

Update requires: No interruption

ServerProtocol

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Required: No

Type: String

Allowed values: HTTP | HTTPS

Update requires: No interruption

Subdirectory

The subdirectory in the self-managed object storage server that is used to read data from.

Required: No

Type: String

Maximum: 4096

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

Update requires: No interruption

Tags

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Required: No

Type: List of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the location resource ARN. For example:

arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

LocationArn

The Amazon Resource Name (ARN) of the specified object storage location.

LocationUri

The URL of the specified object storage location.

Examples

Object storage location for DataSync

The following example specifies an object storage location for DataSync. In this example, the object storage location uses the bucket named MyBucket, on the server named [e-mail]. This example also specifies the server protocol HTTPS and the subdirectory /Subdirectory.

JSON

{
"AWSTemplateFormatVersion": "2010-09-09",
"Description": "Specifies an object storage location for DataSync",
"Resources": 
{
  "LocationObjectStorage": {
    "Type": "AWS::DataSync::LocationObjectStorage",
    "Properties": {
      "AgentArns": [
        "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs"
      ],
      "BucketName": "MyBucket",
      "ServerHostname": "[e-mail]",
      "ServerProtocol": "HTTPS",
      "Subdirectory": "/MySubdirectory"
    }
  }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: Specifies an object storage location for DataSync
Resources:
  LocationObjectStorage:
    Type: AWS::DataSync::LocationObjectStorage
    Properties: 
      AgentArns: 
        - arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs
      BucketName: MyBucket
      ServerHostname: [e-mail]
      ServerProtocol: HTTPS
      Subdirectory: /MySubdirectory