FilesSynchronizationConfiguration class

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", {
    expirationDataRules: [{
        daysAfterLastAccess: 30,
    }],
    importDataRules: [{
        prefix: "",
        sizeLessThan: 52673613135872,
        trigger: "ON_FILE_ACCESS",
    }],
    fileSystemId: exampleAwsS3filesFileSystem.id,
});
import pulumi
import pulumi_aws as aws

example = aws.s3.FilesSynchronizationConfiguration("example",
    expiration_data_rules=[{
        "days_after_last_access": 30,
    }],
    import_data_rules=[{
        "prefix": "",
        "size_less_than": int(52673613135872),
        "trigger": "ON_FILE_ACCESS",
    }],
    file_system_id=example_aws_s3files_file_system["id"])
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()
    {
        ExpirationDataRules = new[]
        {
            new Aws.S3.Inputs.FilesSynchronizationConfigurationExpirationDataRuleArgs
            {
                DaysAfterLastAccess = 30,
            },
        },
        ImportDataRules = new[]
        {
            new Aws.S3.Inputs.FilesSynchronizationConfigurationImportDataRuleArgs
            {
                Prefix = "",
                SizeLessThan = 52673613135872,
                Trigger = "ON_FILE_ACCESS",
            },
        },
        FileSystemId = exampleAwsS3filesFileSystem.Id,
    });

});
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{
			ExpirationDataRules: s3.FilesSynchronizationConfigurationExpirationDataRuleArray{
				&s3.FilesSynchronizationConfigurationExpirationDataRuleArgs{
					DaysAfterLastAccess: pulumi.Int(30),
				},
			},
			ImportDataRules: s3.FilesSynchronizationConfigurationImportDataRuleArray{
				&s3.FilesSynchronizationConfigurationImportDataRuleArgs{
					Prefix:       pulumi.String(""),
					SizeLessThan: pulumi.Int(52673613135872),
					Trigger:      pulumi.String("ON_FILE_ACCESS"),
				},
			},
			FileSystemId: pulumi.Any(exampleAwsS3filesFileSystem.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_filessynchronizationconfiguration" "example" {
  expiration_data_rules {
    days_after_last_access = 30
  }
  import_data_rules {
    prefix         = ""
    size_less_than = 52673613135872
    trigger        = "ON_FILE_ACCESS"
  }
  file_system_id = exampleAwsS3filesFileSystem.id
}
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.FilesSynchronizationConfigurationExpirationDataRuleArgs;
import com.pulumi.aws.s3.inputs.FilesSynchronizationConfigurationImportDataRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .expirationDataRules(FilesSynchronizationConfigurationExpirationDataRuleArgs.builder()
                .daysAfterLastAccess(30)
                .build())
            .importDataRules(FilesSynchronizationConfigurationImportDataRuleArgs.builder()
                .prefix("")
                .sizeLessThan(52673613135872)
                .trigger("ON_FILE_ACCESS")
                .build())
            .fileSystemId(exampleAwsS3filesFileSystem.id())
            .build());

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

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

Constructors

FilesSynchronizationConfiguration(String name, {FilesSynchronizationConfigurationArgs? args, CustomResourceOptions? options})
Creates a new FilesSynchronizationConfiguration. name The Pulumi resource name. args Arguments used to configure this FilesSynchronizationConfiguration. The set of arguments for FilesSynchronizationConfiguration. options Resource options controlling this resource's behavior.
FilesSynchronizationConfiguration.reference(String urn)
Creates a typed reference to an existing FilesSynchronizationConfiguration resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
expirationDataRules ↔ Output<List<FilesSynchronizationConfigurationExpirationDataRule>?>
Expiration data rule configuration. See expirationDataRule below.
latefinal
fileSystemId ↔ Output<String>
File system ID. Changing this value forces replacement.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
importDataRules ↔ Output<List<FilesSynchronizationConfigurationImportDataRule>?>
One or more import data rules. See importDataRule below.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
latestVersionNumber ↔ Output<int>
Latest synchronization configuration version number.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {FilesSynchronizationConfigurationState? state, CustomResourceOptions? options}) → FilesSynchronizationConfiguration
Gets an existing FilesSynchronizationConfiguration resource's state with the given name and id.