Class: Aws::FSx::Types::CreateVolumeRequest

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

Overview

Note:

When making an API call, you may pass CreateVolumeRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  volume_type: "ONTAP", # required, accepts ONTAP, OPENZFS
  name: "VolumeName", # required
  ontap_configuration: {
    junction_path: "JunctionPath", # required
    security_style: "UNIX", # accepts UNIX, NTFS, MIXED
    size_in_megabytes: 1, # required
    storage_efficiency_enabled: false, # required
    storage_virtual_machine_id: "StorageVirtualMachineId", # required
    tiering_policy: {
      cooling_period: 1,
      name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  open_zfs_configuration: {
    parent_volume_id: "VolumeId", # required
    storage_capacity_reservation_gi_b: 1,
    storage_capacity_quota_gi_b: 1,
    record_size_ki_b: 1,
    data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
    copy_tags_to_snapshots: false,
    origin_snapshot: {
      snapshot_arn: "ResourceARN", # required
      copy_strategy: "CLONE", # required, accepts CLONE, FULL_COPY
    },
    read_only: false,
    nfs_exports: [
      {
        client_configurations: [ # required
          {
            clients: "OpenZFSClients", # required
            options: ["OpenZFSNfsExportOption"], # required
          },
        ],
      },
    ],
    user_and_group_quotas: [
      {
        type: "USER", # required, accepts USER, GROUP
        id: 1, # required
        storage_capacity_quota_gi_b: 1, # required
      },
    ],
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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

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

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Specifies the name of the volume that you're creating.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ontap_configurationTypes::CreateOntapVolumeConfiguration

Specifies the configuration to use when creating the ONTAP volume.



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#open_zfs_configurationTypes::CreateOpenZFSVolumeConfiguration

Specifies the configuration to use when creating the OpenZFS volume.



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#volume_typeString

Specifies the type of volume to create; ONTAP and OPENZFS are the only valid volume types.

Returns:

  • (String)


3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3204

class CreateVolumeRequest < Struct.new(
  :client_request_token,
  :volume_type,
  :name,
  :ontap_configuration,
  :tags,
  :open_zfs_configuration)
  SENSITIVE = []
  include Aws::Structure
end