published on Thursday, Apr 16, 2026 by Pulumi
published on Thursday, Apr 16, 2026 by Pulumi
Manages an S3 Files File System.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.FilesFileSystem("example", {
bucket: exampleAwsS3Bucket.arn,
roleArn: exampleAwsIamRole.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.FilesFileSystem("example",
bucket=example_aws_s3_bucket["arn"],
role_arn=example_aws_iam_role["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewFilesFileSystem(ctx, "example", &s3.FilesFileSystemArgs{
Bucket: pulumi.Any(exampleAwsS3Bucket.Arn),
RoleArn: pulumi.Any(exampleAwsIamRole.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.S3.FilesFileSystem("example", new()
{
Bucket = exampleAwsS3Bucket.Arn,
RoleArn = exampleAwsIamRole.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.FilesFileSystem;
import com.pulumi.aws.s3.FilesFileSystemArgs;
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 FilesFileSystem("example", FilesFileSystemArgs.builder()
.bucket(exampleAwsS3Bucket.arn())
.roleArn(exampleAwsIamRole.arn())
.build());
}
}
resources:
example:
type: aws:s3:FilesFileSystem
properties:
bucket: ${exampleAwsS3Bucket.arn}
roleArn: ${exampleAwsIamRole.arn}
Create FilesFileSystem Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FilesFileSystem(name: string, args: FilesFileSystemArgs, opts?: CustomResourceOptions);@overload
def FilesFileSystem(resource_name: str,
args: FilesFileSystemArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FilesFileSystem(resource_name: str,
opts: Optional[ResourceOptions] = None,
bucket: Optional[str] = None,
role_arn: Optional[str] = None,
kms_key_id: Optional[str] = None,
prefix: Optional[str] = None,
region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timeouts: Optional[FilesFileSystemTimeoutsArgs] = None)func NewFilesFileSystem(ctx *Context, name string, args FilesFileSystemArgs, opts ...ResourceOption) (*FilesFileSystem, error)public FilesFileSystem(string name, FilesFileSystemArgs args, CustomResourceOptions? opts = null)
public FilesFileSystem(String name, FilesFileSystemArgs args)
public FilesFileSystem(String name, FilesFileSystemArgs args, CustomResourceOptions options)
type: aws:s3:FilesFileSystem
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 FilesFileSystemArgs
- 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 FilesFileSystemArgs
- 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 FilesFileSystemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FilesFileSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FilesFileSystemArgs
- 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 filesFileSystemResource = new Aws.S3.FilesFileSystem("filesFileSystemResource", new()
{
Bucket = "string",
RoleArn = "string",
KmsKeyId = "string",
Prefix = "string",
Region = "string",
Tags =
{
{ "string", "string" },
},
Timeouts = new Aws.S3.Inputs.FilesFileSystemTimeoutsArgs
{
Create = "string",
Delete = "string",
},
});
example, err := s3.NewFilesFileSystem(ctx, "filesFileSystemResource", &s3.FilesFileSystemArgs{
Bucket: pulumi.String("string"),
RoleArn: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
Prefix: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timeouts: &s3.FilesFileSystemTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
var filesFileSystemResource = new FilesFileSystem("filesFileSystemResource", FilesFileSystemArgs.builder()
.bucket("string")
.roleArn("string")
.kmsKeyId("string")
.prefix("string")
.region("string")
.tags(Map.of("string", "string"))
.timeouts(FilesFileSystemTimeoutsArgs.builder()
.create("string")
.delete("string")
.build())
.build());
files_file_system_resource = aws.s3.FilesFileSystem("filesFileSystemResource",
bucket="string",
role_arn="string",
kms_key_id="string",
prefix="string",
region="string",
tags={
"string": "string",
},
timeouts={
"create": "string",
"delete": "string",
})
const filesFileSystemResource = new aws.s3.FilesFileSystem("filesFileSystemResource", {
bucket: "string",
roleArn: "string",
kmsKeyId: "string",
prefix: "string",
region: "string",
tags: {
string: "string",
},
timeouts: {
create: "string",
"delete": "string",
},
});
type: aws:s3:FilesFileSystem
properties:
bucket: string
kmsKeyId: string
prefix: string
region: string
roleArn: string
tags:
string: string
timeouts:
create: string
delete: string
FilesFileSystem 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 FilesFileSystem resource accepts the following input properties:
- Bucket string
- S3 bucket ARN. Changing this value forces replacement.
- Role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- Kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- Prefix string
- S3 bucket prefix. Changing this value forces replacement.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Files
File System Timeouts
- Bucket string
- S3 bucket ARN. Changing this value forces replacement.
- Role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- Kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- Prefix string
- S3 bucket prefix. Changing this value forces replacement.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- map[string]string
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timeouts
Files
File System Timeouts Args
- bucket String
- S3 bucket ARN. Changing this value forces replacement.
- role
Arn String IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- kms
Key StringId - KMS key ID for encryption. Changing this value forces replacement.
- prefix String
- S3 bucket prefix. Changing this value forces replacement.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Files
File System Timeouts
- bucket string
- S3 bucket ARN. Changing this value forces replacement.
- role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- prefix string
- S3 bucket prefix. Changing this value forces replacement.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Files
File System Timeouts
- bucket str
- S3 bucket ARN. Changing this value forces replacement.
- role_
arn str IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- kms_
key_ strid - KMS key ID for encryption. Changing this value forces replacement.
- prefix str
- S3 bucket prefix. Changing this value forces replacement.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts
Files
File System Timeouts Args
- bucket String
- S3 bucket ARN. Changing this value forces replacement.
- role
Arn String IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- kms
Key StringId - KMS key ID for encryption. Changing this value forces replacement.
- prefix String
- S3 bucket prefix. Changing this value forces replacement.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Map<String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the FilesFileSystem resource produces the following output properties:
- Arn string
- ARN of the file system.
- Creation
Time string - Creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- File system name.
- Owner
Id string - AWS account ID of the owner.
- Status string
- File system status.
- Status
Message string - Status message.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- Arn string
- ARN of the file system.
- Creation
Time string - Creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- File system name.
- Owner
Id string - AWS account ID of the owner.
- Status string
- File system status.
- Status
Message string - Status message.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the file system.
- creation
Time String - Creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- File system name.
- owner
Id String - AWS account ID of the owner.
- status String
- File system status.
- status
Message String - Status message.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn string
- ARN of the file system.
- creation
Time string - Creation time.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- File system name.
- owner
Id string - AWS account ID of the owner.
- status string
- File system status.
- status
Message string - Status message.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn str
- ARN of the file system.
- creation_
time str - Creation time.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- File system name.
- owner_
id str - AWS account ID of the owner.
- status str
- File system status.
- status_
message str - Status message.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
- arn String
- ARN of the file system.
- creation
Time String - Creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- File system name.
- owner
Id String - AWS account ID of the owner.
- status String
- File system status.
- status
Message String - Status message.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.
Look up Existing FilesFileSystem Resource
Get an existing FilesFileSystem 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?: FilesFileSystemState, opts?: CustomResourceOptions): FilesFileSystem@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
bucket: Optional[str] = None,
creation_time: Optional[str] = None,
kms_key_id: Optional[str] = None,
name: Optional[str] = None,
owner_id: Optional[str] = None,
prefix: Optional[str] = None,
region: Optional[str] = None,
role_arn: Optional[str] = None,
status: Optional[str] = None,
status_message: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
timeouts: Optional[FilesFileSystemTimeoutsArgs] = None) -> FilesFileSystemfunc GetFilesFileSystem(ctx *Context, name string, id IDInput, state *FilesFileSystemState, opts ...ResourceOption) (*FilesFileSystem, error)public static FilesFileSystem Get(string name, Input<string> id, FilesFileSystemState? state, CustomResourceOptions? opts = null)public static FilesFileSystem get(String name, Output<String> id, FilesFileSystemState state, CustomResourceOptions options)resources: _: type: aws:s3:FilesFileSystem get: id: ${id}- 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
- ARN of the file system.
- Bucket string
- S3 bucket ARN. Changing this value forces replacement.
- Creation
Time string - Creation time.
- Kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- Name string
- File system name.
- Owner
Id string - AWS account ID of the owner.
- Prefix string
- S3 bucket prefix. Changing this value forces replacement.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- Status string
- File system status.
- Status
Message string - Status message.
- Dictionary<string, string>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - Timeouts
Files
File System Timeouts
- Arn string
- ARN of the file system.
- Bucket string
- S3 bucket ARN. Changing this value forces replacement.
- Creation
Time string - Creation time.
- Kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- Name string
- File system name.
- Owner
Id string - AWS account ID of the owner.
- Prefix string
- S3 bucket prefix. Changing this value forces replacement.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- Status string
- File system status.
- Status
Message string - Status message.
- map[string]string
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - Timeouts
Files
File System Timeouts Args
- arn String
- ARN of the file system.
- bucket String
- S3 bucket ARN. Changing this value forces replacement.
- creation
Time String - Creation time.
- kms
Key StringId - KMS key ID for encryption. Changing this value forces replacement.
- name String
- File system name.
- owner
Id String - AWS account ID of the owner.
- prefix String
- S3 bucket prefix. Changing this value forces replacement.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn String IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- status String
- File system status.
- status
Message String - Status message.
- Map<String,String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - timeouts
Files
File System Timeouts
- arn string
- ARN of the file system.
- bucket string
- S3 bucket ARN. Changing this value forces replacement.
- creation
Time string - Creation time.
- kms
Key stringId - KMS key ID for encryption. Changing this value forces replacement.
- name string
- File system name.
- owner
Id string - AWS account ID of the owner.
- prefix string
- S3 bucket prefix. Changing this value forces replacement.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn string IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- status string
- File system status.
- status
Message string - Status message.
- {[key: string]: string}
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - timeouts
Files
File System Timeouts
- arn str
- ARN of the file system.
- bucket str
- S3 bucket ARN. Changing this value forces replacement.
- creation_
time str - Creation time.
- kms_
key_ strid - KMS key ID for encryption. Changing this value forces replacement.
- name str
- File system name.
- owner_
id str - AWS account ID of the owner.
- prefix str
- S3 bucket prefix. Changing this value forces replacement.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role_
arn str IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- status str
- File system status.
- status_
message str - Status message.
- Mapping[str, str]
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - timeouts
Files
File System Timeouts Args
- arn String
- ARN of the file system.
- bucket String
- S3 bucket ARN. Changing this value forces replacement.
- creation
Time String - Creation time.
- kms
Key StringId - KMS key ID for encryption. Changing this value forces replacement.
- name String
- File system name.
- owner
Id String - AWS account ID of the owner.
- prefix String
- S3 bucket prefix. Changing this value forces replacement.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- role
Arn String IAM role ARN for S3 access. Changing this value forces replacement.
The following arguments are optional:
- status String
- File system status.
- status
Message String - Status message.
- Map<String>
- Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block. - timeouts Property Map
Supporting Types
FilesFileSystemTimeouts, FilesFileSystemTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Import
Identity Schema
Required
id- Identifier of the file system.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import S3 Files File System using id. For example:
$ pulumi import aws:s3/filesFileSystem:FilesFileSystem example fs-1234567890abcdef0
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
awsTerraform Provider.
published on Thursday, Apr 16, 2026 by Pulumi
