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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

Note:

When making an API call, you may pass CreateLocationObjectStorageRequest data as a 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

Constant Summary collapse

SENSITIVE =
[:secret_key]

Instance Attribute Summary collapse

Instance Attribute Details

#access_keyString

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)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#agent_arnsArray<String>

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

Returns:

  • (Array<String>)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#bucket_nameString

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

Returns:

  • (String)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#secret_keyString

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)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_hostnameString

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)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_portInteger

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)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_protocolString

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

Returns:

  • (String)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#subdirectoryString

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

Returns:

  • (String)


732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#tagsArray<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:



732
733
734
735
736
737
738
739
740
741
742
743
744
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 732

class CreateLocationObjectStorageRequest < Struct.new(
  :server_hostname,
  :server_port,
  :server_protocol,
  :subdirectory,
  :bucket_name,
  :access_key,
  :secret_key,
  :agent_arns,
  :tags)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end