Class: Aws::FSx::Types::UpdateVolumeRequest

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 UpdateVolumeRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  volume_id: "VolumeId", # required
  ontap_configuration: {
    junction_path: "JunctionPath",
    security_style: "UNIX", # accepts UNIX, NTFS, MIXED
    size_in_megabytes: 1,
    storage_efficiency_enabled: false,
    tiering_policy: {
      cooling_period: 1,
      name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
    },
  },
  name: "VolumeName",
  open_zfs_configuration: {
    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
    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
      },
    ],
    read_only: false,
  },
}

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)


8611
8612
8613
8614
8615
8616
8617
8618
8619
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8611

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

#nameString

The name of the OpenZFS volume. OpenZFS root volumes are automatically named FSX. Child volume names must be unique among their parent volume's children. The name of the volume is part of the mount string for the OpenZFS volume.

Returns:

  • (String)


8611
8612
8613
8614
8615
8616
8617
8618
8619
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8611

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

#ontap_configurationTypes::UpdateOntapVolumeConfiguration

The configuration of the ONTAP volume that you are updating.



8611
8612
8613
8614
8615
8616
8617
8618
8619
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8611

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

#open_zfs_configurationTypes::UpdateOpenZFSVolumeConfiguration

The configuration of the OpenZFS volume that you are updating.



8611
8612
8613
8614
8615
8616
8617
8618
8619
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8611

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

#volume_idString

The ID of the volume that you want to update, in the format fsvol-0123456789abcdef0.

Returns:

  • (String)


8611
8612
8613
8614
8615
8616
8617
8618
8619
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8611

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