Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. storagegateway
  5. FileSystemAssociation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.storagegateway.FileSystemAssociation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

    Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

    FSx File Gateway requirements.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.FileSystemAssociation("example", {
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
    locationArn: exampleAwsFsxWindowsFileSystem.arn,
    username: "Admin",
    password: "avoid-plaintext-passwords",
    auditDestinationArn: exampleAwsS3Bucket.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.storagegateway.FileSystemAssociation("example",
    gateway_arn=example_aws_storagegateway_gateway["arn"],
    location_arn=example_aws_fsx_windows_file_system["arn"],
    username="Admin",
    password="avoid-plaintext-passwords",
    audit_destination_arn=example_aws_s3_bucket["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewFileSystemAssociation(ctx, "example", &storagegateway.FileSystemAssociationArgs{
			GatewayArn:          pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
			LocationArn:         pulumi.Any(exampleAwsFsxWindowsFileSystem.Arn),
			Username:            pulumi.String("Admin"),
			Password:            pulumi.String("avoid-plaintext-passwords"),
			AuditDestinationArn: pulumi.Any(exampleAwsS3Bucket.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.StorageGateway.FileSystemAssociation("example", new()
    {
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
        LocationArn = exampleAwsFsxWindowsFileSystem.Arn,
        Username = "Admin",
        Password = "avoid-plaintext-passwords",
        AuditDestinationArn = exampleAwsS3Bucket.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.FileSystemAssociation;
import com.pulumi.aws.storagegateway.FileSystemAssociationArgs;
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 FileSystemAssociation("example", FileSystemAssociationArgs.builder()        
            .gatewayArn(exampleAwsStoragegatewayGateway.arn())
            .locationArn(exampleAwsFsxWindowsFileSystem.arn())
            .username("Admin")
            .password("avoid-plaintext-passwords")
            .auditDestinationArn(exampleAwsS3Bucket.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:storagegateway:FileSystemAssociation
    properties:
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
      locationArn: ${exampleAwsFsxWindowsFileSystem.arn}
      username: Admin
      password: avoid-plaintext-passwords
      auditDestinationArn: ${exampleAwsS3Bucket.arn}

    Required Services Example

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const awsServiceStoragegatewayAmiFILES3Latest = aws.ssm.getParameter({
    name: "/aws/service/storagegateway/ami/FILE_S3/latest",
});
const test = new aws.ec2.Instance("test", {
    ami: awsServiceStoragegatewayAmiFILES3Latest.then(awsServiceStoragegatewayAmiFILES3Latest => awsServiceStoragegatewayAmiFILES3Latest.value),
    associatePublicIpAddress: true,
    instanceType: aws.ec2.InstanceType[available.instanceType],
    vpcSecurityGroupIds: [testAwsSecurityGroup.id],
    subnetId: testAwsSubnet[0].id,
}, {
    dependsOn: [
        testAwsRoute,
        testAwsVpcDhcpOptionsAssociation,
    ],
});
const testGateway = new aws.storagegateway.Gateway("test", {
    gatewayIpAddress: test.publicIp,
    gatewayName: "test-sgw",
    gatewayTimezone: "GMT",
    gatewayType: "FILE_FSX_SMB",
    smbActiveDirectorySettings: {
        domainName: testAwsDirectoryServiceDirectory.name,
        password: testAwsDirectoryServiceDirectory.password,
        username: "Admin",
    },
});
const testWindowsFileSystem = new aws.fsx.WindowsFileSystem("test", {
    activeDirectoryId: testAwsDirectoryServiceDirectory.id,
    securityGroupIds: [testAwsSecurityGroup.id],
    skipFinalBackup: true,
    storageCapacity: 32,
    subnetIds: [testAwsSubnet[0].id],
    throughputCapacity: 8,
});
const fsx = new aws.storagegateway.FileSystemAssociation("fsx", {
    gatewayArn: testGateway.arn,
    locationArn: testWindowsFileSystem.arn,
    username: "Admin",
    password: testAwsDirectoryServiceDirectory.password,
    cacheAttributes: {
        cacheStaleTimeoutInSeconds: 400,
    },
    auditDestinationArn: testAwsCloudwatchLogGroup.arn,
});

    import pulumi
import pulumi_aws as aws

aws_service_storagegateway_ami_files3_latest = aws.ssm.get_parameter(name="/aws/service/storagegateway/ami/FILE_S3/latest")
test = aws.ec2.Instance("test",
    ami=aws_service_storagegateway_ami_files3_latest.value,
    associate_public_ip_address=True,
    instance_type=aws.ec2.InstanceType(available["instanceType"]),
    vpc_security_group_ids=[test_aws_security_group["id"]],
    subnet_id=test_aws_subnet[0]["id"],
    opts=pulumi.ResourceOptions(depends_on=[
            test_aws_route,
            test_aws_vpc_dhcp_options_association,
        ]))
test_gateway = aws.storagegateway.Gateway("test",
    gateway_ip_address=test.public_ip,
    gateway_name="test-sgw",
    gateway_timezone="GMT",
    gateway_type="FILE_FSX_SMB",
    smb_active_directory_settings=aws.storagegateway.GatewaySmbActiveDirectorySettingsArgs(
        domain_name=test_aws_directory_service_directory["name"],
        password=test_aws_directory_service_directory["password"],
        username="Admin",
    ))
test_windows_file_system = aws.fsx.WindowsFileSystem("test",
    active_directory_id=test_aws_directory_service_directory["id"],
    security_group_ids=[test_aws_security_group["id"]],
    skip_final_backup=True,
    storage_capacity=32,
    subnet_ids=[test_aws_subnet[0]["id"]],
    throughput_capacity=8)
fsx = aws.storagegateway.FileSystemAssociation("fsx",
    gateway_arn=test_gateway.arn,
    location_arn=test_windows_file_system.arn,
    username="Admin",
    password=test_aws_directory_service_directory["password"],
    cache_attributes=aws.storagegateway.FileSystemAssociationCacheAttributesArgs(
        cache_stale_timeout_in_seconds=400,
    ),
    audit_destination_arn=test_aws_cloudwatch_log_group["arn"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssm"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		awsServiceStoragegatewayAmiFILES3Latest, err := ssm.LookupParameter(ctx, &ssm.LookupParameterArgs{
			Name: "/aws/service/storagegateway/ami/FILE_S3/latest",
		}, nil)
		if err != nil {
			return err
		}
		test, err := ec2.NewInstance(ctx, "test", &ec2.InstanceArgs{
			Ami:                      pulumi.String(awsServiceStoragegatewayAmiFILES3Latest.Value),
			AssociatePublicIpAddress: pulumi.Bool(true),
			InstanceType:             ec2.InstanceType(available.InstanceType),
			VpcSecurityGroupIds: pulumi.StringArray{
				testAwsSecurityGroup.Id,
			},
			SubnetId: pulumi.Any(testAwsSubnet[0].Id),
		}, pulumi.DependsOn([]pulumi.Resource{
			testAwsRoute,
			testAwsVpcDhcpOptionsAssociation,
		}))
		if err != nil {
			return err
		}
		testGateway, err := storagegateway.NewGateway(ctx, "test", &storagegateway.GatewayArgs{
			GatewayIpAddress: test.PublicIp,
			GatewayName:      pulumi.String("test-sgw"),
			GatewayTimezone:  pulumi.String("GMT"),
			GatewayType:      pulumi.String("FILE_FSX_SMB"),
			SmbActiveDirectorySettings: &storagegateway.GatewaySmbActiveDirectorySettingsArgs{
				DomainName: pulumi.Any(testAwsDirectoryServiceDirectory.Name),
				Password:   pulumi.Any(testAwsDirectoryServiceDirectory.Password),
				Username:   pulumi.String("Admin"),
			},
		})
		if err != nil {
			return err
		}
		testWindowsFileSystem, err := fsx.NewWindowsFileSystem(ctx, "test", &fsx.WindowsFileSystemArgs{
			ActiveDirectoryId: pulumi.Any(testAwsDirectoryServiceDirectory.Id),
			SecurityGroupIds: pulumi.StringArray{
				testAwsSecurityGroup.Id,
			},
			SkipFinalBackup: pulumi.Bool(true),
			StorageCapacity: pulumi.Int(32),
			SubnetIds: pulumi.StringArray{
				testAwsSubnet[0].Id,
			},
			ThroughputCapacity: pulumi.Int(8),
		})
		if err != nil {
			return err
		}
		_, err = storagegateway.NewFileSystemAssociation(ctx, "fsx", &storagegateway.FileSystemAssociationArgs{
			GatewayArn:  testGateway.Arn,
			LocationArn: testWindowsFileSystem.Arn,
			Username:    pulumi.String("Admin"),
			Password:    pulumi.Any(testAwsDirectoryServiceDirectory.Password),
			CacheAttributes: &storagegateway.FileSystemAssociationCacheAttributesArgs{
				CacheStaleTimeoutInSeconds: pulumi.Int(400),
			},
			AuditDestinationArn: pulumi.Any(testAwsCloudwatchLogGroup.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 awsServiceStoragegatewayAmiFILES3Latest = Aws.Ssm.GetParameter.Invoke(new()
    {
        Name = "/aws/service/storagegateway/ami/FILE_S3/latest",
    });

    var test = new Aws.Ec2.Instance("test", new()
    {
        Ami = awsServiceStoragegatewayAmiFILES3Latest.Apply(getParameterResult => getParameterResult.Value),
        AssociatePublicIpAddress = true,
        InstanceType = System.Enum.Parse<Aws.Ec2.InstanceType>(available.InstanceType),
        VpcSecurityGroupIds = new[]
        {
            testAwsSecurityGroup.Id,
        },
        SubnetId = testAwsSubnet[0].Id,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            testAwsRoute, 
            testAwsVpcDhcpOptionsAssociation, 
        },
    });

    var testGateway = new Aws.StorageGateway.Gateway("test", new()
    {
        GatewayIpAddress = test.PublicIp,
        GatewayName = "test-sgw",
        GatewayTimezone = "GMT",
        GatewayType = "FILE_FSX_SMB",
        SmbActiveDirectorySettings = new Aws.StorageGateway.Inputs.GatewaySmbActiveDirectorySettingsArgs
        {
            DomainName = testAwsDirectoryServiceDirectory.Name,
            Password = testAwsDirectoryServiceDirectory.Password,
            Username = "Admin",
        },
    });

    var testWindowsFileSystem = new Aws.Fsx.WindowsFileSystem("test", new()
    {
        ActiveDirectoryId = testAwsDirectoryServiceDirectory.Id,
        SecurityGroupIds = new[]
        {
            testAwsSecurityGroup.Id,
        },
        SkipFinalBackup = true,
        StorageCapacity = 32,
        SubnetIds = new[]
        {
            testAwsSubnet[0].Id,
        },
        ThroughputCapacity = 8,
    });

    var fsx = new Aws.StorageGateway.FileSystemAssociation("fsx", new()
    {
        GatewayArn = testGateway.Arn,
        LocationArn = testWindowsFileSystem.Arn,
        Username = "Admin",
        Password = testAwsDirectoryServiceDirectory.Password,
        CacheAttributes = new Aws.StorageGateway.Inputs.FileSystemAssociationCacheAttributesArgs
        {
            CacheStaleTimeoutInSeconds = 400,
        },
        AuditDestinationArn = testAwsCloudwatchLogGroup.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssm.SsmFunctions;
import com.pulumi.aws.ssm.inputs.GetParameterArgs;
import com.pulumi.aws.ec2.Instance;
import com.pulumi.aws.ec2.InstanceArgs;
import com.pulumi.aws.storagegateway.Gateway;
import com.pulumi.aws.storagegateway.GatewayArgs;
import com.pulumi.aws.storagegateway.inputs.GatewaySmbActiveDirectorySettingsArgs;
import com.pulumi.aws.fsx.WindowsFileSystem;
import com.pulumi.aws.fsx.WindowsFileSystemArgs;
import com.pulumi.aws.storagegateway.FileSystemAssociation;
import com.pulumi.aws.storagegateway.FileSystemAssociationArgs;
import com.pulumi.aws.storagegateway.inputs.FileSystemAssociationCacheAttributesArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        final var awsServiceStoragegatewayAmiFILES3Latest = SsmFunctions.getParameter(GetParameterArgs.builder()
            .name("/aws/service/storagegateway/ami/FILE_S3/latest")
            .build());

        var test = new Instance("test", InstanceArgs.builder()        
            .ami(awsServiceStoragegatewayAmiFILES3Latest.applyValue(getParameterResult -> getParameterResult.value()))
            .associatePublicIpAddress(true)
            .instanceType(available.instanceType())
            .vpcSecurityGroupIds(testAwsSecurityGroup.id())
            .subnetId(testAwsSubnet[0].id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(                
                    testAwsRoute,
                    testAwsVpcDhcpOptionsAssociation)
                .build());

        var testGateway = new Gateway("testGateway", GatewayArgs.builder()        
            .gatewayIpAddress(test.publicIp())
            .gatewayName("test-sgw")
            .gatewayTimezone("GMT")
            .gatewayType("FILE_FSX_SMB")
            .smbActiveDirectorySettings(GatewaySmbActiveDirectorySettingsArgs.builder()
                .domainName(testAwsDirectoryServiceDirectory.name())
                .password(testAwsDirectoryServiceDirectory.password())
                .username("Admin")
                .build())
            .build());

        var testWindowsFileSystem = new WindowsFileSystem("testWindowsFileSystem", WindowsFileSystemArgs.builder()        
            .activeDirectoryId(testAwsDirectoryServiceDirectory.id())
            .securityGroupIds(testAwsSecurityGroup.id())
            .skipFinalBackup(true)
            .storageCapacity(32)
            .subnetIds(testAwsSubnet[0].id())
            .throughputCapacity(8)
            .build());

        var fsx = new FileSystemAssociation("fsx", FileSystemAssociationArgs.builder()        
            .gatewayArn(testGateway.arn())
            .locationArn(testWindowsFileSystem.arn())
            .username("Admin")
            .password(testAwsDirectoryServiceDirectory.password())
            .cacheAttributes(FileSystemAssociationCacheAttributesArgs.builder()
                .cacheStaleTimeoutInSeconds(400)
                .build())
            .auditDestinationArn(testAwsCloudwatchLogGroup.arn())
            .build());

    }
}

    resources:
  test:
    type: aws:ec2:Instance
    properties:
      ami: ${awsServiceStoragegatewayAmiFILES3Latest.value}
      associatePublicIpAddress: true
      instanceType: ${available.instanceType}
      vpcSecurityGroupIds:
        - ${testAwsSecurityGroup.id}
      subnetId: ${testAwsSubnet[0].id}
    options:
      dependson:
        - ${testAwsRoute}
        - ${testAwsVpcDhcpOptionsAssociation}
  testGateway:
    type: aws:storagegateway:Gateway
    name: test
    properties:
      gatewayIpAddress: ${test.publicIp}
      gatewayName: test-sgw
      gatewayTimezone: GMT
      gatewayType: FILE_FSX_SMB
      smbActiveDirectorySettings:
        domainName: ${testAwsDirectoryServiceDirectory.name}
        password: ${testAwsDirectoryServiceDirectory.password}
        username: Admin
  testWindowsFileSystem:
    type: aws:fsx:WindowsFileSystem
    name: test
    properties:
      activeDirectoryId: ${testAwsDirectoryServiceDirectory.id}
      securityGroupIds:
        - ${testAwsSecurityGroup.id}
      skipFinalBackup: true
      storageCapacity: 32
      subnetIds:
        - ${testAwsSubnet[0].id}
      throughputCapacity: 8
  fsx:
    type: aws:storagegateway:FileSystemAssociation
    properties:
      gatewayArn: ${testGateway.arn}
      locationArn: ${testWindowsFileSystem.arn}
      username: Admin
      password: ${testAwsDirectoryServiceDirectory.password}
      cacheAttributes:
        cacheStaleTimeoutInSeconds: 400
      auditDestinationArn: ${testAwsCloudwatchLogGroup.arn}
variables:
  awsServiceStoragegatewayAmiFILES3Latest:
    fn::invoke:
      Function: aws:ssm:getParameter
      Arguments:
        name: /aws/service/storagegateway/ami/FILE_S3/latest

    Create FileSystemAssociation Resource

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

    Constructor syntax

    new FileSystemAssociation(name: string, args: FileSystemAssociationArgs, opts?: CustomResourceOptions);
    @overload
def FileSystemAssociation(resource_name: str,
                          args: FileSystemAssociationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def FileSystemAssociation(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          gateway_arn: Optional[str] = None,
                          location_arn: Optional[str] = None,
                          password: Optional[str] = None,
                          username: Optional[str] = None,
                          audit_destination_arn: Optional[str] = None,
                          cache_attributes: Optional[FileSystemAssociationCacheAttributesArgs] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewFileSystemAssociation(ctx *Context, name string, args FileSystemAssociationArgs, opts ...ResourceOption) (*FileSystemAssociation, error)
    public FileSystemAssociation(string name, FileSystemAssociationArgs args, CustomResourceOptions? opts = null)
    public FileSystemAssociation(String name, FileSystemAssociationArgs args)
public FileSystemAssociation(String name, FileSystemAssociationArgs args, CustomResourceOptions options)

    type: aws:storagegateway:FileSystemAssociation
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 FileSystemAssociationArgs
    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 FileSystemAssociationArgs
    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 FileSystemAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FileSystemAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FileSystemAssociationArgs
    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.

    var fileSystemAssociationResource = new Aws.StorageGateway.FileSystemAssociation("fileSystemAssociationResource", new()
{
    GatewayArn = "string",
    LocationArn = "string",
    Password = "string",
    Username = "string",
    AuditDestinationArn = "string",
    CacheAttributes = new Aws.StorageGateway.Inputs.FileSystemAssociationCacheAttributesArgs
    {
        CacheStaleTimeoutInSeconds = 0,
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := storagegateway.NewFileSystemAssociation(ctx, "fileSystemAssociationResource", &storagegateway.FileSystemAssociationArgs{
	GatewayArn:          pulumi.String("string"),
	LocationArn:         pulumi.String("string"),
	Password:            pulumi.String("string"),
	Username:            pulumi.String("string"),
	AuditDestinationArn: pulumi.String("string"),
	CacheAttributes: &storagegateway.FileSystemAssociationCacheAttributesArgs{
		CacheStaleTimeoutInSeconds: pulumi.Int(0),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var fileSystemAssociationResource = new FileSystemAssociation("fileSystemAssociationResource", FileSystemAssociationArgs.builder()        
    .gatewayArn("string")
    .locationArn("string")
    .password("string")
    .username("string")
    .auditDestinationArn("string")
    .cacheAttributes(FileSystemAssociationCacheAttributesArgs.builder()
        .cacheStaleTimeoutInSeconds(0)
        .build())
    .tags(Map.of("string", "string"))
    .build());

    file_system_association_resource = aws.storagegateway.FileSystemAssociation("fileSystemAssociationResource",
    gateway_arn="string",
    location_arn="string",
    password="string",
    username="string",
    audit_destination_arn="string",
    cache_attributes=aws.storagegateway.FileSystemAssociationCacheAttributesArgs(
        cache_stale_timeout_in_seconds=0,
    ),
    tags={
        "string": "string",
    })

    const fileSystemAssociationResource = new aws.storagegateway.FileSystemAssociation("fileSystemAssociationResource", {
    gatewayArn: "string",
    locationArn: "string",
    password: "string",
    username: "string",
    auditDestinationArn: "string",
    cacheAttributes: {
        cacheStaleTimeoutInSeconds: 0,
    },
    tags: {
        string: "string",
    },
});

    type: aws:storagegateway:FileSystemAssociation
properties:
    auditDestinationArn: string
    cacheAttributes:
        cacheStaleTimeoutInSeconds: 0
    gatewayArn: string
    locationArn: string
    password: string
    tags:
        string: string
    username: string

    FileSystemAssociation 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 FileSystemAssociation resource accepts the following input properties:

    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    Password string
    The password of the user credential.
    Username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    CacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    Password string
    The password of the user credential.
    Username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    CacheAttributes FileSystemAssociationCacheAttributesArgs
    Refresh cache information. see Cache Attributes for more details.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password String
    The password of the user credential.
    username String
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    locationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password string
    The password of the user credential.
    username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    auditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway.
    location_arn str
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password str
    The password of the user credential.
    username str
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    audit_destination_arn str
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cache_attributes FileSystemAssociationCacheAttributesArgs
    Refresh cache information. see Cache Attributes for more details.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password String
    The password of the user credential.
    username String
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes Property Map
    Refresh cache information. see Cache Attributes for more details.
    tags Map<String>
    Key-value map of resource tags. 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 FileSystemAssociation resource produces the following output properties:

    Arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the newly created file system association.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of the newly created file system association.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of the newly created file system association.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing FileSystemAssociation Resource

    Get an existing FileSystemAssociation 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?: FileSystemAssociationState, opts?: CustomResourceOptions): FileSystemAssociation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        audit_destination_arn: Optional[str] = None,
        cache_attributes: Optional[FileSystemAssociationCacheAttributesArgs] = None,
        gateway_arn: Optional[str] = None,
        location_arn: Optional[str] = None,
        password: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        username: Optional[str] = None) -> FileSystemAssociation
    func GetFileSystemAssociation(ctx *Context, name string, id IDInput, state *FileSystemAssociationState, opts ...ResourceOption) (*FileSystemAssociation, error)
    public static FileSystemAssociation Get(string name, Input<string> id, FileSystemAssociationState? state, CustomResourceOptions? opts = null)
    public static FileSystemAssociation get(String name, Output<String> id, FileSystemAssociationState 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.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    CacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    Password string
    The password of the user credential.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    Arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    AuditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    CacheAttributes FileSystemAssociationCacheAttributesArgs
    Refresh cache information. see Cache Attributes for more details.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    LocationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    Password string
    The password of the user credential.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    arn String
    Amazon Resource Name (ARN) of the newly created file system association.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password String
    The password of the user credential.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    username String
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    arn string
    Amazon Resource Name (ARN) of the newly created file system association.
    auditDestinationArn string
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes FileSystemAssociationCacheAttributes
    Refresh cache information. see Cache Attributes for more details.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    locationArn string
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password string
    The password of the user credential.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    username string
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    arn str
    Amazon Resource Name (ARN) of the newly created file system association.
    audit_destination_arn str
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cache_attributes FileSystemAssociationCacheAttributesArgs
    Refresh cache information. see Cache Attributes for more details.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway.
    location_arn str
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password str
    The password of the user credential.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    username str
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
    arn String
    Amazon Resource Name (ARN) of the newly created file system association.
    auditDestinationArn String
    The Amazon Resource Name (ARN) of the storage used for the audit logs.
    cacheAttributes Property Map
    Refresh cache information. see Cache Attributes for more details.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    locationArn String
    The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
    password String
    The password of the user credential.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    username String
    The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

    Supporting Types

    FileSystemAssociationCacheAttributes, FileSystemAssociationCacheAttributesArgs

    CacheStaleTimeoutInSeconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0
    CacheStaleTimeoutInSeconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0
    cacheStaleTimeoutInSeconds Integer
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0
    cacheStaleTimeoutInSeconds number
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0
    cache_stale_timeout_in_seconds int
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0
    cacheStaleTimeoutInSeconds Number
    Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. Valid Values: 0 or 300 to 2592000 seconds (5 minutes to 30 days). Defaults to 0

    Import

    Using pulumi import, import aws_storagegateway_file_system_association using the FSx file system association Amazon Resource Name (ARN). For example:

    $ pulumi import aws:storagegateway/fileSystemAssociation:FileSystemAssociation example arn:aws:storagegateway:us-east-1:123456789012:fs-association/fsa-0DA347732FDB40125

    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.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws