« blib/lib/Paws/DMS/CreateEventSubscriptionResponse.pm
↑ Summary
blib/lib/Paws/DMS/CreateReplicationInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::CreateReplicationInstance; | ||
| 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 KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 10 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 11 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 12 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 13 | has ReplicationInstanceClass => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has ReplicationInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 15 | has ReplicationSubnetGroupIdentifier => (is => 'ro', isa => 'Str'); | ||
| 16 | has ResourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 17 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DMS::Tag]'); | ||
| 18 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 19 | |||
| 20 | use MooseX::ClassAttribute; | ||
| 21 | |||
| 22 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateReplicationInstance'); | ||
| 23 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::CreateReplicationInstanceResponse'); | ||
| 24 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::DMS::CreateReplicationInstance - Arguments for method CreateReplicationInstance on L<Paws::DMS> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method CreateReplicationInstance on the | ||
| 36 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 37 | as arguments to method CreateReplicationInstance. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateReplicationInstance. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $dms = Paws->service('DMS'); | ||
| 44 | # Create replication instance | ||
| 45 | # Creates the replication instance using the specified parameters. | ||
| 46 | my $CreateReplicationInstanceResponse = $dms->CreateReplicationInstance( | ||
| 47 | 'AllocatedStorage' => 123, | ||
| 48 | 'AutoMinorVersionUpgrade' => 1, | ||
| 49 | 'AvailabilityZone' => '', | ||
| 50 | 'EngineVersion' => '', | ||
| 51 | 'KmsKeyId' => '', | ||
| 52 | 'MultiAZ' => 1, | ||
| 53 | 'PreferredMaintenanceWindow' => '', | ||
| 54 | 'PubliclyAccessible' => 1, | ||
| 55 | 'ReplicationInstanceClass' => '', | ||
| 56 | 'ReplicationInstanceIdentifier' => '', | ||
| 57 | 'ReplicationSubnetGroupIdentifier' => '', | ||
| 58 | 'Tags' => [ | ||
| 59 | |||
| 60 | { | ||
| 61 | 'Key' => 'string', | ||
| 62 | 'Value' => 'string' | ||
| 63 | } | ||
| 64 | ], | ||
| 65 | 'VpcSecurityGroupIds' => [ | ||
| 66 | |||
| 67 | ] | ||
| 68 | ); | ||
| 69 | |||
| 70 | # Results: | ||
| 71 | my $ReplicationInstance = | ||
| 72 | $CreateReplicationInstanceResponse->ReplicationInstance; | ||
| 73 | |||
| 74 | # Returns a L<Paws::DMS::CreateReplicationInstanceResponse> object. | ||
| 75 | |||
| 76 | 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. | ||
| 77 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/CreateReplicationInstance> | ||
| 78 | |||
| 79 | =head1 ATTRIBUTES | ||
| 80 | |||
| 81 | |||
| 82 | =head2 AllocatedStorage => Int | ||
| 83 | |||
| 84 | The amount of storage (in gigabytes) to be initially allocated for the | ||
| 85 | replication instance. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 90 | |||
| 91 | A value that indicates whether minor engine upgrades are applied | ||
| 92 | automatically to the replication instance during the maintenance | ||
| 93 | window. This parameter defaults to C<true>. | ||
| 94 | |||
| 95 | Default: C<true> | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 AvailabilityZone => Str | ||
| 100 | |||
| 101 | The Availability Zone where the replication instance will be created. | ||
| 102 | The default value is a random, system-chosen Availability Zone in the | ||
| 103 | endpoint's AWS Region, for example: C<us-east-1d> | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 DnsNameServers => Str | ||
| 108 | |||
| 109 | A list of custom DNS name servers supported for the replication | ||
| 110 | instance to access your on-premise source or target database. This list | ||
| 111 | overrides the default name servers supported by the replication | ||
| 112 | instance. You can specify a comma-separated list of internet addresses | ||
| 113 | for up to four on-premise DNS name servers. For example: | ||
| 114 | C<"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"> | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 EngineVersion => Str | ||
| 119 | |||
| 120 | The engine version number of the replication instance. | ||
| 121 | |||
| 122 | If an engine version number is not specified when a replication | ||
| 123 | instance is created, the default is the latest engine version | ||
| 124 | available. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 KmsKeyId => Str | ||
| 129 | |||
| 130 | An AWS KMS key identifier that is used to encrypt the data on the | ||
| 131 | replication instance. | ||
| 132 | |||
| 133 | If you don't specify a value for the C<KmsKeyId> parameter, then AWS | ||
| 134 | DMS uses your default encryption key. | ||
| 135 | |||
| 136 | AWS KMS creates the default encryption key for your AWS account. Your | ||
| 137 | AWS account has a different default encryption key for each AWS Region. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 MultiAZ => Bool | ||
| 142 | |||
| 143 | Specifies whether the replication instance is a Multi-AZ deployment. | ||
| 144 | You can't set the C<AvailabilityZone> parameter if the Multi-AZ | ||
| 145 | parameter is set to C<true>. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 PreferredMaintenanceWindow => Str | ||
| 150 | |||
| 151 | The weekly time range during which system maintenance can occur, in | ||
| 152 | Universal Coordinated Time (UTC). | ||
| 153 | |||
| 154 | Format: C<ddd:hh24:mi-ddd:hh24:mi> | ||
| 155 | |||
| 156 | Default: A 30-minute window selected at random from an 8-hour block of | ||
| 157 | time per AWS Region, occurring on a random day of the week. | ||
| 158 | |||
| 159 | Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun | ||
| 160 | |||
| 161 | Constraints: Minimum 30-minute window. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 PubliclyAccessible => Bool | ||
| 166 | |||
| 167 | Specifies the accessibility options for the replication instance. A | ||
| 168 | value of C<true> represents an instance with a public IP address. A | ||
| 169 | value of C<false> represents an instance with a private IP address. The | ||
| 170 | default value is C<true>. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 B<REQUIRED> ReplicationInstanceClass => Str | ||
| 175 | |||
| 176 | The compute and memory capacity of the replication instance as defined | ||
| 177 | for the specified replication instance class. For example to specify | ||
| 178 | the instance class dms.c4.large, set this parameter to | ||
| 179 | C<"dms.c4.large">. | ||
| 180 | |||
| 181 | For more information on the settings and capacities for the available | ||
| 182 | replication instance classes, see Selecting the right AWS DMS | ||
| 183 | replication instance for your migration | ||
| 184 | (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth). | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 B<REQUIRED> ReplicationInstanceIdentifier => Str | ||
| 189 | |||
| 190 | The replication instance identifier. This parameter is stored as a | ||
| 191 | lowercase string. | ||
| 192 | |||
| 193 | Constraints: | ||
| 194 | |||
| 195 | =over | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | Must contain 1-63 alphanumeric characters or hyphens. | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | First character must be a letter. | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 208 | |||
| 209 | =back | ||
| 210 | |||
| 211 | Example: C<myrepinstance> | ||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | =head2 ReplicationSubnetGroupIdentifier => Str | ||
| 216 | |||
| 217 | A subnet group to associate with the replication instance. | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head2 ResourceIdentifier => Str | ||
| 222 | |||
| 223 | A friendly name for the resource identifier at the end of the | ||
| 224 | C<EndpointArn> response parameter that is returned in the created | ||
| 225 | C<Endpoint> object. The value for this parameter can have up to 31 | ||
| 226 | characters. It can contain only ASCII letters, digits, and hyphen | ||
| 227 | ('-'). Also, it can't end with a hyphen or contain two consecutive | ||
| 228 | hyphens, and can only begin with a letter, such as C<Example-App-ARN1>. | ||
| 229 | For example, this value might result in the C<EndpointArn> value | ||
| 230 | C<arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1>. If you | ||
| 231 | don't specify a C<ResourceIdentifier> value, AWS DMS generates a | ||
| 232 | default identifier value for the end of C<EndpointArn>. | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head2 Tags => ArrayRef[L<Paws::DMS::Tag>] | ||
| 237 | |||
| 238 | One or more tags to be assigned to the replication instance. | ||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 243 | |||
| 244 | Specifies the VPC security group to be used with the replication | ||
| 245 | instance. The VPC security group must work with the VPC containing the | ||
| 246 | replication instance. | ||
| 247 | |||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head1 SEE ALSO | ||
| 252 | |||
| 253 | This class forms part of L<Paws>, documenting arguments for method CreateReplicationInstance in L<Paws::DMS> | ||
| 254 | |||
| 255 | =head1 BUGS and CONTRIBUTIONS | ||
| 256 | |||
| 257 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 258 | |||
| 259 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 260 | |||
| 261 | =cut | ||
| 262 |