Skip to content

DescribeLocationSmbResponse

Source code in docs_src/capo_datasync/types/describe_location_smb_response.py
class DescribeLocationSmbResponse(TypedDict, closed=True):
    location_arn: NotRequired["capo_datasync.types.location_arn.LocationArn"]
    """<p>The ARN of the SMB location.</p>"""
    location_uri: NotRequired["capo_datasync.types.location_uri.LocationUri"]
    """<p>The URI of the SMB location.</p>"""
    agent_arns: NotRequired["capo_datasync.types.agent_arn_list.AgentArnList"]
    """<p>The ARNs of the DataSync agents that can connect with your SMB file server.</p>"""
    user: NotRequired["capo_datasync.types.smb_user.SmbUser"]
    """<p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>"""
    domain: NotRequired["capo_datasync.types.smb_domain.SmbDomain"]
    """<p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>"""
    mount_options: NotRequired["capo_datasync.types.smb_mount_options.SmbMountOptions"]
    """<p>The SMB protocol version that DataSync uses to access your SMB file server.</p>"""
    creation_time: NotRequired["capo_datasync.types.time.Time"]
    """<p>The time that the SMB location was created.</p>"""
    dns_ip_addresses: NotRequired["capo_datasync.types.dns_ip_list.DnsIpList"]
    """<p>The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>"""
    kerberos_principal: NotRequired[
        "capo_datasync.types.kerberos_principal.KerberosPrincipal"
    ]
    """<p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>"""
    authentication_type: NotRequired[
        "capo_datasync.types.smb_authentication_type.SmbAuthenticationType"
    ]
    """<p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>"""
    managed_secret_config: NotRequired[
        "capo_datasync.types.managed_secret_config.ManagedSecretConfig"
    ]
    """<p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> 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.</p>"""
    cmk_secret_config: NotRequired[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ]
    """<p>Describes configuration information for a DataSync-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> that DataSync uses to access a specific storage location, with a customer-managed KMS key.</p>"""
    custom_secret_config: NotRequired[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ]
    """<p>Describes configuration information for a customer-managed secret, such as a <code>Password</code> or <code>KerberosKeytab</code> 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.</p>"""

agent_arns instance-attribute

agent_arns: NotRequired[AgentArnList]

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

authentication_type instance-attribute

authentication_type: NotRequired[SmbAuthenticationType]

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

cmk_secret_config instance-attribute

cmk_secret_config: NotRequired[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 instance-attribute

creation_time: NotRequired[Time]

The time that the SMB location was created.

custom_secret_config instance-attribute

custom_secret_config: NotRequired[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 instance-attribute

dns_ip_addresses: NotRequired[DnsIpList]

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 instance-attribute

domain: NotRequired[SmbDomain]

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 instance-attribute

kerberos_principal: NotRequired[KerberosPrincipal]

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

location_arn instance-attribute

location_arn: NotRequired[LocationArn]

The ARN of the SMB location.

location_uri instance-attribute

location_uri: NotRequired[LocationUri]

The URI of the SMB location.

managed_secret_config instance-attribute

managed_secret_config: NotRequired[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.

mount_options instance-attribute

mount_options: NotRequired[SmbMountOptions]

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

user instance-attribute

user: NotRequired[SmbUser]

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.