« blib/lib/Paws/RedShift/DescribeLoggingStatus.pm
↑ Summary
blib/lib/Paws/RedShift/DescribePartners.pm »
| 1 | |||
| 2 | package Paws::RedShift::DescribeNodeConfigurationOptions; | ||
| 3 | use Moose; | ||
| 4 | has ActionType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 6 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::NodeConfigurationOptionsFilter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 7 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 8 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 9 | has OwnerAccount => (is => 'ro', isa => 'Str'); | ||
| 10 | has SnapshotIdentifier => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeNodeConfigurationOptions'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::NodeConfigurationOptionsMessage'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeNodeConfigurationOptionsResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::RedShift::DescribeNodeConfigurationOptions - Arguments for method DescribeNodeConfigurationOptions on L<Paws::RedShift> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method DescribeNodeConfigurationOptions on the | ||
| 28 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 29 | as arguments to method DescribeNodeConfigurationOptions. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeNodeConfigurationOptions. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $redshift = Paws->service('RedShift'); | ||
| 36 | my $NodeConfigurationOptionsMessage = | ||
| 37 | $redshift->DescribeNodeConfigurationOptions( | ||
| 38 | ActionType => 'restore-cluster', | ||
| 39 | ClusterIdentifier => 'MyString', # OPTIONAL | ||
| 40 | Filters => [ | ||
| 41 | { | ||
| 42 | Name => 'NodeType' | ||
| 43 | , # values: NodeType, NumberOfNodes, EstimatedDiskUtilizationPercent, Mode; OPTIONAL | ||
| 44 | Operator => 'eq', # values: eq, lt, gt, le, ge, in, between; OPTIONAL | ||
| 45 | Values => [ | ||
| 46 | 'MyString', ... # max: 2147483647 | ||
| 47 | ], # OPTIONAL | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | Marker => 'MyString', # OPTIONAL | ||
| 52 | MaxRecords => 1, # OPTIONAL | ||
| 53 | OwnerAccount => 'MyString', # OPTIONAL | ||
| 54 | SnapshotIdentifier => 'MyString', # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $Marker = $NodeConfigurationOptionsMessage->Marker; | ||
| 59 | my $NodeConfigurationOptionList = | ||
| 60 | $NodeConfigurationOptionsMessage->NodeConfigurationOptionList; | ||
| 61 | |||
| 62 | # Returns a L<Paws::RedShift::NodeConfigurationOptionsMessage> object. | ||
| 63 | |||
| 64 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeNodeConfigurationOptions> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> ActionType => Str | ||
| 71 | |||
| 72 | The action type to evaluate for possible node configurations. Specify | ||
| 73 | "restore-cluster" to get configuration combinations based on an | ||
| 74 | existing snapshot. Specify "recommend-node-config" to get configuration | ||
| 75 | recommendations based on an existing cluster or snapshot. Specify | ||
| 76 | "resize-cluster" to get configuration combinations for elastic resize | ||
| 77 | based on an existing cluster. | ||
| 78 | |||
| 79 | Valid values are: C<"restore-cluster">, C<"recommend-node-config">, C<"resize-cluster"> | ||
| 80 | |||
| 81 | =head2 ClusterIdentifier => Str | ||
| 82 | |||
| 83 | The identifier of the cluster to evaluate for possible node | ||
| 84 | configurations. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 Filters => ArrayRef[L<Paws::RedShift::NodeConfigurationOptionsFilter>] | ||
| 89 | |||
| 90 | A set of name, operator, and value items to filter the results. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 Marker => Str | ||
| 95 | |||
| 96 | An optional parameter that specifies the starting point to return a set | ||
| 97 | of response records. When the results of a | ||
| 98 | DescribeNodeConfigurationOptions request exceed the value specified in | ||
| 99 | C<MaxRecords>, AWS returns a value in the C<Marker> field of the | ||
| 100 | response. You can retrieve the next set of response records by | ||
| 101 | providing the returned marker value in the C<Marker> parameter and | ||
| 102 | retrying the request. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 MaxRecords => Int | ||
| 107 | |||
| 108 | The maximum number of response records to return in each call. If the | ||
| 109 | number of remaining response records exceeds the specified | ||
| 110 | C<MaxRecords> value, a value is returned in a C<marker> field of the | ||
| 111 | response. You can retrieve the next set of records by retrying the | ||
| 112 | command with the returned marker value. | ||
| 113 | |||
| 114 | Default: C<500> | ||
| 115 | |||
| 116 | Constraints: minimum 100, maximum 500. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 OwnerAccount => Str | ||
| 121 | |||
| 122 | The AWS customer account used to create or copy the snapshot. Required | ||
| 123 | if you are restoring a snapshot you do not own, optional if you own the | ||
| 124 | snapshot. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 SnapshotIdentifier => Str | ||
| 129 | |||
| 130 | The identifier of the snapshot to evaluate for possible node | ||
| 131 | configurations. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head1 SEE ALSO | ||
| 137 | |||
| 138 | This class forms part of L<Paws>, documenting arguments for method DescribeNodeConfigurationOptions in L<Paws::RedShift> | ||
| 139 | |||
| 140 | =head1 BUGS and CONTRIBUTIONS | ||
| 141 | |||
| 142 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 143 | |||
| 144 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 145 | |||
| 146 | =cut | ||
| 147 |