Package com.pulumi.aws.datasync

Class LocationSmb

  • public class LocationSmb
extends com.pulumi.resources.CustomResource
    Manages a SMB Location within AWS DataSync. > **NOTE:** The DataSync Agents must be available before creating this resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.datasync.LocationSmb;
 import com.pulumi.aws.datasync.LocationSmbArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new LocationSmb("example", LocationSmbArgs.builder()
             .serverHostname("smb.example.com")
             .subdirectory("/exported/path")
             .user("Guest")
             .password("ANotGreatPassword")
             .agentArns(exampleAwsDatasyncAgent.arn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the DataSync SMB location. Using `pulumi import`, import `aws.datasync.LocationSmb` using the ARN. For example: ```sh $ pulumi import aws:datasync/locationSmb:LocationSmb example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<java.lang.String>> agentArns()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> domain()  
      static LocationSmb get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, LocationSmbState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<LocationSmbMountOptions>> mountOptions()  
      com.pulumi.core.Output<java.lang.String> password()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> serverHostname()  
      com.pulumi.core.Output<java.lang.String> subdirectory()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> uri()  
      com.pulumi.core.Output<java.lang.String> user()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LocationSmb

        public LocationSmb​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • LocationSmb

        public LocationSmb​(java.lang.String name,
                   LocationSmbArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • LocationSmb

        public LocationSmb​(java.lang.String name,
                   LocationSmbArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • agentArns

        public com.pulumi.core.Output<java.util.List<java.lang.String>> agentArns()
        Returns:
        A list of DataSync Agent ARNs with which this location will be associated.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the DataSync Location.

      • domain

        public com.pulumi.core.Output<java.lang.String> domain()
        Returns:
        The name of the Windows domain the SMB server belongs to.

      • mountOptions

        public com.pulumi.core.Output<java.util.Optional<LocationSmbMountOptions>> mountOptions()
        Returns:
        Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`.

      • password

        public com.pulumi.core.Output<java.lang.String> password()
        Returns:
        The password of the user who can mount the share and has file permissions in the SMB.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • serverHostname

        public com.pulumi.core.Output<java.lang.String> serverHostname()
        Returns:
        Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.

      • subdirectory

        public com.pulumi.core.Output<java.lang.String> subdirectory()
        Returns:
        Subdirectory to perform actions as source or destination. Should be exported by the NFS server.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • uri

        public com.pulumi.core.Output<java.lang.String> uri()

      • user

        public com.pulumi.core.Output<java.lang.String> user()
        Returns:
        The user who can mount the share and has file and folder permissions in the SMB share.

      • get

        public static LocationSmb get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              LocationSmbState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.