Class: Aws::DataSync::Types::DescribeLocationSmbResponse

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::DescribeLocationSmbResponse

Defined in:

gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

DescribeLocationSmbResponse

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #agent_arns ⇒ Array<String>

  The ARNs of the DataSync agents that can connect with your SMB file server.

• #authentication_type ⇒ String

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

• #cmk_secret_config ⇒ Types::CmkSecretConfig

  Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed KMS key.

• #creation_time ⇒ Time

  The time that the SMB location was created.

• #custom_secret_config ⇒ Types::CustomSecretConfig

  Describes configuration information for a customer-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

• #dns_ip_addresses ⇒ Array<String>

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

• #domain ⇒ String

  The name of the Windows domain that the SMB file server belongs to.

• #kerberos_principal ⇒ String

  The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.

• #location_arn ⇒ String

  The ARN of the SMB location.

• #location_uri ⇒ String

  The URI of the SMB location.

• #managed_secret_config ⇒ Types::ManagedSecretConfig

  Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location.

• #mount_options ⇒ Types::SmbMountOptions

  The SMB protocol version that DataSync uses to access your SMB file server.

• #user ⇒ String

  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>

The ARNs of the DataSync agents that can connect with your SMB file server.

Returns:

• (Array<String>)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ String

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

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#cmk_secret_config ⇒ Types::CmkSecretConfig

Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed KMS key.

Returns:

• (Types::CmkSecretConfig)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that the SMB location was created.

Returns:

• (Time)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#custom_secret_config ⇒ Types::CustomSecretConfig

Describes configuration information for a customer-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Returns:

• (Types::CustomSecretConfig)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#dns_ip_addresses ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#kerberos_principal ⇒ String

The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#location_arn ⇒ String

The ARN of the SMB location.

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#location_uri ⇒ String

The URI of the SMB location.

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#managed_secret_config ⇒ Types::ManagedSecretConfig

Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

Returns:

• (Types::ManagedSecretConfig)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#mount_options ⇒ Types::SmbMountOptions

The SMB protocol version that DataSync uses to access your SMB file server.

Returns:

• (Types::SmbMountOptions)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end

#user ⇒ String

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

Returns:

• (String)

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

class DescribeLocationSmbResponse < Struct.new(
  :location_arn,
  :location_uri,
  :agent_arns,
  :user,
  :domain,
  :mount_options,
  :creation_time,
  :dns_ip_addresses,
  :kerberos_principal,
  :authentication_type,
  :managed_secret_config,
  :cmk_secret_config,
  :custom_secret_config)
  SENSITIVE = []
  include Aws::Structure
end