Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Class CfnLocationSMBPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnLocationSMBPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationSMBPropsMixin>

Enclosing class:

CfnLocationSMBPropsMixin

@Stability(Stable)
public static final class CfnLocationSMBPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationSMBPropsMixin>

A fluent builder for CfnLocationSMBPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnLocationSMBPropsMixin.Builder	agentArns(List<String> agentArns)	Specifies the DataSync agent (or agents) that can connect to your SMB file server.
CfnLocationSMBPropsMixin.Builder	authenticationType(String authenticationType)	The authentication mode used to determine identity of user.
CfnLocationSMBPropsMixin	build()
CfnLocationSMBPropsMixin.Builder	cmkSecretConfig(CfnLocationSMBPropsMixin.CmkSecretConfigProperty cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
CfnLocationSMBPropsMixin.Builder	cmkSecretConfig(IResolvable cmkSecretConfig)	Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
static CfnLocationSMBPropsMixin.Builder	create()
static CfnLocationSMBPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnLocationSMBPropsMixin.Builder	customSecretConfig(CfnLocationSMBPropsMixin.CustomSecretConfigProperty customSecretConfig)	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
CfnLocationSMBPropsMixin.Builder	customSecretConfig(IResolvable customSecretConfig)	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
CfnLocationSMBPropsMixin.Builder	dnsIpAddresses(List<String> dnsIpAddresses)	Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
CfnLocationSMBPropsMixin.Builder	domain(String domain)	Specifies the Windows domain name that your SMB file server belongs to.
CfnLocationSMBPropsMixin.Builder	kerberosKeytab(String kerberosKeytab)	The Base64 string representation of the Keytab file.
CfnLocationSMBPropsMixin.Builder	kerberosKrb5Conf(String kerberosKrb5Conf)	The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
CfnLocationSMBPropsMixin.Builder	kerberosPrincipal(String kerberosPrincipal)	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.
CfnLocationSMBPropsMixin.Builder	mountOptions(CfnLocationSMBPropsMixin.MountOptionsProperty mountOptions)	Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
CfnLocationSMBPropsMixin.Builder	mountOptions(IResolvable mountOptions)	Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
CfnLocationSMBPropsMixin.Builder	password(String 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.
CfnLocationSMBPropsMixin.Builder	serverHostname(String serverHostname)	Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.
CfnLocationSMBPropsMixin.Builder	subdirectory(String subdirectory)	Specifies the name of the share exported by your SMB file server where DataSync will read or write data.
CfnLocationSMBPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.
CfnLocationSMBPropsMixin.Builder	user(String user)	Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLocationSMBPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnLocationSMBPropsMixin.Builder.

create

@Stability(Stable)
public static CfnLocationSMBPropsMixin.Builder create()

Returns:

a new instance of CfnLocationSMBPropsMixin.Builder.

agentArns

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder agentArns(List<String> agentArns)

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

Parameters:

agentArns - Specifies the DataSync agent (or agents) that can connect to your SMB file server. This parameter is required.

Returns:

this

See Also:

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

authenticationType

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder authenticationType(String authenticationType)

The authentication mode used to determine identity of user.

Parameters:

authenticationType - The authentication mode used to determine identity of user. This parameter is required.

Returns:

this

See Also:

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

cmkSecretConfig

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder cmkSecretConfig(IResolvable cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . This parameter is required.

Returns:

this

See Also:

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

cmkSecretConfig

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder cmkSecretConfig(CfnLocationSMBPropsMixin.CmkSecretConfigProperty cmkSecretConfig)

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . This parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder customSecretConfig(IResolvable customSecretConfig)

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This parameter is required.

Returns:

this

See Also:

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

customSecretConfig

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder customSecretConfig(CfnLocationSMBPropsMixin.CustomSecretConfigProperty customSecretConfig)

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).

This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

You can use either CmkSecretConfig or CustomSecretConfig to provide credentials for a CreateLocation request. Do not provide both parameters for the same request.

Parameters:

customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This parameter is required.

Returns:

this

See Also:

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

dnsIpAddresses

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder dnsIpAddresses(List<String> dnsIpAddresses)

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.

Parameters:

dnsIpAddresses - Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter is required.

Returns:

this

See Also:

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

domain

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder domain(String 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.

Parameters:

domain - Specifies the Windows domain name that your SMB file server belongs to. This parameter is required.

Returns:

this

See Also:

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

kerberosKeytab

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder kerberosKeytab(String kerberosKeytab)

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.

Parameters:

kerberosKeytab - The Base64 string representation of the Keytab file. This parameter is required.

Returns:

this

See Also:

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

kerberosKrb5Conf

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder kerberosKrb5Conf(String kerberosKrb5Conf)

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.

Parameters:

kerberosKrb5Conf - 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. This parameter is required.

Returns:

this

See Also:

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

kerberosPrincipal

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder kerberosPrincipal(String kerberosPrincipal)

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.

Parameters:

kerberosPrincipal - 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. This parameter is required.

Returns:

this

See Also:

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

mountOptions

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder mountOptions(IResolvable mountOptions)

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

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. This parameter is required.

Returns:

this

See Also:

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

mountOptions

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder mountOptions(CfnLocationSMBPropsMixin.MountOptionsProperty mountOptions)

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

Parameters:

mountOptions - Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. This parameter is required.

Returns:

this

See Also:

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

password

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder password(String 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 .

Parameters:

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 is required.

Returns:

this

See Also:

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

serverHostname

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder serverHostname(String serverHostname)

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.

Parameters:

serverHostname - Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to. This parameter is required.

Returns:

this

See Also:

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

subdirectory

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder subdirectory(String 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 .

Parameters:

subdirectory - Specifies the name of the share exported by your SMB file server where DataSync will read or write data. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. This parameter is required.

Returns:

this

See Also:

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

user

@Stability(Stable)
public CfnLocationSMBPropsMixin.Builder user(String 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 .

Parameters:

user - Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLocationSMBPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationSMBPropsMixin>

Returns:

a newly built instance of CfnLocationSMBPropsMixin.