You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::CreateLocationObjectStorageRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateLocationObjectStorageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  server_hostname: "ServerHostname", # required
  server_port: 1,
  server_protocol: "HTTPS", # accepts HTTPS, HTTP
  subdirectory: "S3Subdirectory",
  bucket_name: "ObjectStorageBucketName", # required
  access_key: "ObjectStorageAccessKey",
  secret_key: "ObjectStorageSecretKey",
  agent_arns: ["AgentArn"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

CreateLocationObjectStorageRequest

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_key ⇒ String

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.

Returns:

  • (String) —

    Optional.

#agent_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#bucket_name ⇒ String

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

Returns:

  • (String) —

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

#secret_key ⇒ String

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.

Returns:

  • (String) —

    Optional.

#server_hostname ⇒ String

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.

Returns:

  • (String) —

    The name of the self-managed object storage server.

#server_port ⇒ Integer

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.

Returns:

  • (Integer) —

    The port that your self-managed object storage server accepts inbound network traffic on.

#server_protocol ⇒ String

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

Possible values:

  • HTTPS
  • HTTP

Returns:

  • (String) —

    The protocol that the object storage server uses to communicate.

#subdirectory ⇒ String

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

Returns:

  • (String) —

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

#tags ⇒ Array<Types::TagListEntry>

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.

Returns:

  • (Array<Types::TagListEntry>) —

    The key-value pair that represents the tag that you want to add to the location.