« blib/lib/Paws/DMS/RemoveTagsFromResourceResponse.pm
↑ Summary
blib/lib/Paws/DMS/ReplicationInstanceTaskLog.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DMS::ReplicationInstance; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 7 | has DnsNameServers => (is => 'ro', isa => 'Str'); | ||
| 8 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has FreeUntil => (is => 'ro', isa => 'Str'); | ||
| 10 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 13 | has PendingModifiedValues => (is => 'ro', isa => 'Paws::DMS::ReplicationPendingModifiedValues'); | ||
| 14 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 15 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 16 | has ReplicationInstanceArn => (is => 'ro', isa => 'Str'); | ||
| 17 | has ReplicationInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 18 | has ReplicationInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 19 | has ReplicationInstancePrivateIpAddress => (is => 'ro', isa => 'Str'); | ||
| 20 | has ReplicationInstancePrivateIpAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 21 | has ReplicationInstancePublicIpAddress => (is => 'ro', isa => 'Str'); | ||
| 22 | has ReplicationInstancePublicIpAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 23 | has ReplicationInstanceStatus => (is => 'ro', isa => 'Str'); | ||
| 24 | has ReplicationSubnetGroup => (is => 'ro', isa => 'Paws::DMS::ReplicationSubnetGroup'); | ||
| 25 | has SecondaryAvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 26 | has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::DMS::VpcSecurityGroupMembership]'); | ||
| 27 | |||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::DMS::ReplicationInstance | ||
| 35 | |||
| 36 | =head1 USAGE | ||
| 37 | |||
| 38 | This class represents one of two things: | ||
| 39 | |||
| 40 | =head3 Arguments in a call to a service | ||
| 41 | |||
| 42 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 43 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 44 | |||
| 45 | As an example, if Att1 is expected to be a Paws::DMS::ReplicationInstance object: | ||
| 46 | |||
| 47 | $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcSecurityGroups => $value }); | ||
| 48 | |||
| 49 | =head3 Results returned from an API call | ||
| 50 | |||
| 51 | Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::ReplicationInstance object: | ||
| 52 | |||
| 53 | $result = $service_obj->Method(...); | ||
| 54 | $result->Att1->AllocatedStorage | ||
| 55 | |||
| 56 | =head1 DESCRIPTION | ||
| 57 | |||
| 58 | Provides information that defines a replication instance. | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AllocatedStorage => Int | ||
| 64 | |||
| 65 | The amount of storage (in gigabytes) that is allocated for the | ||
| 66 | replication instance. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 70 | |||
| 71 | Boolean value indicating if minor version upgrades will be | ||
| 72 | automatically applied to the instance. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 AvailabilityZone => Str | ||
| 76 | |||
| 77 | The Availability Zone for the instance. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 DnsNameServers => Str | ||
| 81 | |||
| 82 | The DNS name servers supported for the replication instance to access | ||
| 83 | your on-premise source or target database. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 EngineVersion => Str | ||
| 87 | |||
| 88 | The engine version number of the replication instance. | ||
| 89 | |||
| 90 | If an engine version number is not specified when a replication | ||
| 91 | instance is created, the default is the latest engine version | ||
| 92 | available. | ||
| 93 | |||
| 94 | When modifying a major engine version of an instance, also set | ||
| 95 | C<AllowMajorVersionUpgrade> to C<true>. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 FreeUntil => Str | ||
| 99 | |||
| 100 | The expiration date of the free replication instance that is part of | ||
| 101 | the Free DMS program. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 InstanceCreateTime => Str | ||
| 105 | |||
| 106 | The time the replication instance was created. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 KmsKeyId => Str | ||
| 110 | |||
| 111 | An AWS KMS key identifier that is used to encrypt the data on the | ||
| 112 | replication instance. | ||
| 113 | |||
| 114 | If you don't specify a value for the C<KmsKeyId> parameter, then AWS | ||
| 115 | DMS uses your default encryption key. | ||
| 116 | |||
| 117 | AWS KMS creates the default encryption key for your AWS account. Your | ||
| 118 | AWS account has a different default encryption key for each AWS Region. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 MultiAZ => Bool | ||
| 122 | |||
| 123 | Specifies whether the replication instance is a Multi-AZ deployment. | ||
| 124 | You can't set the C<AvailabilityZone> parameter if the Multi-AZ | ||
| 125 | parameter is set to C<true>. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 PendingModifiedValues => L<Paws::DMS::ReplicationPendingModifiedValues> | ||
| 129 | |||
| 130 | The pending modification values. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 PreferredMaintenanceWindow => Str | ||
| 134 | |||
| 135 | The maintenance window times for the replication instance. Any pending | ||
| 136 | upgrades to the replication instance are performed during this time. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 PubliclyAccessible => Bool | ||
| 140 | |||
| 141 | Specifies the accessibility options for the replication instance. A | ||
| 142 | value of C<true> represents an instance with a public IP address. A | ||
| 143 | value of C<false> represents an instance with a private IP address. The | ||
| 144 | default value is C<true>. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 ReplicationInstanceArn => Str | ||
| 148 | |||
| 149 | The Amazon Resource Name (ARN) of the replication instance. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 ReplicationInstanceClass => Str | ||
| 153 | |||
| 154 | The compute and memory capacity of the replication instance as defined | ||
| 155 | for the specified replication instance class. It is a required | ||
| 156 | parameter, although a defualt value is pre-selected in the DMS console. | ||
| 157 | |||
| 158 | For more information on the settings and capacities for the available | ||
| 159 | replication instance classes, see Selecting the right AWS DMS | ||
| 160 | replication instance for your migration | ||
| 161 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). | ||
| 162 | |||
| 163 | |||
| 164 | =head2 ReplicationInstanceIdentifier => Str | ||
| 165 | |||
| 166 | The replication instance identifier is a required parameter. This | ||
| 167 | parameter is stored as a lowercase string. | ||
| 168 | |||
| 169 | Constraints: | ||
| 170 | |||
| 171 | =over | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | Must contain 1-63 alphanumeric characters or hyphens. | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | First character must be a letter. | ||
| 180 | |||
| 181 | =item * | ||
| 182 | |||
| 183 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 184 | |||
| 185 | =back | ||
| 186 | |||
| 187 | Example: C<myrepinstance> | ||
| 188 | |||
| 189 | |||
| 190 | =head2 ReplicationInstancePrivateIpAddress => Str | ||
| 191 | |||
| 192 | The private IP address of the replication instance. | ||
| 193 | |||
| 194 | |||
| 195 | =head2 ReplicationInstancePrivateIpAddresses => ArrayRef[Str|Undef] | ||
| 196 | |||
| 197 | One or more private IP addresses for the replication instance. | ||
| 198 | |||
| 199 | |||
| 200 | =head2 ReplicationInstancePublicIpAddress => Str | ||
| 201 | |||
| 202 | The public IP address of the replication instance. | ||
| 203 | |||
| 204 | |||
| 205 | =head2 ReplicationInstancePublicIpAddresses => ArrayRef[Str|Undef] | ||
| 206 | |||
| 207 | One or more public IP addresses for the replication instance. | ||
| 208 | |||
| 209 | |||
| 210 | =head2 ReplicationInstanceStatus => Str | ||
| 211 | |||
| 212 | The status of the replication instance. The possible return values | ||
| 213 | include: | ||
| 214 | |||
| 215 | =over | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | C<"available"> | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | C<"creating"> | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | C<"deleted"> | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | C<"deleting"> | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | C<"failed"> | ||
| 236 | |||
| 237 | =item * | ||
| 238 | |||
| 239 | C<"modifying"> | ||
| 240 | |||
| 241 | =item * | ||
| 242 | |||
| 243 | C<"upgrading"> | ||
| 244 | |||
| 245 | =item * | ||
| 246 | |||
| 247 | C<"rebooting"> | ||
| 248 | |||
| 249 | =item * | ||
| 250 | |||
| 251 | C<"resetting-master-credentials"> | ||
| 252 | |||
| 253 | =item * | ||
| 254 | |||
| 255 | C<"storage-full"> | ||
| 256 | |||
| 257 | =item * | ||
| 258 | |||
| 259 | C<"incompatible-credentials"> | ||
| 260 | |||
| 261 | =item * | ||
| 262 | |||
| 263 | C<"incompatible-network"> | ||
| 264 | |||
| 265 | =item * | ||
| 266 | |||
| 267 | C<"maintenance"> | ||
| 268 | |||
| 269 | =back | ||
| 270 | |||
| 271 | |||
| 272 | |||
| 273 | =head2 ReplicationSubnetGroup => L<Paws::DMS::ReplicationSubnetGroup> | ||
| 274 | |||
| 275 | The subnet group for the replication instance. | ||
| 276 | |||
| 277 | |||
| 278 | =head2 SecondaryAvailabilityZone => Str | ||
| 279 | |||
| 280 | The Availability Zone of the standby replication instance in a Multi-AZ | ||
| 281 | deployment. | ||
| 282 | |||
| 283 | |||
| 284 | =head2 VpcSecurityGroups => ArrayRef[L<Paws::DMS::VpcSecurityGroupMembership>] | ||
| 285 | |||
| 286 | The VPC security group for the instance. | ||
| 287 | |||
| 288 | |||
| 289 | |||
| 290 | =head1 SEE ALSO | ||
| 291 | |||
| 292 | This class forms part of L<Paws>, describing an object used in L<Paws::DMS> | ||
| 293 | |||
| 294 | =head1 BUGS and CONTRIBUTIONS | ||
| 295 | |||
| 296 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 297 | |||
| 298 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 299 | |||
| 300 | =cut | ||
| 301 |