« blib/lib/Paws/RDS/ModifyGlobalClusterResult.pm
↑ Summary
blib/lib/Paws/RDS/ModifyOptionGroupResult.pm »
| 1 | |||
| 2 | package Paws::RDS::ModifyOptionGroup; | ||
| 3 | use Moose; | ||
| 4 | has ApplyImmediately => (is => 'ro', isa => 'Bool'); | ||
| 5 | has OptionGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has OptionsToInclude => (is => 'ro', isa => 'ArrayRef[Paws::RDS::OptionConfiguration]'); | ||
| 7 | has OptionsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyOptionGroup'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyOptionGroupResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyOptionGroupResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::ModifyOptionGroup - Arguments for method ModifyOptionGroup on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ModifyOptionGroup on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method ModifyOptionGroup. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyOptionGroup. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To modify an option group | ||
| 34 | # The following example adds an option to an option group. | ||
| 35 | my $ModifyOptionGroupResult = $rds->ModifyOptionGroup( | ||
| 36 | 'ApplyImmediately' => 1, | ||
| 37 | 'OptionGroupName' => 'myawsuser-og02', | ||
| 38 | 'OptionsToInclude' => [ | ||
| 39 | |||
| 40 | { | ||
| 41 | 'DBSecurityGroupMemberships' => ['default'], | ||
| 42 | 'OptionName' => 'MEMCACHED' | ||
| 43 | } | ||
| 44 | ] | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $OptionGroup = $ModifyOptionGroupResult->OptionGroup; | ||
| 49 | |||
| 50 | # Returns a L<Paws::RDS::ModifyOptionGroupResult> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyOptionGroup> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ApplyImmediately => Bool | ||
| 59 | |||
| 60 | A value that indicates whether to apply the change immediately or | ||
| 61 | during the next maintenance window for each instance associated with | ||
| 62 | the option group. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> OptionGroupName => Str | ||
| 67 | |||
| 68 | The name of the option group to be modified. | ||
| 69 | |||
| 70 | Permanent options, such as the TDE option for Oracle Advanced Security | ||
| 71 | TDE, can't be removed from an option group, and that option group can't | ||
| 72 | be removed from a DB instance once it is associated with a DB instance | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 OptionsToInclude => ArrayRef[L<Paws::RDS::OptionConfiguration>] | ||
| 77 | |||
| 78 | Options in this list are added to the option group or, if already | ||
| 79 | present, the specified configuration is used to update the existing | ||
| 80 | configuration. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 OptionsToRemove => ArrayRef[Str|Undef] | ||
| 85 | |||
| 86 | Options in this list are removed from the option group. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method ModifyOptionGroup in L<Paws::RDS> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |