[ aws . opsworks ]

describe-raid-arrays

Description

Describe an instance’s RAID arrays.

Note

This call accepts only one resource-identifying parameter.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-raid-arrays
[--instance-id <value>]
[--stack-id <value>]
[--raid-array-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

--stack-id (string)

The stack ID.

--raid-array-ids (list)

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe RAID arrays

The following example describes the RAID arrays attached to the instances in a specified stack.

aws opsworks --region us-east-1 describe-raid-arrays --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06

Output: The following is the output for a stack with one RAID array.

{
  "RaidArrays": [
    {
      "StackId": "d72553d4-8727-448c-9b00-f024f0ba1b06",
      "AvailabilityZone": "us-west-2a",
      "Name": "Created for php-app1",
      "NumberOfDisks": 2,
      "InstanceId": "9f14adbc-ced5-43b6-bf01-e7d0db6cf2f7",
      "RaidLevel": 0,
      "VolumeType": "standard",
      "RaidArrayId": "f2d4e470-5972-4676-b1b8-bae41ec3e51c",
      "Device": "/dev/md0",
      "MountPoint": "/mnt/workspace",
      "CreatedAt": "2015-02-26T23:53:09+00:00",
      "Size": 100
    }
  ]
}

For more information, see EBS Volumes in the AWS OpsWorks User Guide.

Output

RaidArrays -> (list)

A RaidArrays object that describes the specified RAID arrays.

(structure)

Describes an instance’s RAID array.

RaidArrayId -> (string)

The array ID.

InstanceId -> (string)

The instance ID.

Name -> (string)

The array name.

RaidLevel -> (integer)

The RAID level .

NumberOfDisks -> (integer)

The number of disks in the array.

Size -> (integer)

The array’s size.

Device -> (string)

The array’s Linux device. For example /dev/mdadm0.

MountPoint -> (string)

The array’s mount point.

AvailabilityZone -> (string)

The array’s Availability Zone. For more information, see Regions and Endpoints .

CreatedAt -> (string)

When the RAID array was created.

StackId -> (string)

The stack ID.

VolumeType -> (string)

The volume type, standard or PIOPS.

Iops -> (integer)

For PIOPS volumes, the IOPS per disk.