Interface FsxProtocolSmb.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>, SdkBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>, SdkPojo
Enclosing class:
FsxProtocolSmb
@Mutable @NotThreadSafe public static interface FsxProtocolSmb.Builder extends SdkPojo, CopyableBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>

  • Method Details

    • domain

      FsxProtocolSmb.Builder domain(String domain)

      Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

      If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

      If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

      Parameters:
      domain - Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

      If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

      If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mountOptions

      FsxProtocolSmb.Builder mountOptions(SmbMountOptions mountOptions)
      Sets the value of the MountOptions property for this object.
      Parameters:
      mountOptions - The new value for the MountOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mountOptions

      default FsxProtocolSmb.Builder mountOptions(Consumer<SmbMountOptions.Builder> mountOptions)
      Sets the value of the MountOptions property for this object. This is a convenience method that creates an instance of the SmbMountOptions.Builder avoiding the need to create one manually via SmbMountOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mountOptions(SmbMountOptions).

      Parameters:
      mountOptions - a consumer that will call methods on SmbMountOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • password

      FsxProtocolSmb.Builder password(String password)

      Specifies the password of a user who has permission to access your SVM.

      Parameters:
      password - Specifies the password of a user who has permission to access your SVM.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • user

      FsxProtocolSmb.Builder user(String user)

      Specifies a user that can mount and access the files, folders, and metadata in your SVM.

      For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

      Parameters:
      user - Specifies a user that can mount and access the files, folders, and metadata in your SVM.

      For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedSecretConfig

      FsxProtocolSmb.Builder managedSecretConfig(ManagedSecretConfig managedSecretConfig)

      Describes configuration information for a DataSync-managed secret, such as a Password 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.

      Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

      Parameters:
      managedSecretConfig - Describes configuration information for a DataSync-managed secret, such as a Password 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.

      Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • managedSecretConfig

      default FsxProtocolSmb.Builder managedSecretConfig(Consumer<ManagedSecretConfig.Builder> managedSecretConfig)

      Describes configuration information for a DataSync-managed secret, such as a Password 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.

      Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

      This is a convenience method that creates an instance of the ManagedSecretConfig.Builder avoiding the need to create one manually via ManagedSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedSecretConfig(ManagedSecretConfig).

      Parameters:
      managedSecretConfig - a consumer that will call methods on ManagedSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cmkSecretConfig

      FsxProtocolSmb.Builder cmkSecretConfig(CmkSecretConfig cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      Parameters:
      cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cmkSecretConfig

      default FsxProtocolSmb.Builder cmkSecretConfig(Consumer<CmkSecretConfig.Builder> cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CmkSecretConfig.Builder avoiding the need to create one manually via CmkSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cmkSecretConfig(CmkSecretConfig).

      Parameters:
      cmkSecretConfig - a consumer that will call methods on CmkSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customSecretConfig

      FsxProtocolSmb.Builder customSecretConfig(CustomSecretConfig customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      Parameters:
      customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customSecretConfig

      default FsxProtocolSmb.Builder customSecretConfig(Consumer<CustomSecretConfig.Builder> customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CustomSecretConfig.Builder avoiding the need to create one manually via CustomSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customSecretConfig(CustomSecretConfig).

      Parameters:
      customSecretConfig - a consumer that will call methods on CustomSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: