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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::FileCache

Defined in:

gems/aws-sdk-fsx/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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

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

• #data_repository_association_ids ⇒ Array<String>

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

• #dns_name ⇒ String

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

• #failure_details ⇒ Types::FileCacheFailureDetails

  A structure providing details of any failures that occurred.

• #file_cache_id ⇒ String

  The system-generated, unique ID of the cache.

• #file_cache_type ⇒ String

  The type of cache, which must be LUSTRE.

• #file_cache_type_version ⇒ String

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

• #kms_key_id ⇒ String

  Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache.

• #lifecycle ⇒ String

  The lifecycle status of the cache.

• #lustre_configuration ⇒ Types::FileCacheLustreConfiguration

  The configuration for the Amazon File Cache resource.

• #network_interface_ids ⇒ Array<String>

  A list of network interface IDs.

• #owner_id ⇒ String

  An Amazon Web Services account ID.

• #resource_arn ⇒ String

  The Amazon Resource Name (ARN) for a given resource.

• #storage_capacity ⇒ Integer

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

• #subnet_ids ⇒ Array<String>

  A list of subnet IDs that the cache will be accessible from.

• #vpc_id ⇒ String

  The ID of your virtual private cloud (VPC).

Instance Attribute Details

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_details ⇒ Types::FileCacheFailureDetails

A structure providing details of any failures that occurred.

Returns:

• (Types::FileCacheFailureDetails)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_id ⇒ String

The system-generated, unique ID of the cache.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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 ⇒ String

The type of cache, which must be LUSTRE.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_version ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_id ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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

#lifecycle ⇒ String

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)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_configuration ⇒ Types::FileCacheLustreConfiguration

The configuration for the Amazon File Cache resource.

Returns:

• (Types::FileCacheLustreConfiguration)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_ids ⇒ Array<String>

A list of network interface IDs.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_id ⇒ String

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)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_ids ⇒ Array<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>)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 5520

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