Class: Aws::DataSync::Types::CreateLocationSmbRequest

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::CreateLocationSmbRequest

Includes:

Structure

Defined in:

lib/aws-sdk-datasync/types.rb

Overview

CreateLocationSmbRequest

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #agent_arns ⇒ Array<String>

  Specifies the DataSync agent (or agents) that can connect to your SMB file server.

• #authentication_type ⇒ String

  Specifies the authentication protocol that DataSync uses to connect to your SMB file server.

• #cmk_secret_config ⇒ Types::CmkSecretConfig

  Specifies configuration information for a DataSync-managed secret, either a ‘Password` or `KerberosKeytab` (for `NTLM` (default) and `KERBEROS` authentication types, respectively) that DataSync uses to access a specific SMB storage location, with a customer-managed KMS key.

• #custom_secret_config ⇒ Types::CustomSecretConfig

  Specifies configuration information for a customer-managed Secrets Manager secret where the SMB storage location credentials is stored in Secrets Manager as plain text (for ‘Password`) or binary (for `KerberosKeytab`).

• #dns_ip_addresses ⇒ Array<String>

  Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to.

• #domain ⇒ String

  Specifies the Windows domain name that your SMB file server belongs to.

• #kerberos_keytab ⇒ String

  Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

• #kerberos_krb_5_conf ⇒ String

  Specifies a Kerberos configuration file (‘krb5.conf`) that defines your Kerberos realm configuration.

• #kerberos_principal ⇒ String

  Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

• #mount_options ⇒ Types::SmbMountOptions

  Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

• #password ⇒ String

  Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

• #server_hostname ⇒ String

  Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

• #subdirectory ⇒ String

  Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

• #tags ⇒ Array<Types::TagListEntry>

  Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.

• #user ⇒ String

  Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Instance Attribute Details

#agent_arns ⇒ Array<String>

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

Returns:

• (Array<String>)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#authentication_type ⇒ String

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports ‘NTLM` (default) and `KERBEROS` authentication.

For more information, see [Providing DataSync access to SMB file servers].

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#cmk_secret_config ⇒ Types::CmkSecretConfig

Specifies configuration information for a DataSync-managed secret, either a ‘Password` or `KerberosKeytab` (for `NTLM` (default) and `KERBEROS` authentication types, respectively) that DataSync uses to access a specific SMB storage location, with a customer-managed KMS key.

When you include this parameter as part of a ‘CreateLocationSmbRequest` request, you provide only the KMS key ARN. DataSync uses this KMS key together with either the `Password` or `KerberosKeytab` you specify to create a DataSync-managed secret to store the location access credentials.

Make sure that DataSync has permission to access the KMS key that you specify.

<note markdown=“1”> You can use either ‘CmkSecretConfig` (with either `Password` or `KerberosKeytab`) or `CustomSecretConfig` (without any `Password` and `KerberosKeytab`) to provide credentials for a `CreateLocationSmbRequest` request. Do not provide both `CmkSecretConfig` and `CustomSecretConfig` parameters for the same request.

</note>

Returns:

• (Types::CmkSecretConfig)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#custom_secret_config ⇒ Types::CustomSecretConfig

Specifies configuration information for a customer-managed Secrets Manager secret where the SMB storage location credentials is stored in Secrets Manager as plain text (for ‘Password`) or binary (for `KerberosKeytab`). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

<note markdown=“1”> You can use either ‘CmkSecretConfig` (with `SasConfiguration`) or `CustomSecretConfig` (without `SasConfiguration`) to provide credentials for a `CreateLocationSmbRequest` request. Do not provide both parameters for the same request.

</note>

Returns:

• (Types::CustomSecretConfig)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#dns_ip_addresses ⇒ Array<String>

Specifies the IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if ‘AuthenticationType` is set to `KERBEROS`.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#domain ⇒ String

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if ‘AuthenticationType` is set to `NTLM`.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_keytab ⇒ String

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for ‘KerberosPrincipal`.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_krb_5_conf ⇒ String

Specifies a Kerberos configuration file (‘krb5.conf`) that defines your Kerberos realm configuration.

The file must be base64 encoded. If you’re using the CLI, the encoding is done for you.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#kerberos_principal ⇒ String

Specifies a Kerberos principal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

A Kerberos principal might look like ‘HOST/kerberosuser@MYDOMAIN.ORG`.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#mount_options ⇒ Types::SmbMountOptions

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Returns:

• (Types::SmbMountOptions)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#password ⇒ String

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if ‘AuthenticationType` is set to `NTLM`.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#server_hostname ⇒ String

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

<note markdown=“1”> If you’re using Kerberos authentication, you must specify a domain name.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#subdirectory ⇒ String

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, ‘/path/to/subdirectory`). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see [Providing DataSync access to SMB file servers].

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tags ⇒ Array<Types::TagListEntry>

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

Returns:

• (Array<Types::TagListEntry>)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user ⇒ String

Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if ‘AuthenticationType` is set to `NTLM`.

For information about choosing a user with the right level of access for your transfer, see [Providing DataSync access to SMB file servers].

[1]: docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 1391

class CreateLocationSmbRequest < Struct.new(
  :subdirectory,
  :server_hostname,
  :user,
  :domain,
  :password,
  :cmk_secret_config,
  :custom_secret_config,
  :agent_arns,
  :mount_options,
  :tags,
  :authentication_type,
  :dns_ip_addresses,
  :kerberos_principal,
  :kerberos_keytab,
  :kerberos_krb_5_conf)
  SENSITIVE = [:password]
  include Aws::Structure
end