CfnLocationSMBProps

class aws_cdk.aws_datasync.CfnLocationSMBProps(*, agent_arns, authentication_type=None, dns_ip_addresses=None, domain=None, kerberos_keytab=None, kerberos_krb5_conf=None, kerberos_principal=None, mount_options=None, password=None, server_hostname=None, subdirectory=None, tags=None, user=None)

Bases: object

Properties for defining a CfnLocationSMB.

Parameters:

agent_arns (Sequence[str]) – 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).
authentication_type (Optional[str]) – The authentication mode used to determine identity of user.
dns_ip_addresses (Optional[Sequence[str]]) – Specifies the IPv4 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.
domain (Optional[str]) – 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.
kerberos_keytab (Optional[str]) – The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
kerberos_krb5_conf (Optional[str]) – The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
kerberos_principal (Optional[str]) – Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn’t match exactly what’s in your keytab or krb5.conf files.
mount_options (Union[IResolvable, MountOptionsProperty, Dict[str, Any], None]) – Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
password (Optional[str]) – 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 .
server_hostname (Optional[str]) – Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to. .. epigraph:: If you’re using Kerberos authentication, you must specify a domain name.
subdirectory (Optional[str]) – 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 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
user (Optional[str]) –
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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_sMBProps = datasync.CfnLocationSMBProps(
    agent_arns=["agentArns"],

    # the properties below are optional
    authentication_type="authenticationType",
    dns_ip_addresses=["dnsIpAddresses"],
    domain="domain",
    kerberos_keytab="kerberosKeytab",
    kerberos_krb5_conf="kerberosKrb5Conf",
    kerberos_principal="kerberosPrincipal",
    mount_options=datasync.CfnLocationSMB.MountOptionsProperty(
        version="version"
    ),
    password="password",
    server_hostname="serverHostname",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user="user"
)

Attributes

agent_arns

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).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-agentarns

authentication_type

The authentication mode used to determine identity of user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-authenticationtype

dns_ip_addresses

Specifies the IPv4 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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-dnsipaddresses

domain

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-domain

kerberos_keytab

The Base64 string representation of the Keytab file.

Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskeytab

kerberos_krb5_conf

The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskrb5conf

kerberos_principal

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

SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn’t match exactly what’s in your keytab or krb5.conf files.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberosprincipal

mount_options

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-mountoptions

password

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-password

server_hostname

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

If you’re using Kerberos authentication, you must specify a domain name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-serverhostname

subdirectory

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-subdirectory

tags

Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least a name tag for your location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-tags

user

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-user