« blib/lib/Paws/RDS/CreateGlobalClusterResult.pm
↑ Summary
blib/lib/Paws/RDS/CreateOptionGroupResult.pm »
| 1 | |||
| 2 | package Paws::RDS::CreateOptionGroup; | ||
| 3 | use Moose; | ||
| 4 | has EngineName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MajorEngineVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has OptionGroupDescription => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has OptionGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateOptionGroup'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CreateOptionGroupResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateOptionGroupResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RDS::CreateOptionGroup - Arguments for method CreateOptionGroup on L<Paws::RDS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateOptionGroup on the | ||
| 26 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateOptionGroup. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateOptionGroup. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $rds = Paws->service('RDS'); | ||
| 34 | # To create an option group | ||
| 35 | # This example creates an option group. | ||
| 36 | my $CreateOptionGroupResult = $rds->CreateOptionGroup( | ||
| 37 | 'EngineName' => 'MySQL', | ||
| 38 | 'MajorEngineVersion' => 5.6, | ||
| 39 | 'OptionGroupDescription' => 'My MySQL 5.6 option group', | ||
| 40 | 'OptionGroupName' => 'mymysqloptiongroup' | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $OptionGroup = $CreateOptionGroupResult->OptionGroup; | ||
| 45 | |||
| 46 | # Returns a L<Paws::RDS::CreateOptionGroupResult> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateOptionGroup> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> EngineName => Str | ||
| 55 | |||
| 56 | Specifies the name of the engine that this option group should be | ||
| 57 | associated with. | ||
| 58 | |||
| 59 | Valid Values: | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<mariadb> | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<mysql> | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<oracle-ee> | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<oracle-ee-cdb> | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<oracle-se2> | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<oracle-se2-cdb> | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<postgres> | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<sqlserver-ee> | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<sqlserver-se> | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<sqlserver-ex> | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<sqlserver-web> | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 B<REQUIRED> MajorEngineVersion => Str | ||
| 113 | |||
| 114 | Specifies the major version of the engine that this option group should | ||
| 115 | be associated with. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 B<REQUIRED> OptionGroupDescription => Str | ||
| 120 | |||
| 121 | The description of the option group. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 B<REQUIRED> OptionGroupName => Str | ||
| 126 | |||
| 127 | Specifies the name of the option group to be created. | ||
| 128 | |||
| 129 | Constraints: | ||
| 130 | |||
| 131 | =over | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | Must be 1 to 255 letters, numbers, or hyphens | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | First character must be a letter | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 144 | |||
| 145 | =back | ||
| 146 | |||
| 147 | Example: C<myoptiongroup> | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 152 | |||
| 153 | Tags to assign to the option group. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head1 SEE ALSO | ||
| 159 | |||
| 160 | This class forms part of L<Paws>, documenting arguments for method CreateOptionGroup in L<Paws::RDS> | ||
| 161 | |||
| 162 | =head1 BUGS and CONTRIBUTIONS | ||
| 163 | |||
| 164 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 165 | |||
| 166 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 167 | |||
| 168 | =cut | ||
| 169 |