Class FsxProtocolSmb

java.lang.Object
software.amazon.awssdk.services.datasync.model.FsxProtocolSmb
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>
@Generated("software.amazon.awssdk:codegen") public final class FsxProtocolSmb extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see Providing DataSync access to FSx for ONTAP file systems.

See Also:

  • Method Details

    • domain

      public final 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.

      Returns:
      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.

    • mountOptions

      public final SmbMountOptions mountOptions()
      Returns the value of the MountOptions property for this object.
      Returns:
      The value of the MountOptions property for this object.

    • password

      public final String password()

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

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

    • user

      public final 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.

      Returns:
      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.

    • managedSecretConfig

      public final 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.

      Returns:
      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.

    • cmkSecretConfig

      public final 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.

      Returns:
      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.

    • customSecretConfig

      public final 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.

      Returns:
      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.

    • toBuilder

      public FsxProtocolSmb.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FsxProtocolSmb.Builder,FsxProtocolSmb>
      Returns:
      a builder for type T

    • builder

      public static FsxProtocolSmb.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FsxProtocolSmb.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.