aws-native logo
AWS Native v0.54.0, Mar 21 23

aws-native.fsx.DataRepositoryAssociation

Resource Type definition for AWS::FSx::DataRepositoryAssociation

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var fsId = config.Require("fsId");
    var draIdExportName = config.Require("draIdExportName");
    var fileSystemPath = config.Require("fileSystemPath");
    var importedFileChunkSize = config.Require("importedFileChunkSize");
    var testDRA = new AwsNative.FSx.DataRepositoryAssociation("testDRA", new()
    {
        FileSystemId = fsId,
        FileSystemPath = fileSystemPath,
        DataRepositoryPath = "s3://example-bucket",
        BatchImportMetaDataOnCreate = true,
        ImportedFileChunkSize = importedFileChunkSize,
        S3 = new AwsNative.FSx.Inputs.DataRepositoryAssociationS3Args
        {
            AutoImportPolicy = new AwsNative.FSx.Inputs.DataRepositoryAssociationAutoImportPolicyArgs
            {
                Events = new[]
                {
                    AwsNative.FSx.DataRepositoryAssociationEventType.New,
                    AwsNative.FSx.DataRepositoryAssociationEventType.Changed,
                    AwsNative.FSx.DataRepositoryAssociationEventType.Deleted,
                },
            },
            AutoExportPolicy = new AwsNative.FSx.Inputs.DataRepositoryAssociationAutoExportPolicyArgs
            {
                Events = new[]
                {
                    AwsNative.FSx.DataRepositoryAssociationEventType.New,
                    AwsNative.FSx.DataRepositoryAssociationEventType.Changed,
                    AwsNative.FSx.DataRepositoryAssociationEventType.Deleted,
                },
            },
        },
        Tags = new[]
        {
            new AwsNative.FSx.Inputs.DataRepositoryAssociationTagArgs
            {
                Key = "Location",
                Value = "Boston",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["draId"] = testDRA.Id,
    };
});
package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		fsId := cfg.Require("fsId")
		draIdExportName := cfg.Require("draIdExportName")
		fileSystemPath := cfg.Require("fileSystemPath")
		importedFileChunkSize := cfg.Require("importedFileChunkSize")
		testDRA, err := fsx.NewDataRepositoryAssociation(ctx, "testDRA", &fsx.DataRepositoryAssociationArgs{
			FileSystemId:                pulumi.String(fsId),
			FileSystemPath:              pulumi.String(fileSystemPath),
			DataRepositoryPath:          pulumi.String("s3://example-bucket"),
			BatchImportMetaDataOnCreate: pulumi.Bool(true),
			ImportedFileChunkSize:       pulumi.String(importedFileChunkSize),
			S3: &fsx.DataRepositoryAssociationS3Args{
				AutoImportPolicy: &fsx.DataRepositoryAssociationAutoImportPolicyArgs{
					Events: fsx.DataRepositoryAssociationEventTypeArray{
						fsx.DataRepositoryAssociationEventTypeNew,
						fsx.DataRepositoryAssociationEventTypeChanged,
						fsx.DataRepositoryAssociationEventTypeDeleted,
					},
				},
				AutoExportPolicy: &fsx.DataRepositoryAssociationAutoExportPolicyArgs{
					Events: fsx.DataRepositoryAssociationEventTypeArray{
						fsx.DataRepositoryAssociationEventTypeNew,
						fsx.DataRepositoryAssociationEventTypeChanged,
						fsx.DataRepositoryAssociationEventTypeDeleted,
					},
				},
			},
			Tags: []fsx.DataRepositoryAssociationTagArgs{
				{
					Key:   pulumi.String("Location"),
					Value: pulumi.String("Boston"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("draId", testDRA.ID())
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
fs_id = config.require("fsId")
dra_id_export_name = config.require("draIdExportName")
file_system_path = config.require("fileSystemPath")
imported_file_chunk_size = config.require("importedFileChunkSize")
test_dra = aws_native.fsx.DataRepositoryAssociation("testDRA",
    file_system_id=fs_id,
    file_system_path=file_system_path,
    data_repository_path="s3://example-bucket",
    batch_import_meta_data_on_create=True,
    imported_file_chunk_size=imported_file_chunk_size,
    s3=aws_native.fsx.DataRepositoryAssociationS3Args(
        auto_import_policy=aws_native.fsx.DataRepositoryAssociationAutoImportPolicyArgs(
            events=[
                aws_native.fsx.DataRepositoryAssociationEventType.NEW,
                aws_native.fsx.DataRepositoryAssociationEventType.CHANGED,
                aws_native.fsx.DataRepositoryAssociationEventType.DELETED,
            ],
        ),
        auto_export_policy=aws_native.fsx.DataRepositoryAssociationAutoExportPolicyArgs(
            events=[
                aws_native.fsx.DataRepositoryAssociationEventType.NEW,
                aws_native.fsx.DataRepositoryAssociationEventType.CHANGED,
                aws_native.fsx.DataRepositoryAssociationEventType.DELETED,
            ],
        ),
    ),
    tags=[aws_native.fsx.DataRepositoryAssociationTagArgs(
        key="Location",
        value="Boston",
    )])
pulumi.export("draId", test_dra.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const fsId = config.require("fsId");
const draIdExportName = config.require("draIdExportName");
const fileSystemPath = config.require("fileSystemPath");
const importedFileChunkSize = config.require("importedFileChunkSize");
const testDRA = new aws_native.fsx.DataRepositoryAssociation("testDRA", {
    fileSystemId: fsId,
    fileSystemPath: fileSystemPath,
    dataRepositoryPath: "s3://example-bucket",
    batchImportMetaDataOnCreate: true,
    importedFileChunkSize: importedFileChunkSize,
    s3: {
        autoImportPolicy: {
            events: [
                aws_native.fsx.DataRepositoryAssociationEventType.New,
                aws_native.fsx.DataRepositoryAssociationEventType.Changed,
                aws_native.fsx.DataRepositoryAssociationEventType.Deleted,
            ],
        },
        autoExportPolicy: {
            events: [
                aws_native.fsx.DataRepositoryAssociationEventType.New,
                aws_native.fsx.DataRepositoryAssociationEventType.Changed,
                aws_native.fsx.DataRepositoryAssociationEventType.Deleted,
            ],
        },
    },
    tags: [{
        key: "Location",
        value: "Boston",
    }],
});
export const draId = testDRA.id;

Coming soon!

Create DataRepositoryAssociation Resource

new DataRepositoryAssociation(name: string, args: DataRepositoryAssociationArgs, opts?: CustomResourceOptions);
@overload
def DataRepositoryAssociation(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              batch_import_meta_data_on_create: Optional[bool] = None,
                              data_repository_path: Optional[str] = None,
                              file_system_id: Optional[str] = None,
                              file_system_path: Optional[str] = None,
                              imported_file_chunk_size: Optional[int] = None,
                              s3: Optional[DataRepositoryAssociationS3Args] = None,
                              tags: Optional[Sequence[DataRepositoryAssociationTagArgs]] = None)
@overload
def DataRepositoryAssociation(resource_name: str,
                              args: DataRepositoryAssociationArgs,
                              opts: Optional[ResourceOptions] = None)
func NewDataRepositoryAssociation(ctx *Context, name string, args DataRepositoryAssociationArgs, opts ...ResourceOption) (*DataRepositoryAssociation, error)
public DataRepositoryAssociation(string name, DataRepositoryAssociationArgs args, CustomResourceOptions? opts = null)
public DataRepositoryAssociation(String name, DataRepositoryAssociationArgs args)
public DataRepositoryAssociation(String name, DataRepositoryAssociationArgs args, CustomResourceOptions options)
type: aws-native:fsx:DataRepositoryAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

DataRepositoryPath string

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

FileSystemId string

The globally unique ID of the file system, assigned by Amazon FSx.

FileSystemPath string

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

BatchImportMetaDataOnCreate bool

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

ImportedFileChunkSize int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

S3 Pulumi.AwsNative.FSx.Inputs.DataRepositoryAssociationS3Args

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

Tags List<Pulumi.AwsNative.FSx.Inputs.DataRepositoryAssociationTagArgs>

A list of Tag values, with a maximum of 50 elements.

DataRepositoryPath string

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

FileSystemId string

The globally unique ID of the file system, assigned by Amazon FSx.

FileSystemPath string

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

BatchImportMetaDataOnCreate bool

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

ImportedFileChunkSize int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

S3 DataRepositoryAssociationS3Args

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

Tags []DataRepositoryAssociationTagArgs

A list of Tag values, with a maximum of 50 elements.

dataRepositoryPath String

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

fileSystemId String

The globally unique ID of the file system, assigned by Amazon FSx.

fileSystemPath String

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

batchImportMetaDataOnCreate Boolean

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

importedFileChunkSize Integer

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

s3 DataRepositoryAssociationS3Args

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

tags List<DataRepositoryAssociationTagArgs>

A list of Tag values, with a maximum of 50 elements.

dataRepositoryPath string

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

fileSystemId string

The globally unique ID of the file system, assigned by Amazon FSx.

fileSystemPath string

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

batchImportMetaDataOnCreate boolean

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

importedFileChunkSize number

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

s3 DataRepositoryAssociationS3Args

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

tags DataRepositoryAssociationTagArgs[]

A list of Tag values, with a maximum of 50 elements.

data_repository_path str

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

file_system_id str

The globally unique ID of the file system, assigned by Amazon FSx.

file_system_path str

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

batch_import_meta_data_on_create bool

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

imported_file_chunk_size int

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

s3 DataRepositoryAssociationS3Args

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

tags Sequence[DataRepositoryAssociationTagArgs]

A list of Tag values, with a maximum of 50 elements.

dataRepositoryPath String

The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/ . This path specifies where in the S3 data repository files will be imported from or exported to.

fileSystemId String

The globally unique ID of the file system, assigned by Amazon FSx.

fileSystemPath String

This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

batchImportMetaDataOnCreate Boolean

A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

importedFileChunkSize Number

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

s3 Property Map

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

tags List<Property Map>

A list of Tag values, with a maximum of 50 elements.

Outputs

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

AssociationId string

The system-generated, unique ID of the data repository association.

Id string

The provider-assigned unique ID for this managed resource.

ResourceARN string

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

AssociationId string

The system-generated, unique ID of the data repository association.

Id string

The provider-assigned unique ID for this managed resource.

ResourceARN string

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

associationId String

The system-generated, unique ID of the data repository association.

id String

The provider-assigned unique ID for this managed resource.

resourceARN String

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

associationId string

The system-generated, unique ID of the data repository association.

id string

The provider-assigned unique ID for this managed resource.

resourceARN string

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

association_id str

The system-generated, unique ID of the data repository association.

id str

The provider-assigned unique ID for this managed resource.

resource_arn str

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

associationId String

The system-generated, unique ID of the data repository association.

id String

The provider-assigned unique ID for this managed resource.

resourceARN String

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Supporting Types

DataRepositoryAssociationAutoExportPolicy

DataRepositoryAssociationAutoImportPolicy

DataRepositoryAssociationEventType

New
NEW
Changed
CHANGED
Deleted
DELETED
DataRepositoryAssociationEventTypeNew
NEW
DataRepositoryAssociationEventTypeChanged
CHANGED
DataRepositoryAssociationEventTypeDeleted
DELETED
New
NEW
Changed
CHANGED
Deleted
DELETED
New
NEW
Changed
CHANGED
Deleted
DELETED
NEW
NEW
CHANGED
CHANGED
DELETED
DELETED
"NEW"
NEW
"CHANGED"
CHANGED
"DELETED"
DELETED

DataRepositoryAssociationS3

DataRepositoryAssociationTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0