Class: Aws::FSx::Types::FileCache

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-fsx/types.rb

Overview

A description of a specific Amazon File Cache resource, which is a response object from the ‘DescribeFileCaches` operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Returns:

  • (Time)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_association_idsArray<String>

A list of IDs of data repository associations that are associated with this cache.

Returns:

  • (Array<String>)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#dns_nameString

The Domain Name System (DNS) name for the cache.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#failure_detailsTypes::FileCacheFailureDetails

A structure providing details of any failures that occurred.



5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_idString

The system-generated, unique ID of the cache.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_typeString

The type of cache, which must be ‘LUSTRE`.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_type_versionString

The Lustre version of the cache, which must be ‘2.12`.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a ‘KmsKeyId` isn’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*.

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleString

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.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configurationTypes::FileCacheLustreConfiguration

The configuration for the Amazon File Cache resource.



5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_idsArray<String>

A list of network interface IDs.

Returns:

  • (Array<String>)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#owner_idString

An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacityInteger

The storage capacity of the cache in gibibytes (GiB).

Returns:

  • (Integer)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<String>

A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the ‘CreateFileCache` operation.

Returns:

  • (Array<String>)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The ID of your virtual private cloud (VPC). For more information, see [VPC and subnets] in the *Amazon VPC User Guide*.

[1]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html

Returns:

  • (String)


5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
# File 'lib/aws-sdk-fsx/types.rb', line 5522

class FileCache < Struct.new(
  :owner_id,
  :creation_time,
  :file_cache_id,
  :file_cache_type,
  :file_cache_type_version,
  :lifecycle,
  :failure_details,
  :storage_capacity,
  :vpc_id,
  :subnet_ids,
  :network_interface_ids,
  :dns_name,
  :kms_key_id,
  :resource_arn,
  :lustre_configuration,
  :data_repository_association_ids)
  SENSITIVE = []
  include Aws::Structure
end