Class: Aws::DataSync::Types::UpdateLocationObjectStorageRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:secret_key]

Instance Attribute Summary collapse

Instance Attribute Details

#access_keyString

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#agent_arnsArray<String>

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

Returns:

  • (Array<String>)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#location_arnString

Specifies the ARN of the object storage system location that you're updating.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#secret_keyString

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_certificateString

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

  • The object storage system's certificate

  • All intermediate certificates (if there are any)

  • The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_portInteger

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Returns:

  • (Integer)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#server_protocolString

Specifies the protocol that your object storage server uses to communicate.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end

#subdirectoryString

Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.

Returns:

  • (String)


5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 5979

class UpdateLocationObjectStorageRequest < Struct.new(
  :location_arn,
  :server_port,
  :server_protocol,
  :subdirectory,
  :access_key,
  :secret_key,
  :agent_arns,
  :server_certificate)
  SENSITIVE = [:secret_key]
  include Aws::Structure
end