Package software.amazon.awscdk.services.datasync

Interface CfnLocationSMBProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnLocationSMBProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:37.866Z") @Stability(Stable) public interface CfnLocationSMBProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnLocationSMB.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnLocationSMBProps cfnLocationSMBProps = CfnLocationSMBProps.builder()
         .agentArns(List.of("agentArns"))
         // the properties below are optional
         .authenticationType("authenticationType")
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .dnsIpAddresses(List.of("dnsIpAddresses"))
         .domain("domain")
         .kerberosKeytab("kerberosKeytab")
         .kerberosKrb5Conf("kerberosKrb5Conf")
         .kerberosPrincipal("kerberosPrincipal")
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .password("password")
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .user("user")
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnLocationSMBProps.Builder
    A builder for CfnLocationSMBProps
    static final class 
    CfnLocationSMBProps.Jsii$Proxy
    An implementation for CfnLocationSMBProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnLocationSMBProps.Builder
    builder()
     
    List<String>
    getAgentArns()
    Specifies the DataSync agent (or agents) that can connect to your SMB file server.
    default String
    getAuthenticationType()
    The authentication mode used to determine identity of user.
    default Object
    getCmkSecretConfig()
    Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
    default Object
    getCustomSecretConfig()
    Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
    default List<String>
    getDnsIpAddresses()
    Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
    default String
    getDomain()
    Specifies the Windows domain name that your SMB file server belongs to.
    default String
    getKerberosKeytab()
    The Base64 string representation of the Keytab file.
    default String
    getKerberosKrb5Conf()
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
    default String
    getKerberosPrincipal()
    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.
    default Object
    getMountOptions()
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    default String
    getPassword()
    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.
    default String
    getServerHostname()
    Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.
    default String
    getSubdirectory()
    Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
    default List<CfnTag>
    getTags()
    Specifies labels that help you categorize, filter, and search for your AWS resources.
    default String
    getUser()
    Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson