CreateLocationObjectStorage
Creates 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.
Request Syntax
{
"AccessKey": "string
",
"AgentArns": [ "string
" ],
"BucketName": "string
",
"SecretKey": "string
",
"ServerHostname": "string
",
"ServerPort": number
,
"ServerProtocol": "string
",
"Subdirectory": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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
andSecretKey
to provide the user name and password, respectively.Type: String
Length Constraints: Minimum length of 8. Maximum length of 200.
Pattern:
^.+$
Required: No
- AgentArns
-
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$
Required: Yes
- BucketName
-
The bucket on the self-managed object storage server that is used to read data from.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$
Required: Yes
- 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
andSecretKey
to provide the user name and password, respectively.Type: String
Length Constraints: Minimum length of 8. Maximum length of 200.
Pattern:
^.+$
Required: No
- 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 hostname to mount the object storage server in a network.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$
Required: Yes
- 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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 65536.
Required: No
- ServerProtocol
-
The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.
Type: String
Valid Values:
HTTPS | HTTP
Required: No
- Subdirectory
-
The subdirectory in the self-managed object storage server that is used to read data from.
Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$
Required: No
- 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.
Type: Array of TagListEntry objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"LocationArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LocationArn
-
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: