aws_datasync_location_smb

account_id

Type: STRING

agent_arns

Type: UNORDERED_LIST_STRING
Provider name: AgentArns
Description: The ARNs of the DataSync agents that can connect with your SMB file server.

authentication_type

Type: STRING
Provider name: AuthenticationType
Description: The authentication protocol that DataSync uses to connect to your SMB file server.

cmk_secret_config

Type: STRUCT
Provider name: CmkSecretConfig
Description: 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.

• kms_key_arn
  Type: STRING
  Provider name: KmsKeyArn
  Description: Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.
  
• secret_arn
  Type: STRING
  Provider name: SecretArn
  Description: Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.
  

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The time that the SMB location was created.

custom_secret_config

Type: STRUCT
Provider name: CustomSecretConfig
Description: 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.

• secret_access_role_arn
  Type: STRING
  Provider name: SecretAccessRoleArn
  Description: Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
  
• secret_arn
  Type: STRING
  Provider name: SecretArn
  Description: Specifies the ARN for an Secrets Manager secret.
  

dns_ip_addresses

Type: UNORDERED_LIST_STRING
Provider name: DnsIpAddresses
Description: 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.

domain

Type: STRING
Provider name: Domain
Description: The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.

kerberos_principal

Type: STRING
Provider name: KerberosPrincipal
Description: The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.

location_arn

Type: STRING
Provider name: LocationArn
Description: The ARN of the SMB location.

location_uri

Type: STRING
Provider name: LocationUri
Description: The URI of the SMB location.

managed_secret_config

Type: STRUCT
Provider name: ManagedSecretConfig
Description: 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.

• secret_arn
  Type: STRING
  Provider name: SecretArn
  Description: Specifies the ARN for an Secrets Manager secret.
  

mount_options

Type: STRUCT
Provider name: MountOptions
Description: The SMB protocol version that DataSync uses to access your SMB file server.

• version
  Type: STRING
  Provider name: Version
  Description: By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version:
  • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.
  • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.
  • SMB2: Restricts the protocol negotiation to only SMB version 2.1.
  • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.
  • SMB1: Restricts the protocol negotiation to only SMB version 1.0. The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location.

tags

Type: UNORDERED_LIST_STRING

user

Type: STRING
Provider name: User
Description: 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.