/AWS1/CL_FSXFILECACHE¶
A description of a specific Amazon File Cache resource, which is
a response object from the DescribeFileCaches operation.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_ownerid TYPE /AWS1/FSXAWSACCOUNTID /AWS1/FSXAWSACCOUNTID¶
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
iv_creationtime TYPE /AWS1/FSXCREATIONTIME /AWS1/FSXCREATIONTIME¶
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
iv_filecacheid TYPE /AWS1/FSXFILECACHEID /AWS1/FSXFILECACHEID¶
The system-generated, unique ID of the cache.
iv_filecachetype TYPE /AWS1/FSXFILECACHETYPE /AWS1/FSXFILECACHETYPE¶
The type of cache, which must be
LUSTRE.
iv_filecachetypeversion TYPE /AWS1/FSXFILESYSTEMTYPEVERSION /AWS1/FSXFILESYSTEMTYPEVERSION¶
The Lustre version of the cache, which must be
2.12.
iv_lifecycle TYPE /AWS1/FSXFILECACHELIFECYCLE /AWS1/FSXFILECACHELIFECYCLE¶
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE- The cache is in a healthy state, and is reachable and available for use.
CREATING- The new cache is being created.
DELETING- An existing cache is being deleted.
UPDATING- The cache is undergoing a customer-initiated update.
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
io_failuredetails TYPE REF TO /AWS1/CL_FSXFILECACHEFAILURE00 /AWS1/CL_FSXFILECACHEFAILURE00¶
A structure providing details of any failures that occurred.
iv_storagecapacity TYPE /AWS1/FSXSTORAGECAPACITY /AWS1/FSXSTORAGECAPACITY¶
The storage capacity of the cache in gibibytes (GiB).
iv_vpcid TYPE /AWS1/FSXVPCID /AWS1/FSXVPCID¶
The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
it_subnetids TYPE /AWS1/CL_FSXSUBNETIDS_W=>TT_SUBNETIDS TT_SUBNETIDS¶
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the
CreateFileCacheoperation.
it_networkinterfaceids TYPE /AWS1/CL_FSXNETWORKINTERFACE00=>TT_NETWORKINTERFACEIDS TT_NETWORKINTERFACEIDS¶
A list of network interface IDs.
iv_dnsname TYPE /AWS1/FSXDNSNAME /AWS1/FSXDNSNAME¶
The Domain Name System (DNS) name for the cache.
iv_kmskeyid TYPE /AWS1/FSXKMSKEYID /AWS1/FSXKMSKEYID¶
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyIdisn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
iv_resourcearn TYPE /AWS1/FSXRESOURCEARN /AWS1/FSXRESOURCEARN¶
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
io_lustreconfiguration TYPE REF TO /AWS1/CL_FSXFILECACHELUSTREC00 /AWS1/CL_FSXFILECACHELUSTREC00¶
The configuration for the Amazon File Cache resource.
it_datarepositoryassociati00 TYPE /AWS1/CL_FSXDATAREPOSITORYAS01=>TT_DATAREPOSITORYASSOCIATION00 TT_DATAREPOSITORYASSOCIATION00¶
A list of IDs of data repository associations that are associated with this cache.
Queryable Attributes¶
OwnerId¶
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OWNERID() |
Getter for OWNERID, with configurable default |
ASK_OWNERID() |
Getter for OWNERID w/ exceptions if field has no value |
HAS_OWNERID() |
Determine if OWNERID has a value |
CreationTime¶
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
FileCacheId¶
The system-generated, unique ID of the cache.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILECACHEID() |
Getter for FILECACHEID, with configurable default |
ASK_FILECACHEID() |
Getter for FILECACHEID w/ exceptions if field has no value |
HAS_FILECACHEID() |
Determine if FILECACHEID has a value |
FileCacheType¶
The type of cache, which must be
LUSTRE.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILECACHETYPE() |
Getter for FILECACHETYPE, with configurable default |
ASK_FILECACHETYPE() |
Getter for FILECACHETYPE w/ exceptions if field has no value |
HAS_FILECACHETYPE() |
Determine if FILECACHETYPE has a value |
FileCacheTypeVersion¶
The Lustre version of the cache, which must be
2.12.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILECACHETYPEVERSION() |
Getter for FILECACHETYPEVERSION, with configurable default |
ASK_FILECACHETYPEVERSION() |
Getter for FILECACHETYPEVERSION w/ exceptions if field has n |
HAS_FILECACHETYPEVERSION() |
Determine if FILECACHETYPEVERSION has a value |
Lifecycle¶
The lifecycle status of the cache. The following are the possible values and what they mean:
AVAILABLE- The cache is in a healthy state, and is reachable and available for use.
CREATING- The new cache is being created.
DELETING- An existing cache is being deleted.
UPDATING- The cache is undergoing a customer-initiated update.
FAILED- An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LIFECYCLE() |
Getter for LIFECYCLE, with configurable default |
ASK_LIFECYCLE() |
Getter for LIFECYCLE w/ exceptions if field has no value |
HAS_LIFECYCLE() |
Determine if LIFECYCLE has a value |
FailureDetails¶
A structure providing details of any failures that occurred.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREDETAILS() |
Getter for FAILUREDETAILS |
StorageCapacity¶
The storage capacity of the cache in gibibytes (GiB).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STORAGECAPACITY() |
Getter for STORAGECAPACITY, with configurable default |
ASK_STORAGECAPACITY() |
Getter for STORAGECAPACITY w/ exceptions if field has no val |
HAS_STORAGECAPACITY() |
Determine if STORAGECAPACITY has a value |
VpcId¶
The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCID() |
Getter for VPCID, with configurable default |
ASK_VPCID() |
Getter for VPCID w/ exceptions if field has no value |
HAS_VPCID() |
Determine if VPCID has a value |
SubnetIds¶
A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the
CreateFileCacheoperation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SUBNETIDS() |
Getter for SUBNETIDS, with configurable default |
ASK_SUBNETIDS() |
Getter for SUBNETIDS w/ exceptions if field has no value |
HAS_SUBNETIDS() |
Determine if SUBNETIDS has a value |
NetworkInterfaceIds¶
A list of network interface IDs.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKINTERFACEIDS() |
Getter for NETWORKINTERFACEIDS, with configurable default |
ASK_NETWORKINTERFACEIDS() |
Getter for NETWORKINTERFACEIDS w/ exceptions if field has no |
HAS_NETWORKINTERFACEIDS() |
Determine if NETWORKINTERFACEIDS has a value |
DNSName¶
The Domain Name System (DNS) name for the cache.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DNSNAME() |
Getter for DNSNAME, with configurable default |
ASK_DNSNAME() |
Getter for DNSNAME w/ exceptions if field has no value |
HAS_DNSNAME() |
Determine if DNSNAME has a value |
KmsKeyId¶
Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a
KmsKeyIdisn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYID() |
Getter for KMSKEYID, with configurable default |
ASK_KMSKEYID() |
Getter for KMSKEYID w/ exceptions if field has no value |
HAS_KMSKEYID() |
Determine if KMSKEYID has a value |
ResourceARN¶
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCEARN() |
Getter for RESOURCEARN, with configurable default |
ASK_RESOURCEARN() |
Getter for RESOURCEARN w/ exceptions if field has no value |
HAS_RESOURCEARN() |
Determine if RESOURCEARN has a value |
LustreConfiguration¶
The configuration for the Amazon File Cache resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LUSTRECONFIGURATION() |
Getter for LUSTRECONFIGURATION |
DataRepositoryAssociationIds¶
A list of IDs of data repository associations that are associated with this cache.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATAREPOSITORYASSOCIAT00() |
Getter for DATAREPOSITORYASSOCIATIONIDS, with configurable d |
ASK_DATAREPOSITORYASSOCIAT00() |
Getter for DATAREPOSITORYASSOCIATIONIDS w/ exceptions if fie |
HAS_DATAREPOSITORYASSOCIAT00() |
Determine if DATAREPOSITORYASSOCIATIONIDS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_FILECACHES¶
TYPES TT_FILECACHES TYPE STANDARD TABLE OF REF TO /AWS1/CL_FSXFILECACHE WITH DEFAULT KEY
.