« blib/lib/Paws/RDS/ResetDBClusterParameterGroup.pm
↑ Summary
blib/lib/Paws/RDS/ResourcePendingMaintenanceActions.pm »
| 1 | |||
| 2 | package Paws::RDS::ResetDBParameterGroup; | ||
| 3 | use Moose; | ||
| 4 | has DBParameterGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Parameter]'); | ||
| 6 | has ResetAllParameters => (is => 'ro', isa => 'Bool'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ResetDBParameterGroup'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBParameterGroupNameMessage'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ResetDBParameterGroupResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::RDS::ResetDBParameterGroup - Arguments for method ResetDBParameterGroup on L<Paws::RDS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ResetDBParameterGroup on the | ||
| 24 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 25 | as arguments to method ResetDBParameterGroup. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ResetDBParameterGroup. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $rds = Paws->service('RDS'); | ||
| 32 | # To reset the values of a DB parameter group | ||
| 33 | # This example resets all parameters for the specified DB parameter group to | ||
| 34 | # their default values. | ||
| 35 | my $DBParameterGroupNameMessage = $rds->ResetDBParameterGroup( | ||
| 36 | 'DBParameterGroupName' => 'mydbparametergroup', | ||
| 37 | 'ResetAllParameters' => 1 | ||
| 38 | ); | ||
| 39 | |||
| 40 | |||
| 41 | 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. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ResetDBParameterGroup> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> DBParameterGroupName => Str | ||
| 48 | |||
| 49 | The name of the DB parameter group. | ||
| 50 | |||
| 51 | Constraints: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Must match the name of an existing C<DBParameterGroup>. | ||
| 58 | |||
| 59 | =back | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Parameters => ArrayRef[L<Paws::RDS::Parameter>] | ||
| 65 | |||
| 66 | To reset the entire DB parameter group, specify the C<DBParameterGroup> | ||
| 67 | name and C<ResetAllParameters> parameters. To reset specific | ||
| 68 | parameters, provide a list of the following: C<ParameterName> and | ||
| 69 | C<ApplyMethod>. A maximum of 20 parameters can be modified in a single | ||
| 70 | request. | ||
| 71 | |||
| 72 | B<MySQL> | ||
| 73 | |||
| 74 | Valid Values (for Apply method): C<immediate> | C<pending-reboot> | ||
| 75 | |||
| 76 | You can use the immediate value with dynamic parameters only. You can | ||
| 77 | use the C<pending-reboot> value for both dynamic and static parameters, | ||
| 78 | and changes are applied when DB instance reboots. | ||
| 79 | |||
| 80 | B<MariaDB> | ||
| 81 | |||
| 82 | Valid Values (for Apply method): C<immediate> | C<pending-reboot> | ||
| 83 | |||
| 84 | You can use the immediate value with dynamic parameters only. You can | ||
| 85 | use the C<pending-reboot> value for both dynamic and static parameters, | ||
| 86 | and changes are applied when DB instance reboots. | ||
| 87 | |||
| 88 | B<Oracle> | ||
| 89 | |||
| 90 | Valid Values (for Apply method): C<pending-reboot> | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ResetAllParameters => Bool | ||
| 95 | |||
| 96 | A value that indicates whether to reset all parameters in the DB | ||
| 97 | parameter group to default values. By default, all parameters in the DB | ||
| 98 | parameter group are reset to default values. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method ResetDBParameterGroup in L<Paws::RDS> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |