AWS Native

Pulumi Official
Package maintained by Pulumi
v0.17.0 published on Monday, May 23, 2022 by Pulumi

AccessPoint

Resource Type definition for AWS::EFS::AccessPoint

Create a AccessPoint Resource

new AccessPoint(name: string, args: AccessPointArgs, opts?: CustomResourceOptions);
@overload
def AccessPoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                access_point_tags: Optional[Sequence[AccessPointTagArgs]] = None,
                client_token: Optional[str] = None,
                file_system_id: Optional[str] = None,
                posix_user: Optional[AccessPointPosixUserArgs] = None,
                root_directory: Optional[AccessPointRootDirectoryArgs] = None)
@overload
def AccessPoint(resource_name: str,
                args: AccessPointArgs,
                opts: Optional[ResourceOptions] = None)
func NewAccessPoint(ctx *Context, name string, args AccessPointArgs, opts ...ResourceOption) (*AccessPoint, error)
public AccessPoint(string name, AccessPointArgs args, CustomResourceOptions? opts = null)
public AccessPoint(String name, AccessPointArgs args)
public AccessPoint(String name, AccessPointArgs args, CustomResourceOptions options)
type: aws-native:efs:AccessPoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

FileSystemId string

The ID of the EFS file system that the access point provides access to.

AccessPointTags List<Pulumi.AwsNative.EFS.Inputs.AccessPointTagArgs>
ClientToken string

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

PosixUser Pulumi.AwsNative.EFS.Inputs.AccessPointPosixUserArgs

The operating system user and group applied to all file system requests made using the access point.

RootDirectory Pulumi.AwsNative.EFS.Inputs.AccessPointRootDirectoryArgs

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

FileSystemId string

The ID of the EFS file system that the access point provides access to.

AccessPointTags []AccessPointTagArgs
ClientToken string

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

PosixUser AccessPointPosixUserArgs

The operating system user and group applied to all file system requests made using the access point.

RootDirectory AccessPointRootDirectoryArgs

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

fileSystemId String

The ID of the EFS file system that the access point provides access to.

accessPointTags ListPointTagArgs>
clientToken String

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

posixUser AccessPointPosixUserArgs

The operating system user and group applied to all file system requests made using the access point.

rootDirectory AccessPointRootDirectoryArgs

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

fileSystemId string

The ID of the EFS file system that the access point provides access to.

accessPointTags AccessPointTagArgs[]
clientToken string

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

posixUser AccessPointPosixUserArgs

The operating system user and group applied to all file system requests made using the access point.

rootDirectory AccessPointRootDirectoryArgs

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

file_system_id str

The ID of the EFS file system that the access point provides access to.

access_point_tags Sequence[AccessPointTagArgs]
client_token str

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

posix_user AccessPointPosixUserArgs

The operating system user and group applied to all file system requests made using the access point.

root_directory AccessPointRootDirectoryArgs

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

fileSystemId String

The ID of the EFS file system that the access point provides access to.

accessPointTags List
clientToken String

(optional) A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

posixUser Property Map

The operating system user and group applied to all file system requests made using the access point.

rootDirectory Property Map

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory>Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

Outputs

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

AccessPointId string
Arn string
Id string

The provider-assigned unique ID for this managed resource.

AccessPointId string
Arn string
Id string

The provider-assigned unique ID for this managed resource.

accessPointId String
arn String
id String

The provider-assigned unique ID for this managed resource.

accessPointId string
arn string
id string

The provider-assigned unique ID for this managed resource.

access_point_id str
arn str
id str

The provider-assigned unique ID for this managed resource.

accessPointId String
arn String
id String

The provider-assigned unique ID for this managed resource.

Supporting Types

AccessPointCreationInfo

OwnerGid string

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

OwnerUid string

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

Permissions string

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

OwnerGid string

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

OwnerUid string

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

Permissions string

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid String

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

ownerUid String

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

permissions String

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid string

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

ownerUid string

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

permissions string

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

owner_gid str

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

owner_uid str

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

permissions str

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid String

Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

ownerUid String

Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).

permissions String

Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

AccessPointPosixUser

Gid string

The POSIX group ID used for all file system operations using this access point.

Uid string

The POSIX user ID used for all file system operations using this access point.

SecondaryGids List<string>

Secondary POSIX group IDs used for all file system operations using this access point.

Gid string

The POSIX group ID used for all file system operations using this access point.

Uid string

The POSIX user ID used for all file system operations using this access point.

SecondaryGids []string

Secondary POSIX group IDs used for all file system operations using this access point.

gid String

The POSIX group ID used for all file system operations using this access point.

uid String

The POSIX user ID used for all file system operations using this access point.

secondaryGids List

Secondary POSIX group IDs used for all file system operations using this access point.

gid string

The POSIX group ID used for all file system operations using this access point.

uid string

The POSIX user ID used for all file system operations using this access point.

secondaryGids string[]

Secondary POSIX group IDs used for all file system operations using this access point.

gid str

The POSIX group ID used for all file system operations using this access point.

uid str

The POSIX user ID used for all file system operations using this access point.

secondary_gids Sequence[str]

Secondary POSIX group IDs used for all file system operations using this access point.

gid String

The POSIX group ID used for all file system operations using this access point.

uid String

The POSIX user ID used for all file system operations using this access point.

secondaryGids List

Secondary POSIX group IDs used for all file system operations using this access point.

AccessPointRootDirectory

CreationInfo Pulumi.AwsNative.EFS.Inputs.AccessPointCreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

Path string

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

CreationInfo AccessPointCreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

Path string

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

creationInfo AccessPointCreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

path String

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

creationInfo AccessPointCreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

path string

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

creation_info AccessPointCreationInfo

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

path str

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

creationInfo Property Map

(Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory>Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory>Path does not exist, attempts to mount the file system using the access point will fail.

path String

Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.

AccessPointTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0