1. Packages
  2. AWS Native
  3. API Docs
  4. datasync
  5. LocationSmb

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.datasync.LocationSmb

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource schema for AWS::DataSync::LocationSMB.

    Create LocationSmb Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LocationSmb(name: string, args: LocationSmbArgs, opts?: CustomResourceOptions);
    @overload
    def LocationSmb(resource_name: str,
                    args: LocationSmbArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def LocationSmb(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    agent_arns: Optional[Sequence[str]] = None,
                    user: Optional[str] = None,
                    domain: Optional[str] = None,
                    mount_options: Optional[LocationSmbMountOptionsArgs] = None,
                    password: Optional[str] = None,
                    server_hostname: Optional[str] = None,
                    subdirectory: Optional[str] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewLocationSmb(ctx *Context, name string, args LocationSmbArgs, opts ...ResourceOption) (*LocationSmb, error)
    public LocationSmb(string name, LocationSmbArgs args, CustomResourceOptions? opts = null)
    public LocationSmb(String name, LocationSmbArgs args)
    public LocationSmb(String name, LocationSmbArgs args, CustomResourceOptions options)
    
    type: aws-native:datasync:LocationSmb
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const locationSmbResource = new aws_native.datasync.LocationSmb("locationSmbResource", {
        agentArns: ["string"],
        user: "string",
        domain: "string",
        mountOptions: {
            version: aws_native.datasync.LocationSmbMountOptionsVersion.Automatic,
        },
        password: "string",
        serverHostname: "string",
        subdirectory: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    LocationSmb Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The LocationSmb resource accepts the following input properties:

    AgentArns List<string>
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    User string
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    Domain string
    The name of the Windows domain that the SMB server belongs to.
    MountOptions Pulumi.AwsNative.DataSync.Inputs.LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    Password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    ServerHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    Subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    AgentArns []string
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    User string
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    Domain string
    The name of the Windows domain that the SMB server belongs to.
    MountOptions LocationSmbMountOptionsArgs
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    Password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    ServerHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    Subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    agentArns List<String>
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    user String
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    domain String
    The name of the Windows domain that the SMB server belongs to.
    mountOptions LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password String
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname String
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory String
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    agentArns string[]
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    user string
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    domain string
    The name of the Windows domain that the SMB server belongs to.
    mountOptions LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    agent_arns Sequence[str]
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    user str
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    domain str
    The name of the Windows domain that the SMB server belongs to.
    mount_options LocationSmbMountOptionsArgs
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password str
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    server_hostname str
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory str
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    agentArns List<String>
    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
    user String
    The user who can mount the share, has the permissions to access files and folders in the SMB share.
    domain String
    The name of the Windows domain that the SMB server belongs to.
    mountOptions Property Map
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password String
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname String
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory String
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocationSmb resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LocationArn string
    The Amazon Resource Name (ARN) of the SMB location that is created.
    LocationUri string
    The URL of the SMB location that was described.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocationArn string
    The Amazon Resource Name (ARN) of the SMB location that is created.
    LocationUri string
    The URL of the SMB location that was described.
    id String
    The provider-assigned unique ID for this managed resource.
    locationArn String
    The Amazon Resource Name (ARN) of the SMB location that is created.
    locationUri String
    The URL of the SMB location that was described.
    id string
    The provider-assigned unique ID for this managed resource.
    locationArn string
    The Amazon Resource Name (ARN) of the SMB location that is created.
    locationUri string
    The URL of the SMB location that was described.
    id str
    The provider-assigned unique ID for this managed resource.
    location_arn str
    The Amazon Resource Name (ARN) of the SMB location that is created.
    location_uri str
    The URL of the SMB location that was described.
    id String
    The provider-assigned unique ID for this managed resource.
    locationArn String
    The Amazon Resource Name (ARN) of the SMB location that is created.
    locationUri String
    The URL of the SMB location that was described.

    Supporting Types

    LocationSmbMountOptions, LocationSmbMountOptionsArgs

    Version Pulumi.AwsNative.DataSync.LocationSmbMountOptionsVersion
    The specific SMB version that you want DataSync to use to mount your SMB share.
    Version LocationSmbMountOptionsVersion
    The specific SMB version that you want DataSync to use to mount your SMB share.
    version LocationSmbMountOptionsVersion
    The specific SMB version that you want DataSync to use to mount your SMB share.
    version LocationSmbMountOptionsVersion
    The specific SMB version that you want DataSync to use to mount your SMB share.
    version LocationSmbMountOptionsVersion
    The specific SMB version that you want DataSync to use to mount your SMB share.
    version "AUTOMATIC" | "SMB1" | "SMB2_0" | "SMB2" | "SMB3"
    The specific SMB version that you want DataSync to use to mount your SMB share.

    LocationSmbMountOptionsVersion, LocationSmbMountOptionsVersionArgs

    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    LocationSmbMountOptionsVersionAutomatic
    AUTOMATIC
    LocationSmbMountOptionsVersionSmb1
    SMB1
    LocationSmbMountOptionsVersionSmb20
    SMB2_0
    LocationSmbMountOptionsVersionSmb2
    SMB2
    LocationSmbMountOptionsVersionSmb3
    SMB3
    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    AUTOMATIC
    AUTOMATIC
    SMB1
    SMB1
    SMB20
    SMB2_0
    SMB2
    SMB2
    SMB3
    SMB3
    "AUTOMATIC"
    AUTOMATIC
    "SMB1"
    SMB1
    "SMB2_0"
    SMB2_0
    "SMB2"
    SMB2
    "SMB3"
    SMB3

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi