FilesAccessPoint class

Manages an S3 Files Access Point.

Example Usage

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

const example = new aws.s3.FilesAccessPoint("example", {
    posixUsers: [{
        gid: 1001,
        uid: 1001,
    }],
    fileSystemId: exampleAwsS3filesFileSystem.id,
});
import pulumi
import pulumi_aws as aws

example = aws.s3.FilesAccessPoint("example",
    posix_users=[{
        "gid": 1001,
        "uid": 1001,
    }],
    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.FilesAccessPoint("example", new()
    {
        PosixUsers = new[]
        {
            new Aws.S3.Inputs.FilesAccessPointPosixUserArgs
            {
                Gid = 1001,
                Uid = 1001,
            },
        },
        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.NewFilesAccessPoint(ctx, "example", &s3.FilesAccessPointArgs{
			PosixUsers: s3.FilesAccessPointPosixUserArray{
				&s3.FilesAccessPointPosixUserArgs{
					Gid: pulumi.Int(1001),
					Uid: pulumi.Int(1001),
				},
			},
			FileSystemId: pulumi.Any(exampleAwsS3filesFileSystem.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_filesaccesspoint" "example" {
  posix_users {
    gid = 1001
    uid = 1001
  }
  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.FilesAccessPoint;
import com.pulumi.aws.s3.FilesAccessPointArgs;
import com.pulumi.aws.s3.inputs.FilesAccessPointPosixUserArgs;
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 FilesAccessPoint("example", FilesAccessPointArgs.builder()
            .posixUsers(FilesAccessPointPosixUserArgs.builder()
                .gid(1001)
                .uid(1001)
                .build())
            .fileSystemId(exampleAwsS3filesFileSystem.id())
            .build());

    }
}
resources:
  example:
    type: aws:s3:FilesAccessPoint
    properties:
      posixUsers:
        - gid: 1001
          uid: 1001
      fileSystemId: ${exampleAwsS3filesFileSystem.id}

Import

Identity Schema

Required

  • id - Identifier of the access point.

Optional

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

Using pulumi import, import S3 Files Access Point using id. For example:

$ pulumi import aws:s3/filesAccessPoint:FilesAccessPoint example fsap-1234567890abcdef0

Constructors

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

Properties

arn ↔ Output<String>
ARN of the access point.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
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
name ↔ Output<String>
Access point name.
latefinal
ownerId ↔ Output<String>
AWS account ID of the owner.
latefinal
posixUsers ↔ Output<List<FilesAccessPointPosixUser>?>
POSIX user configuration. See posixUser below. 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
rootDirectories ↔ Output<List<FilesAccessPointRootDirectory>?>
Root directory configuration. See rootDirectory below. Changing this value forces replacement.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>
Access point status.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<FilesAccessPointTimeouts?>
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, {FilesAccessPointState? state, CustomResourceOptions? options}) → FilesAccessPoint
Gets an existing FilesAccessPoint resource's state with the given name and id.