MountTarget
s3files.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | s3files-controller/apis/v1alpha1#MountTarget |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | MountTarget |
| ListKind | MountTargetList |
| Plural | mounttargets |
| Singular | mounttarget |
Spec
fileSystemID: string
fileSystemRef:
from:
name: string
namespace: string
ipAddressType: string
ipv4Address: string
ipv6Address: string
securityGroupRefs:
from:
name: string
namespace: string
securityGroups:
- string
subnetID: string
subnetRef:
from:
name: string
namespace: string
| Field | Description |
|---|---|
| fileSystemID Optional | string The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for. 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 |
| ipAddressType Optional | string The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type must match the IP configuration of the specified subnet. |
| ipv4Address Optional | string A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet’s available IPv4 address range. The address must be within the subnet’s CIDR block and not already in use. Regex Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ |
| ipv6Address Optional | string A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet’s available IPv6 address range. The address must be within the subnet’s IPv6 CIDR block and not already in use. |
| securityGroupRefs Optional | array |
| securityGroupRefs.[] Required | 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 || **securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| securityGroupRefs.[].from.name
Optional | string
|
| securityGroupRefs.[].from.namespace
Optional | string
|
| securityGroups
Optional | array
An array of VPC security group IDs to associate with the mount target’s network
interface. These security groups control network access to the mount target.
If not specified, the default security group for the subnet’s VPC is used.
All security groups must belong to the same VPC as the subnet. |
| securityGroups.[]
Required | string
|| subnetID
Optional | string
The ID of the subnet where the mount target will be created. The subnet must
be in the same Amazon Web Services Region as the file system. For file systems
with regional availability, you can create mount targets in any subnet within
the Region. The subnet determines the Availability Zone where the mount target
will be located.
Regex Pattern: ^subnet-[0-9a-f]{8,40}$ |
| subnetRef
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 |
| subnetRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| subnetRef.from.name
Optional | string
|
| subnetRef.from.namespace
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
availabilityZoneID: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
id: string
networkInterfaceID: string
ownerID: string
status: string
statusMessage: string
vpcID: 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. |
| availabilityZoneID Optional | string The unique and consistent identifier of the Availability Zone where the mount target is located. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account. |
| 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 mount target, assigned by S3 Files. This ID is used to reference the mount target in subsequent API calls. Regex Pattern: ^fsmt-[0-9a-f]{17,40}$ |
| networkInterfaceID Optional | string The ID of the network interface that S3 Files created when it created the mount target. This network interface is managed by the service. |
| ownerID Optional | string The Amazon Web Services account ID of the mount target owner. Regex Pattern: `^(\d{12}) |
| status Optional | string The lifecycle state of the mount target. Valid values are: AVAILABLE (the mount target is available for use), CREATING (the mount target is being created), DELETING (the mount target is being deleted), DELETED (the mount target has been deleted), or ERROR (the mount target is in an error state), or UPDATING (the mount target is being updated). |
| statusMessage Optional | string Additional information about the mount target status. This field provides more details when the status is ERROR, or during state transitions. |
| vpcID Optional | string The ID of the VPC where the mount target is located. |