FileSystem
s3files.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | s3files-controller/apis/v1alpha1#FileSystem |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | FileSystem |
| ListKind | FileSystemList |
| Plural | filesystems |
| Singular | filesystem |
Spec
acceptBucketWarning: boolean
bucket: string
bucketRef:
from:
name: string
namespace: string
expirationDataRules:
- daysAfterLastAccess: integer
importDataRules:
- prefix: string
sizeLessThan: integer
trigger: string
kmsKeyID: string
kmsKeyRef:
from:
name: string
namespace: string
policy: string
prefix: string
roleARN: string
roleRef:
from:
name: string
namespace: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| acceptBucketWarning Optional | boolean Set to true to acknowledge and accept any warnings about the bucket configuration. If not specified, the operation may fail if there are bucket configuration warnings. |
| bucket Optional | string The Amazon Resource Name (ARN) of the S3 bucket that will be accessible through the file system. The bucket must exist and be in the same Amazon Web Services Region as the file system. Regex Pattern: ^(arn:aws[a-zA-Z0-9-]*:s3:::.+)$ |
| bucketRef 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 |
| bucketRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| bucketRef.from.name Optional | string |
| bucketRef.from.namespace Optional | string |
| expirationDataRules Optional | array An array of expiration data rules that control when cached data expires from the file system. |
| expirationDataRules.[] Required | object Specifies a rule that controls when cached data expires from the file system |
| based on last access time. | |
| importDataRules Optional | array An array of import data rules that control how data is imported from S3 into the file system. |
| importDataRules.[] Required | object Specifies a rule that controls how data is imported from S3 into the file |
| system. | |
| importDataRules.[].sizeLessThan Optional | integer |
| importDataRules.[].trigger Optional | string |
| kmsKeyID Optional | string The ARN, key ID, or alias of the KMS key to use for encryption. If not specified, the service uses a service-owned key for encryption. You can specify a KMS key using the following formats: key ID, ARN, key alias, or key alias ARN. If you use KmsKeyId, the file system will be encrypted. Regex Pattern: `^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} |
| kmsKeyRef 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 |
| kmsKeyRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| kmsKeyRef.from.name Optional | string |
| kmsKeyRef.from.namespace Optional | string |
| policy Optional | string The JSON-formatted resource policy to apply to the file system. The policy defines the permissions for accessing the file system. The policy must be a valid JSON document that follows IAM policy syntax. |
| prefix Optional | string An optional prefix within the S3 bucket to scope the file system access. If specified, the file system provides access only to objects with keys that begin with this prefix. If not specified, the file system provides access to the entire bucket. |
| roleARN Optional | string The ARN of the IAM role that grants the S3 Files service permission to read and write data between the file system and the S3 bucket. This role must have the necessary permissions to access the specified bucket and prefix. Regex Pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ |
| roleRef 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 |
| roleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| roleRef.from.name Optional | string |
| roleRef.from.namespace Optional | string |
| tags Optional | array An array of key-value pairs to apply as tags to the file system resource. Each tag is a user-defined key-value pair. You can use tags to categorize and manage your file systems. Each key must be unique for the resource. |
| 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
creationTime: string
fileSystemID: string
latestVersionNumber: integer
name: string
ownerID: string
status: string
statusMessage: 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 |
| creationTime Optional | string The time when the file system was created, in seconds since 1970-01-01T00:00:00Z (Unix epoch time). |
| fileSystemID Optional | string The ID of the file system, assigned by S3 Files. This ID is used to reference the file system in subsequent API calls. Regex Pattern: `^(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40} |
| latestVersionNumber Optional | integer The version number of the synchronization configuration. Use this value with PutSynchronizationConfiguration to ensure optimistic concurrency control. |
| name Optional | string The name of the file system, derived from the Name tag if present. Regex Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ |
| ownerID Optional | string The Amazon Web Services account ID of the file system owner. Regex Pattern: `^(\d{12}) |
| status Optional | string The lifecycle state of the file system. Valid values are: AVAILABLE (the file system is available for use), CREATING (the file system is being created), DELETING (the file system is being deleted), DELETED (the file system has been deleted), ERROR (the file system is in an error state), or UPDATING (the file system is being updated). |
| statusMessage Optional | string Additional information about the file system status. This field provides more details when the status is ERROR, or during state transitions. |