Class: Aws::FSx::Types::CreateFileCacheRequest

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::CreateFileCacheRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  An idempotency token for resource creation, in a string of up to 63 ASCII characters.

• #copy_tags_to_data_repository_associations ⇒ Boolean

  A boolean flag indicating whether tags for the cache should be copied to data repository associations.

• #data_repository_associations ⇒ Array<Types::FileCacheDataRepositoryAssociation>

  A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation.

• #file_cache_type ⇒ String

  The type of cache that you’re creating, which must be ‘LUSTRE`.

• #file_cache_type_version ⇒ String

  Sets the Lustre version for the cache that you’re creating, 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.

• #lustre_configuration ⇒ Types::CreateFileCacheLustreConfiguration

  The configuration for the Amazon File Cache resource being created.

• #security_group_ids ⇒ Array<String>

  A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access.

• #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.

• #tags ⇒ Array<Types::Tag>

  A list of ‘Tag` values, with a maximum of 50 elements.

Instance Attribute Details

#client_request_token ⇒ String

An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a ‘CreateFileCache` operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_data_repository_associations ⇒ Boolean

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

Returns:

• (Boolean)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#data_repository_associations ⇒ Array<Types::FileCacheDataRepositoryAssociation>

A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

• All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can’t link to different data repository types at the same time.

• An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

Returns:

• (Array<Types::FileCacheDataRepositoryAssociation>)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_type ⇒ String

The type of cache that you’re creating, which must be ‘LUSTRE`.

Returns:

• (String)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_type_version ⇒ String

Sets the Lustre version for the cache that you’re creating, which must be ‘2.12`.

Returns:

• (String)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  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*.

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

Returns:

• (String)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#lustre_configuration ⇒ Types::CreateFileCacheLustreConfiguration

The configuration for the Amazon File Cache resource being created.

Returns:

• (Types::CreateFileCacheLustreConfiguration)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn’t returned in later requests to describe the cache.

Returns:

• (Array<String>)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity ⇒ Integer

The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

Returns:

• (Integer)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  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 'lib/aws-sdk-fsx/types.rb', line 1506

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of ‘Tag` values, with a maximum of 50 elements.

Returns:

• (Array<Types::Tag>)

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

class CreateFileCacheRequest < Struct.new(
  :client_request_token,
  :file_cache_type,
  :file_cache_type_version,
  :storage_capacity,
  :subnet_ids,
  :security_group_ids,
  :tags,
  :copy_tags_to_data_repository_associations,
  :kms_key_id,
  :lustre_configuration,
  :data_repository_associations)
  SENSITIVE = []
  include Aws::Structure
end