1. Packages
  2. AWS
  3. API Docs
  4. s3
  5. FilesSynchronizationConfiguration
Viewing docs for AWS v7.26.0
published on Thursday, Apr 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.s3.FilesSynchronizationConfiguration

aws logo
Viewing docs for AWS v7.26.0
published on Thursday, Apr 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages an S3 Files Synchronization configuration.

    Example Usage

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

const example = new aws.s3.FilesSynchronizationConfiguration("example", {
    fileSystemId: exampleAwsS3filesFileSystem.id,
    importDataRules: [{
        prefix: "",
        sizeLessThan: 52673613135872,
        trigger: "ON_FILE_ACCESS",
    }],
    expirationDataRules: [{
        daysAfterLastAccess: 30,
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.s3.FilesSynchronizationConfiguration("example",
    file_system_id=example_aws_s3files_file_system["id"],
    import_data_rules=[{
        "prefix": "",
        "size_less_than": 52673613135872,
        "trigger": "ON_FILE_ACCESS",
    }],
    expiration_data_rules=[{
        "days_after_last_access": 30,
    }])

    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.NewFilesSynchronizationConfiguration(ctx, "example", &s3.FilesSynchronizationConfigurationArgs{
			FileSystemId: pulumi.Any(exampleAwsS3filesFileSystem.Id),
			ImportDataRules: s3.FilesSynchronizationConfigurationImportDataRuleArray{
				&s3.FilesSynchronizationConfigurationImportDataRuleArgs{
					Prefix:       pulumi.String(""),
					SizeLessThan: pulumi.Int(52673613135872),
					Trigger:      pulumi.String("ON_FILE_ACCESS"),
				},
			},
			ExpirationDataRules: s3.FilesSynchronizationConfigurationExpirationDataRuleArray{
				&s3.FilesSynchronizationConfigurationExpirationDataRuleArgs{
					DaysAfterLastAccess: pulumi.Int(30),
				},
			},
		})
		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.FilesSynchronizationConfiguration("example", new()
    {
        FileSystemId = exampleAwsS3filesFileSystem.Id,
        ImportDataRules = new[]
        {
            new Aws.S3.Inputs.FilesSynchronizationConfigurationImportDataRuleArgs
            {
                Prefix = "",
                SizeLessThan = 52673613135872,
                Trigger = "ON_FILE_ACCESS",
            },
        },
        ExpirationDataRules = new[]
        {
            new Aws.S3.Inputs.FilesSynchronizationConfigurationExpirationDataRuleArgs
            {
                DaysAfterLastAccess = 30,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.FilesSynchronizationConfiguration;
import com.pulumi.aws.s3.FilesSynchronizationConfigurationArgs;
import com.pulumi.aws.s3.inputs.FilesSynchronizationConfigurationImportDataRuleArgs;
import com.pulumi.aws.s3.inputs.FilesSynchronizationConfigurationExpirationDataRuleArgs;
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 FilesSynchronizationConfiguration("example", FilesSynchronizationConfigurationArgs.builder()
            .fileSystemId(exampleAwsS3filesFileSystem.id())
            .importDataRules(FilesSynchronizationConfigurationImportDataRuleArgs.builder()
                .prefix("")
                .sizeLessThan(52673613135872)
                .trigger("ON_FILE_ACCESS")
                .build())
            .expirationDataRules(FilesSynchronizationConfigurationExpirationDataRuleArgs.builder()
                .daysAfterLastAccess(30)
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:s3:FilesSynchronizationConfiguration
    properties:
      fileSystemId: ${exampleAwsS3filesFileSystem.id}
      importDataRules:
        - prefix: ""
          sizeLessThan: 5.2673613135872e+13
          trigger: ON_FILE_ACCESS
      expirationDataRules:
        - daysAfterLastAccess: 30

    Create FilesSynchronizationConfiguration Resource

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

    Constructor syntax

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

@overload
def FilesSynchronizationConfiguration(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      file_system_id: Optional[str] = None,
                                      expiration_data_rules: Optional[Sequence[FilesSynchronizationConfigurationExpirationDataRuleArgs]] = None,
                                      import_data_rules: Optional[Sequence[FilesSynchronizationConfigurationImportDataRuleArgs]] = None,
                                      latest_version_number: Optional[int] = None,
                                      region: Optional[str] = None)
    func NewFilesSynchronizationConfiguration(ctx *Context, name string, args FilesSynchronizationConfigurationArgs, opts ...ResourceOption) (*FilesSynchronizationConfiguration, error)
    public FilesSynchronizationConfiguration(string name, FilesSynchronizationConfigurationArgs args, CustomResourceOptions? opts = null)
    public FilesSynchronizationConfiguration(String name, FilesSynchronizationConfigurationArgs args)
public FilesSynchronizationConfiguration(String name, FilesSynchronizationConfigurationArgs args, CustomResourceOptions options)

    type: aws:s3:FilesSynchronizationConfiguration
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 FilesSynchronizationConfigurationArgs
    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 FilesSynchronizationConfigurationArgs
    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 FilesSynchronizationConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FilesSynchronizationConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FilesSynchronizationConfigurationArgs
    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 filesSynchronizationConfigurationResource = new Aws.S3.FilesSynchronizationConfiguration("filesSynchronizationConfigurationResource", new()
{
    FileSystemId = "string",
    ExpirationDataRules = new[]
    {
        new Aws.S3.Inputs.FilesSynchronizationConfigurationExpirationDataRuleArgs
        {
            DaysAfterLastAccess = 0,
        },
    },
    ImportDataRules = new[]
    {
        new Aws.S3.Inputs.FilesSynchronizationConfigurationImportDataRuleArgs
        {
            Prefix = "string",
            SizeLessThan = 0,
            Trigger = "string",
        },
    },
    LatestVersionNumber = 0,
    Region = "string",
});

    example, err := s3.NewFilesSynchronizationConfiguration(ctx, "filesSynchronizationConfigurationResource", &s3.FilesSynchronizationConfigurationArgs{
	FileSystemId: pulumi.String("string"),
	ExpirationDataRules: s3.FilesSynchronizationConfigurationExpirationDataRuleArray{
		&s3.FilesSynchronizationConfigurationExpirationDataRuleArgs{
			DaysAfterLastAccess: pulumi.Int(0),
		},
	},
	ImportDataRules: s3.FilesSynchronizationConfigurationImportDataRuleArray{
		&s3.FilesSynchronizationConfigurationImportDataRuleArgs{
			Prefix:       pulumi.String("string"),
			SizeLessThan: pulumi.Int(0),
			Trigger:      pulumi.String("string"),
		},
	},
	LatestVersionNumber: pulumi.Int(0),
	Region:              pulumi.String("string"),
})

    var filesSynchronizationConfigurationResource = new FilesSynchronizationConfiguration("filesSynchronizationConfigurationResource", FilesSynchronizationConfigurationArgs.builder()
    .fileSystemId("string")
    .expirationDataRules(FilesSynchronizationConfigurationExpirationDataRuleArgs.builder()
        .daysAfterLastAccess(0)
        .build())
    .importDataRules(FilesSynchronizationConfigurationImportDataRuleArgs.builder()
        .prefix("string")
        .sizeLessThan(0)
        .trigger("string")
        .build())
    .latestVersionNumber(0)
    .region("string")
    .build());

    files_synchronization_configuration_resource = aws.s3.FilesSynchronizationConfiguration("filesSynchronizationConfigurationResource",
    file_system_id="string",
    expiration_data_rules=[{
        "days_after_last_access": 0,
    }],
    import_data_rules=[{
        "prefix": "string",
        "size_less_than": 0,
        "trigger": "string",
    }],
    latest_version_number=0,
    region="string")

    const filesSynchronizationConfigurationResource = new aws.s3.FilesSynchronizationConfiguration("filesSynchronizationConfigurationResource", {
    fileSystemId: "string",
    expirationDataRules: [{
        daysAfterLastAccess: 0,
    }],
    importDataRules: [{
        prefix: "string",
        sizeLessThan: 0,
        trigger: "string",
    }],
    latestVersionNumber: 0,
    region: "string",
});

    type: aws:s3:FilesSynchronizationConfiguration
properties:
    expirationDataRules:
        - daysAfterLastAccess: 0
    fileSystemId: string
    importDataRules:
        - prefix: string
          sizeLessThan: 0
          trigger: string
    latestVersionNumber: 0
    region: string

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

    FileSystemId string
    File system ID. Changing this value forces replacement.
    ExpirationDataRules List<FilesSynchronizationConfigurationExpirationDataRule>
    Expiration data rule configuration. See expirationDataRule below.
    ImportDataRules List<FilesSynchronizationConfigurationImportDataRule>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    LatestVersionNumber int
    Latest synchronization configuration version number.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    FileSystemId string
    File system ID. Changing this value forces replacement.
    ExpirationDataRules []FilesSynchronizationConfigurationExpirationDataRuleArgs
    Expiration data rule configuration. See expirationDataRule below.
    ImportDataRules []FilesSynchronizationConfigurationImportDataRuleArgs

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    LatestVersionNumber int
    Latest synchronization configuration version number.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    fileSystemId String
    File system ID. Changing this value forces replacement.
    expirationDataRules List<FilesSynchronizationConfigurationExpirationDataRule>
    Expiration data rule configuration. See expirationDataRule below.
    importDataRules List<FilesSynchronizationConfigurationImportDataRule>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber Integer
    Latest synchronization configuration version number.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    fileSystemId string
    File system ID. Changing this value forces replacement.
    expirationDataRules FilesSynchronizationConfigurationExpirationDataRule[]
    Expiration data rule configuration. See expirationDataRule below.
    importDataRules FilesSynchronizationConfigurationImportDataRule[]

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber number
    Latest synchronization configuration version number.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    file_system_id str
    File system ID. Changing this value forces replacement.
    expiration_data_rules Sequence[FilesSynchronizationConfigurationExpirationDataRuleArgs]
    Expiration data rule configuration. See expirationDataRule below.
    import_data_rules Sequence[FilesSynchronizationConfigurationImportDataRuleArgs]

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latest_version_number int
    Latest synchronization configuration version number.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    fileSystemId String
    File system ID. Changing this value forces replacement.
    expirationDataRules List<Property Map>
    Expiration data rule configuration. See expirationDataRule below.
    importDataRules List<Property Map>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber Number
    Latest synchronization configuration version number.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FilesSynchronizationConfiguration Resource

    Get an existing FilesSynchronizationConfiguration 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?: FilesSynchronizationConfigurationState, opts?: CustomResourceOptions): FilesSynchronizationConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        expiration_data_rules: Optional[Sequence[FilesSynchronizationConfigurationExpirationDataRuleArgs]] = None,
        file_system_id: Optional[str] = None,
        import_data_rules: Optional[Sequence[FilesSynchronizationConfigurationImportDataRuleArgs]] = None,
        latest_version_number: Optional[int] = None,
        region: Optional[str] = None) -> FilesSynchronizationConfiguration
    func GetFilesSynchronizationConfiguration(ctx *Context, name string, id IDInput, state *FilesSynchronizationConfigurationState, opts ...ResourceOption) (*FilesSynchronizationConfiguration, error)
    public static FilesSynchronizationConfiguration Get(string name, Input<string> id, FilesSynchronizationConfigurationState? state, CustomResourceOptions? opts = null)
    public static FilesSynchronizationConfiguration get(String name, Output<String> id, FilesSynchronizationConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: aws:s3:FilesSynchronizationConfiguration    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.
    The following state arguments are supported:
    ExpirationDataRules List<FilesSynchronizationConfigurationExpirationDataRule>
    Expiration data rule configuration. See expirationDataRule below.
    FileSystemId string
    File system ID. Changing this value forces replacement.
    ImportDataRules List<FilesSynchronizationConfigurationImportDataRule>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    LatestVersionNumber int
    Latest synchronization configuration version number.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    ExpirationDataRules []FilesSynchronizationConfigurationExpirationDataRuleArgs
    Expiration data rule configuration. See expirationDataRule below.
    FileSystemId string
    File system ID. Changing this value forces replacement.
    ImportDataRules []FilesSynchronizationConfigurationImportDataRuleArgs

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    LatestVersionNumber int
    Latest synchronization configuration version number.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    expirationDataRules List<FilesSynchronizationConfigurationExpirationDataRule>
    Expiration data rule configuration. See expirationDataRule below.
    fileSystemId String
    File system ID. Changing this value forces replacement.
    importDataRules List<FilesSynchronizationConfigurationImportDataRule>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber Integer
    Latest synchronization configuration version number.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    expirationDataRules FilesSynchronizationConfigurationExpirationDataRule[]
    Expiration data rule configuration. See expirationDataRule below.
    fileSystemId string
    File system ID. Changing this value forces replacement.
    importDataRules FilesSynchronizationConfigurationImportDataRule[]

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber number
    Latest synchronization configuration version number.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    expiration_data_rules Sequence[FilesSynchronizationConfigurationExpirationDataRuleArgs]
    Expiration data rule configuration. See expirationDataRule below.
    file_system_id str
    File system ID. Changing this value forces replacement.
    import_data_rules Sequence[FilesSynchronizationConfigurationImportDataRuleArgs]

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latest_version_number int
    Latest synchronization configuration version number.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    expirationDataRules List<Property Map>
    Expiration data rule configuration. See expirationDataRule below.
    fileSystemId String
    File system ID. Changing this value forces replacement.
    importDataRules List<Property Map>

    One or more import data rules. See importDataRule below.

    The following arguments are optional:

    latestVersionNumber Number
    Latest synchronization configuration version number.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.

    Supporting Types

    FilesSynchronizationConfigurationExpirationDataRule, FilesSynchronizationConfigurationExpirationDataRuleArgs

    DaysAfterLastAccess int
    Number of days after last access before expiring data.
    DaysAfterLastAccess int
    Number of days after last access before expiring data.
    daysAfterLastAccess Integer
    Number of days after last access before expiring data.
    daysAfterLastAccess number
    Number of days after last access before expiring data.
    days_after_last_access int
    Number of days after last access before expiring data.
    daysAfterLastAccess Number
    Number of days after last access before expiring data.

    FilesSynchronizationConfigurationImportDataRule, FilesSynchronizationConfigurationImportDataRuleArgs

    Prefix string
    S3 key prefix to apply this rule to. Use "" for all objects.
    SizeLessThan int
    Maximum object size in bytes to import.
    Trigger string
    Import trigger. Valid values: ON_FILE_ACCESS.
    Prefix string
    S3 key prefix to apply this rule to. Use "" for all objects.
    SizeLessThan int
    Maximum object size in bytes to import.
    Trigger string
    Import trigger. Valid values: ON_FILE_ACCESS.
    prefix String
    S3 key prefix to apply this rule to. Use "" for all objects.
    sizeLessThan Integer
    Maximum object size in bytes to import.
    trigger String
    Import trigger. Valid values: ON_FILE_ACCESS.
    prefix string
    S3 key prefix to apply this rule to. Use "" for all objects.
    sizeLessThan number
    Maximum object size in bytes to import.
    trigger string
    Import trigger. Valid values: ON_FILE_ACCESS.
    prefix str
    S3 key prefix to apply this rule to. Use "" for all objects.
    size_less_than int
    Maximum object size in bytes to import.
    trigger str
    Import trigger. Valid values: ON_FILE_ACCESS.
    prefix String
    S3 key prefix to apply this rule to. Use "" for all objects.
    sizeLessThan Number
    Maximum object size in bytes to import.
    trigger String
    Import trigger. Valid values: ON_FILE_ACCESS.

    Import

    Identity Schema

    Required

    • fileSystemId - File system ID.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import S3 Files Synchronization using fileSystemId. For example:

    $ pulumi import aws:s3/filesSynchronizationConfiguration:FilesSynchronizationConfiguration 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 aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.26.0
    published on Thursday, Apr 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.