Class: Aws::Finspace::Types::GetKxVolumeResponse

Inherits:

Struct

• Object
• Struct
• Aws::Finspace::Types::GetKxVolumeResponse

Defined in:

gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attached_clusters ⇒ Array<Types::KxAttachedCluster>

  A list of cluster identifiers that a volume is attached to.

• #availability_zone_ids ⇒ Array<String>

  The identifier of the availability zones.

• #az_mode ⇒ String

  The number of availability zones you want to assign per volume.

• #created_timestamp ⇒ Time

  The timestamp at which the volume was created in FinSpace.

• #description ⇒ String

  A description of the volume.

• #environment_id ⇒ String

  A unique identifier for the kdb environment, whose clusters can attach to the volume.

• #last_modified_timestamp ⇒ Time

  The last time that the volume was updated in FinSpace.

• #nas1_configuration ⇒ Types::KxNAS1Configuration

  Specifies the configuration for the Network attached storage (NAS_1) file system volume.

• #status ⇒ String

  The status of volume creation.

• #status_reason ⇒ String

  The error message when a failed state occurs.

• #volume_arn ⇒ String

  The ARN identifier of the volume.

• #volume_name ⇒ String

  A unique identifier for the volume.

• #volume_type ⇒ String

  The type of file system volume.

Instance Attribute Details

#attached_clusters ⇒ Array<Types::KxAttachedCluster>

A list of cluster identifiers that a volume is attached to.

Returns:

• (Array<Types::KxAttachedCluster>)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_ids ⇒ Array<String>

The identifier of the availability zones.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#az_mode ⇒ String

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestamp ⇒ Time

The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

• (Time)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the volume.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

A unique identifier for the kdb environment, whose clusters can attach to the volume.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timestamp ⇒ Time

The last time that the volume was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

Returns:

• (Time)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#nas1_configuration ⇒ Types::KxNAS1Configuration

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

Returns:

• (Types::KxNAS1Configuration)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of volume creation.

• CREATING – The volume creation is in progress.

• CREATE_FAILED – The volume creation has failed.

• ACTIVE – The volume is active.

• UPDATING – The volume is in the process of being updated.

• UPDATE_FAILED – The update action failed.

• UPDATED – The volume is successfully updated.

• DELETING – The volume is in the process of being deleted.

• DELETE_FAILED – The system failed to delete the volume.

• DELETED – The volume is successfully deleted.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The error message when a failed state occurs.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#volume_arn ⇒ String

The ARN identifier of the volume.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#volume_name ⇒ String

A unique identifier for the volume.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end

#volume_type ⇒ String

The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.

Returns:

• (String)

# File 'gems/aws-sdk-finspace/lib/aws-sdk-finspace/types.rb', line 2866

class GetKxVolumeResponse < Struct.new(
  :environment_id,
  :volume_name,
  :volume_type,
  :volume_arn,
  :nas1_configuration,
  :status,
  :status_reason,
  :created_timestamp,
  :description,
  :az_mode,
  :availability_zone_ids,
  :last_modified_timestamp,
  :attached_clusters)
  SENSITIVE = []
  include Aws::Structure
end