AccessPoint
s3files.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | s3files-controller/apis/v1alpha1#AccessPoint |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | AccessPoint |
| ListKind | AccessPointList |
| Plural | accesspoints |
| Singular | accesspoint |
Spec
fileSystemID: string
fileSystemRef:
from:
name: string
namespace: string
posixUser:
gid: integer
secondaryGIDs:
- integer
uid: integer
rootDirectory:
creationPermissions:
ownerGID: integer
ownerUID: integer
permissions: string
path: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| fileSystemID Optional | string The ID or Amazon Resource Name (ARN) of the S3 File System. Regex Pattern: `^(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40} |
| fileSystemRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| fileSystemRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| fileSystemRef.from.name Optional | string |
| fileSystemRef.from.namespace Optional | string |
| posixUser Optional | object The POSIX identity with uid, gid, and secondary group IDs for user enforcement when accessing the file system through this access point. |
| posixUser.gid Optional | integer |
| posixUser.secondaryGIDs Optional | array |
| posixUser.secondaryGIDs.[] Required | integer |
| rootDirectory Optional | object The root directory path for the access point, with optional creation permissions for newly created directories. |
| rootDirectory.creationPermissions Optional | object Specifies the permissions to set on newly created directories within the file system. |
| rootDirectory.creationPermissions.ownerGID Optional | integer |
| rootDirectory.creationPermissions.ownerUID Optional | integer |
| rootDirectory.creationPermissions.permissions Optional | string |
| rootDirectory.path Optional | string |
| tags Optional | array An array of key-value pairs to apply to the access point for resource tagging. |
| tags.[] Required | object A key-value pair for resource tagging. |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
id: string
name: string
ownerID: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| id Optional | string The ID of the access point. Regex Pattern: `^(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}/access-point/fsap-[0-9a-f]{17,40} |
| name Optional | string The name of the access point. Regex Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ |
| ownerID Optional | string The Amazon Web Services account ID of the access point owner. Regex Pattern: `^(\d{12}) |
| status Optional | string The current status of the access point. |