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