FilesFileSystem class
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"])
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 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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_filesfilesystem" "example" {
bucket = exampleAwsS3Bucket.arn
role_arn = 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.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 FilesFileSystem("example", FilesFileSystemArgs.builder()
.bucket(exampleAwsS3Bucket.arn())
.roleArn(exampleAwsIamRole.arn())
.build());
}
}
resources:
example:
type: aws:s3:FilesFileSystem
properties:
bucket: ${exampleAwsS3Bucket.arn}
roleArn: ${exampleAwsIamRole.arn}
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
Constructors
- FilesFileSystem(String name, {FilesFileSystemArgs? args, CustomResourceOptions? options})
-
Creates a new FilesFileSystem.
nameThe Pulumi resource name.argsArguments used to configure this FilesFileSystem. The set of arguments for FilesFileSystem.optionsResource options controlling this resource's behavior. - FilesFileSystem.reference(String urn)
- Creates a typed reference to an existing FilesFileSystem resource.
Properties
-
acceptBucketWarning
↔ Output<
bool?> -
Set to
trueto acknowledge and accept any warnings related to the bucket configuration. If not specified, the operation may fail when such warnings are present. For example, warnings may be raised when creating a file system scoped to a prefix containing a large number of objects (approximately 12 million objects). See the AWS documentation for more details.latefinal -
arn
↔ Output<
String> -
ARN of the file system.
latefinal
-
bucket
↔ Output<
String> -
S3 bucket ARN. Changing this value forces replacement.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
creationTime
↔ Output<
String> -
Creation time.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
kmsKeyId
↔ Output<
String> -
KMS key ID for encryption. Changing this value forces replacement.
latefinal
-
name
↔ Output<
String> -
File system name.
latefinal
-
ownerId
↔ Output<
String> -
AWS account ID of the owner.
latefinal
-
prefix
↔ Output<
String?> -
S3 bucket prefix. Changing this value forces replacement.
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
-
roleArn
↔ Output<
String> -
IAM role ARN for S3 access. Changing this value forces replacement.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
status
↔ Output<
String> -
File system status.
latefinal
-
statusMessage
↔ Output<
String> -
Status message.
latefinal
-
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.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
FilesFileSystemTimeouts?> -
latefinal
-
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, {FilesFileSystemState? state, CustomResourceOptions? options}) → FilesFileSystem -
Gets an existing FilesFileSystem resource's state with the given
nameandid.