« blib/lib/Paws/DMS/ModifyEventSubscriptionResponse.pm
↑ Summary
blib/lib/Paws/DMS/ModifyReplicationInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::ModifyReplicationInstance; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AllowMajorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ApplyImmediately => (is => 'ro', isa => 'Bool'); | ||
| 7 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 8 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 10 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 11 | has ReplicationInstanceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has ReplicationInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 13 | has ReplicationInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 14 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyReplicationInstance'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::ModifyReplicationInstanceResponse'); | ||
| 20 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::DMS::ModifyReplicationInstance - Arguments for method ModifyReplicationInstance on L<Paws::DMS> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method ModifyReplicationInstance on the | ||
| 32 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 33 | as arguments to method ModifyReplicationInstance. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyReplicationInstance. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $dms = Paws->service('DMS'); | ||
| 40 | # Modify replication instance | ||
| 41 | # Modifies the replication instance to apply new settings. You can change one or | ||
| 42 | # more parameters by specifying these parameters and the new values in the | ||
| 43 | # request. Some settings are applied during the maintenance window. | ||
| 44 | my $ModifyReplicationInstanceResponse = $dms->ModifyReplicationInstance( | ||
| 45 | 'AllocatedStorage' => 123, | ||
| 46 | 'AllowMajorVersionUpgrade' => 1, | ||
| 47 | 'ApplyImmediately' => 1, | ||
| 48 | 'AutoMinorVersionUpgrade' => 1, | ||
| 49 | 'EngineVersion' => '1.5.0', | ||
| 50 | 'MultiAZ' => 1, | ||
| 51 | 'PreferredMaintenanceWindow' => 'sun:06:00-sun:14:00', | ||
| 52 | 'ReplicationInstanceArn' => | ||
| 53 | 'arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ', | ||
| 54 | 'ReplicationInstanceClass' => 'dms.t2.micro', | ||
| 55 | 'ReplicationInstanceIdentifier' => 'test-rep-1', | ||
| 56 | 'VpcSecurityGroupIds' => [ | ||
| 57 | |||
| 58 | ] | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $ReplicationInstance = | ||
| 63 | $ModifyReplicationInstanceResponse->ReplicationInstance; | ||
| 64 | |||
| 65 | # Returns a L<Paws::DMS::ModifyReplicationInstanceResponse> object. | ||
| 66 | |||
| 67 | 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. | ||
| 68 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/ModifyReplicationInstance> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AllocatedStorage => Int | ||
| 74 | |||
| 75 | The amount of storage (in gigabytes) to be allocated for the | ||
| 76 | replication instance. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 AllowMajorVersionUpgrade => Bool | ||
| 81 | |||
| 82 | Indicates that major version upgrades are allowed. Changing this | ||
| 83 | parameter does not result in an outage, and the change is | ||
| 84 | asynchronously applied as soon as possible. | ||
| 85 | |||
| 86 | This parameter must be set to C<true> when specifying a value for the | ||
| 87 | C<EngineVersion> parameter that is a different major version than the | ||
| 88 | replication instance's current version. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 ApplyImmediately => Bool | ||
| 93 | |||
| 94 | Indicates whether the changes should be applied immediately or during | ||
| 95 | the next maintenance window. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 100 | |||
| 101 | A value that indicates that minor version upgrades are applied | ||
| 102 | automatically to the replication instance during the maintenance | ||
| 103 | window. Changing this parameter doesn't result in an outage, except in | ||
| 104 | the case described following. The change is asynchronously applied as | ||
| 105 | soon as possible. | ||
| 106 | |||
| 107 | An outage does result if these factors apply: | ||
| 108 | |||
| 109 | =over | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | This parameter is set to C<true> during the maintenance window. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | A newer minor version is available. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | AWS DMS has enabled automatic patching for the given engine version. | ||
| 122 | |||
| 123 | =back | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 EngineVersion => Str | ||
| 129 | |||
| 130 | The engine version number of the replication instance. | ||
| 131 | |||
| 132 | When modifying a major engine version of an instance, also set | ||
| 133 | C<AllowMajorVersionUpgrade> to C<true>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 MultiAZ => Bool | ||
| 138 | |||
| 139 | Specifies whether the replication instance is a Multi-AZ deployment. | ||
| 140 | You can't set the C<AvailabilityZone> parameter if the Multi-AZ | ||
| 141 | parameter is set to C<true>. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 PreferredMaintenanceWindow => Str | ||
| 146 | |||
| 147 | The weekly time range (in UTC) during which system maintenance can | ||
| 148 | occur, which might result in an outage. Changing this parameter does | ||
| 149 | not result in an outage, except in the following situation, and the | ||
| 150 | change is asynchronously applied as soon as possible. If moving this | ||
| 151 | window to the current time, there must be at least 30 minutes between | ||
| 152 | the current time and end of the window to ensure pending changes are | ||
| 153 | applied. | ||
| 154 | |||
| 155 | Default: Uses existing setting | ||
| 156 | |||
| 157 | Format: ddd:hh24:mi-ddd:hh24:mi | ||
| 158 | |||
| 159 | Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun | ||
| 160 | |||
| 161 | Constraints: Must be at least 30 minutes | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 B<REQUIRED> ReplicationInstanceArn => Str | ||
| 166 | |||
| 167 | The Amazon Resource Name (ARN) of the replication instance. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 ReplicationInstanceClass => Str | ||
| 172 | |||
| 173 | The compute and memory capacity of the replication instance as defined | ||
| 174 | for the specified replication instance class. For example to specify | ||
| 175 | the instance class dms.c4.large, set this parameter to | ||
| 176 | C<"dms.c4.large">. | ||
| 177 | |||
| 178 | For more information on the settings and capacities for the available | ||
| 179 | replication instance classes, see Selecting the right AWS DMS | ||
| 180 | replication instance for your migration | ||
| 181 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 ReplicationInstanceIdentifier => Str | ||
| 186 | |||
| 187 | The replication instance identifier. This parameter is stored as a | ||
| 188 | lowercase string. | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 193 | |||
| 194 | Specifies the VPC security group to be used with the replication | ||
| 195 | instance. The VPC security group must work with the VPC containing the | ||
| 196 | replication instance. | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head1 SEE ALSO | ||
| 202 | |||
| 203 | This class forms part of L<Paws>, documenting arguments for method ModifyReplicationInstance in L<Paws::DMS> | ||
| 204 | |||
| 205 | =head1 BUGS and CONTRIBUTIONS | ||
| 206 | |||
| 207 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 208 | |||
| 209 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 210 | |||
| 211 | =cut | ||
| 212 |