aws.datasync.LocationFsxWindows
Explore with Pulumi AI
Manages an AWS DataSync FSx Windows Location.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.datasync.LocationFsxWindows("example", {
fsxFilesystemArn: exampleAwsFsxWindowsFileSystem.arn,
user: "SomeUser",
password: "SuperSecretPassw0rd",
securityGroupArns: [exampleAwsSecurityGroup.arn],
});
import pulumi
import pulumi_aws as aws
example = aws.datasync.LocationFsxWindows("example",
fsx_filesystem_arn=example_aws_fsx_windows_file_system["arn"],
user="SomeUser",
password="SuperSecretPassw0rd",
security_group_arns=[example_aws_security_group["arn"]])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datasync.NewLocationFsxWindows(ctx, "example", &datasync.LocationFsxWindowsArgs{
FsxFilesystemArn: pulumi.Any(exampleAwsFsxWindowsFileSystem.Arn),
User: pulumi.String("SomeUser"),
Password: pulumi.String("SuperSecretPassw0rd"),
SecurityGroupArns: pulumi.StringArray{
exampleAwsSecurityGroup.Arn,
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DataSync.LocationFsxWindows("example", new()
{
FsxFilesystemArn = exampleAwsFsxWindowsFileSystem.Arn,
User = "SomeUser",
Password = "SuperSecretPassw0rd",
SecurityGroupArns = new[]
{
exampleAwsSecurityGroup.Arn,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.LocationFsxWindows;
import com.pulumi.aws.datasync.LocationFsxWindowsArgs;
import java.util.List;
import java.util.ArrayList;
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 LocationFsxWindows("example", LocationFsxWindowsArgs.builder()
.fsxFilesystemArn(exampleAwsFsxWindowsFileSystem.arn())
.user("SomeUser")
.password("SuperSecretPassw0rd")
.securityGroupArns(exampleAwsSecurityGroup.arn())
.build());
}
}
resources:
example:
type: aws:datasync:LocationFsxWindows
properties:
fsxFilesystemArn: ${exampleAwsFsxWindowsFileSystem.arn}
user: SomeUser
password: SuperSecretPassw0rd
securityGroupArns:
- ${exampleAwsSecurityGroup.arn}
Create LocationFsxWindows Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LocationFsxWindows(name: string, args: LocationFsxWindowsArgs, opts?: CustomResourceOptions);
@overload
def LocationFsxWindows(resource_name: str,
args: LocationFsxWindowsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LocationFsxWindows(resource_name: str,
opts: Optional[ResourceOptions] = None,
fsx_filesystem_arn: Optional[str] = None,
password: Optional[str] = None,
security_group_arns: Optional[Sequence[str]] = None,
user: Optional[str] = None,
domain: Optional[str] = None,
subdirectory: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewLocationFsxWindows(ctx *Context, name string, args LocationFsxWindowsArgs, opts ...ResourceOption) (*LocationFsxWindows, error)
public LocationFsxWindows(string name, LocationFsxWindowsArgs args, CustomResourceOptions? opts = null)
public LocationFsxWindows(String name, LocationFsxWindowsArgs args)
public LocationFsxWindows(String name, LocationFsxWindowsArgs args, CustomResourceOptions options)
type: aws:datasync:LocationFsxWindows
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 LocationFsxWindowsArgs
- 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 LocationFsxWindowsArgs
- 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 LocationFsxWindowsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LocationFsxWindowsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LocationFsxWindowsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var locationFsxWindowsResource = new Aws.DataSync.LocationFsxWindows("locationFsxWindowsResource", new()
{
FsxFilesystemArn = "string",
Password = "string",
SecurityGroupArns = new[]
{
"string",
},
User = "string",
Domain = "string",
Subdirectory = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := datasync.NewLocationFsxWindows(ctx, "locationFsxWindowsResource", &datasync.LocationFsxWindowsArgs{
FsxFilesystemArn: pulumi.String("string"),
Password: pulumi.String("string"),
SecurityGroupArns: pulumi.StringArray{
pulumi.String("string"),
},
User: pulumi.String("string"),
Domain: pulumi.String("string"),
Subdirectory: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var locationFsxWindowsResource = new LocationFsxWindows("locationFsxWindowsResource", LocationFsxWindowsArgs.builder()
.fsxFilesystemArn("string")
.password("string")
.securityGroupArns("string")
.user("string")
.domain("string")
.subdirectory("string")
.tags(Map.of("string", "string"))
.build());
location_fsx_windows_resource = aws.datasync.LocationFsxWindows("locationFsxWindowsResource",
fsx_filesystem_arn="string",
password="string",
security_group_arns=["string"],
user="string",
domain="string",
subdirectory="string",
tags={
"string": "string",
})
const locationFsxWindowsResource = new aws.datasync.LocationFsxWindows("locationFsxWindowsResource", {
fsxFilesystemArn: "string",
password: "string",
securityGroupArns: ["string"],
user: "string",
domain: "string",
subdirectory: "string",
tags: {
string: "string",
},
});
type: aws:datasync:LocationFsxWindows
properties:
domain: string
fsxFilesystemArn: string
password: string
securityGroupArns:
- string
subdirectory: string
tags:
string: string
user: string
LocationFsxWindows Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The LocationFsxWindows resource accepts the following input properties:
- Fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- Password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- Security
Group List<string>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- User string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- Domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- Subdirectory string
- Subdirectory to perform actions as source or destination.
- Dictionary<string, string>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- Password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- Security
Group []stringArns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- User string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- Domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- Subdirectory string
- Subdirectory to perform actions as source or destination.
- map[string]string
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- fsx
Filesystem StringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password String
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group List<String>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- user String
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- domain String
- The name of the Windows domain that the FSx for Windows server belongs to.
- subdirectory String
- Subdirectory to perform actions as source or destination.
- Map<String,String>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group string[]Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- user string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- subdirectory string
- Subdirectory to perform actions as source or destination.
- {[key: string]: string}
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- fsx_
filesystem_ strarn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password str
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security_
group_ Sequence[str]arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- user str
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- domain str
- The name of the Windows domain that the FSx for Windows server belongs to.
- subdirectory str
- Subdirectory to perform actions as source or destination.
- Mapping[str, str]
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- fsx
Filesystem StringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password String
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group List<String>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- user String
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- domain String
- The name of the Windows domain that the FSx for Windows server belongs to.
- subdirectory String
- Subdirectory to perform actions as source or destination.
- Map<String>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the LocationFsxWindows resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- Creation
Time string - The time that the FSx for Windows location was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Uri string
- The URL of the FSx for Windows location that was described.
- Arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- Creation
Time string - The time that the FSx for Windows location was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Uri string
- The URL of the FSx for Windows location that was described.
- arn String
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time String - The time that the FSx for Windows location was created.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri String
- The URL of the FSx for Windows location that was described.
- arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time string - The time that the FSx for Windows location was created.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri string
- The URL of the FSx for Windows location that was described.
- arn str
- Amazon Resource Name (ARN) of the DataSync Location.
- creation_
time str - The time that the FSx for Windows location was created.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri str
- The URL of the FSx for Windows location that was described.
- arn String
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time String - The time that the FSx for Windows location was created.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri String
- The URL of the FSx for Windows location that was described.
Look up Existing LocationFsxWindows Resource
Get an existing LocationFsxWindows resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LocationFsxWindowsState, opts?: CustomResourceOptions): LocationFsxWindows
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
creation_time: Optional[str] = None,
domain: Optional[str] = None,
fsx_filesystem_arn: Optional[str] = None,
password: Optional[str] = None,
security_group_arns: Optional[Sequence[str]] = None,
subdirectory: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
uri: Optional[str] = None,
user: Optional[str] = None) -> LocationFsxWindows
func GetLocationFsxWindows(ctx *Context, name string, id IDInput, state *LocationFsxWindowsState, opts ...ResourceOption) (*LocationFsxWindows, error)
public static LocationFsxWindows Get(string name, Input<string> id, LocationFsxWindowsState? state, CustomResourceOptions? opts = null)
public static LocationFsxWindows get(String name, Output<String> id, LocationFsxWindowsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- Creation
Time string - The time that the FSx for Windows location was created.
- Domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- Fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- Password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- Security
Group List<string>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- Subdirectory string
- Subdirectory to perform actions as source or destination.
- Dictionary<string, string>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Uri string
- The URL of the FSx for Windows location that was described.
- User string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- Arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- Creation
Time string - The time that the FSx for Windows location was created.
- Domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- Fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- Password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- Security
Group []stringArns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- Subdirectory string
- Subdirectory to perform actions as source or destination.
- map[string]string
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Uri string
- The URL of the FSx for Windows location that was described.
- User string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- arn String
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time String - The time that the FSx for Windows location was created.
- domain String
- The name of the Windows domain that the FSx for Windows server belongs to.
- fsx
Filesystem StringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password String
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group List<String>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- subdirectory String
- Subdirectory to perform actions as source or destination.
- Map<String,String>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri String
- The URL of the FSx for Windows location that was described.
- user String
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- arn string
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time string - The time that the FSx for Windows location was created.
- domain string
- The name of the Windows domain that the FSx for Windows server belongs to.
- fsx
Filesystem stringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password string
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group string[]Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- subdirectory string
- Subdirectory to perform actions as source or destination.
- {[key: string]: string}
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri string
- The URL of the FSx for Windows location that was described.
- user string
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- arn str
- Amazon Resource Name (ARN) of the DataSync Location.
- creation_
time str - The time that the FSx for Windows location was created.
- domain str
- The name of the Windows domain that the FSx for Windows server belongs to.
- fsx_
filesystem_ strarn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password str
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security_
group_ Sequence[str]arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- subdirectory str
- Subdirectory to perform actions as source or destination.
- Mapping[str, str]
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri str
- The URL of the FSx for Windows location that was described.
- user str
- The user who has the permissions to access files and folders in the FSx for Windows file system.
- arn String
- Amazon Resource Name (ARN) of the DataSync Location.
- creation
Time String - The time that the FSx for Windows location was created.
- domain String
- The name of the Windows domain that the FSx for Windows server belongs to.
- fsx
Filesystem StringArn - The Amazon Resource Name (ARN) for the FSx for Windows file system.
- password String
- The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
- security
Group List<String>Arns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.
- subdirectory String
- Subdirectory to perform actions as source or destination.
- Map<String>
- Key-value pairs of resource tags to assign to the DataSync Location. .If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - uri String
- The URL of the FSx for Windows location that was described.
- user String
- The user who has the permissions to access files and folders in the FSx for Windows file system.
Import
Using pulumi import
, import aws_datasync_location_fsx_windows_file_system
using the DataSync-ARN#FSx-Windows-ARN
. For example:
$ pulumi import aws:datasync/locationFsxWindows:LocationFsxWindows example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:476956259333:file-system/fs-08e04cd442c1bb94a
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.