« blib/lib/Paws/DocDB/ResourcePendingMaintenanceActions.pm
↑ Summary
blib/lib/Paws/DocDB/RestoreDBClusterFromSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::DocDB::RestoreDBClusterFromSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 7 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 8 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 11 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has Port => (is => 'ro', isa => 'Int'); | ||
| 13 | has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]'); | ||
| 15 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshot'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::RestoreDBClusterFromSnapshotResult'); | ||
| 21 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshotResult'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::DocDB::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on L<Paws::DocDB> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the | ||
| 33 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 34 | as arguments to method RestoreDBClusterFromSnapshot. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $rds = Paws->service('DocDB'); | ||
| 41 | my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot( | ||
| 42 | DBClusterIdentifier => 'MyString', | ||
| 43 | Engine => 'MyString', | ||
| 44 | SnapshotIdentifier => 'MyString', | ||
| 45 | AvailabilityZones => [ 'MyString', ... ], # OPTIONAL | ||
| 46 | DBSubnetGroupName => 'MyString', # OPTIONAL | ||
| 47 | DeletionProtection => 1, # OPTIONAL | ||
| 48 | EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL | ||
| 49 | EngineVersion => 'MyString', # OPTIONAL | ||
| 50 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 51 | Port => 1, # OPTIONAL | ||
| 52 | Tags => [ | ||
| 53 | { | ||
| 54 | Key => 'MyString', | ||
| 55 | Value => 'MyString', | ||
| 56 | }, | ||
| 57 | ... | ||
| 58 | ], # OPTIONAL | ||
| 59 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 60 | ); | ||
| 61 | |||
| 62 | # Results: | ||
| 63 | my $DBCluster = $RestoreDBClusterFromSnapshotResult->DBCluster; | ||
| 64 | |||
| 65 | # Returns a L<Paws::DocDB::RestoreDBClusterFromSnapshotResult> 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/rds/RestoreDBClusterFromSnapshot> | ||
| 69 | |||
| 70 | =head1 ATTRIBUTES | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 74 | |||
| 75 | Provides the list of Amazon EC2 Availability Zones that instances in | ||
| 76 | the restored DB cluster can be created in. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 81 | |||
| 82 | The name of the cluster to create from the snapshot or cluster | ||
| 83 | snapshot. This parameter isn't case sensitive. | ||
| 84 | |||
| 85 | Constraints: | ||
| 86 | |||
| 87 | =over | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | The first character must be a letter. | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 100 | |||
| 101 | =back | ||
| 102 | |||
| 103 | Example: C<my-snapshot-id> | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 DBSubnetGroupName => Str | ||
| 108 | |||
| 109 | The name of the subnet group to use for the new cluster. | ||
| 110 | |||
| 111 | Constraints: If provided, must match the name of an existing | ||
| 112 | C<DBSubnetGroup>. | ||
| 113 | |||
| 114 | Example: C<mySubnetgroup> | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 DeletionProtection => Bool | ||
| 119 | |||
| 120 | Specifies whether this cluster can be deleted. If C<DeletionProtection> | ||
| 121 | is enabled, the cluster cannot be deleted unless it is modified and | ||
| 122 | C<DeletionProtection> is disabled. C<DeletionProtection> protects | ||
| 123 | clusters from being accidentally deleted. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 128 | |||
| 129 | A list of log types that must be enabled for exporting to Amazon | ||
| 130 | CloudWatch Logs. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 B<REQUIRED> Engine => Str | ||
| 135 | |||
| 136 | The database engine to use for the new cluster. | ||
| 137 | |||
| 138 | Default: The same as source. | ||
| 139 | |||
| 140 | Constraint: Must be compatible with the engine of the source. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 EngineVersion => Str | ||
| 145 | |||
| 146 | The version of the database engine to use for the new cluster. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 KmsKeyId => Str | ||
| 151 | |||
| 152 | The KMS key identifier to use when restoring an encrypted cluster from | ||
| 153 | a DB snapshot or cluster snapshot. | ||
| 154 | |||
| 155 | The KMS key identifier is the Amazon Resource Name (ARN) for the KMS | ||
| 156 | encryption key. If you are restoring a cluster with the same account | ||
| 157 | that owns the KMS encryption key used to encrypt the new cluster, then | ||
| 158 | you can use the KMS key alias instead of the ARN for the KMS encryption | ||
| 159 | key. | ||
| 160 | |||
| 161 | If you do not specify a value for the C<KmsKeyId> parameter, then the | ||
| 162 | following occurs: | ||
| 163 | |||
| 164 | =over | ||
| 165 | |||
| 166 | =item * | ||
| 167 | |||
| 168 | If the snapshot or cluster snapshot in C<SnapshotIdentifier> is | ||
| 169 | encrypted, then the restored cluster is encrypted using the KMS key | ||
| 170 | that was used to encrypt the snapshot or the cluster snapshot. | ||
| 171 | |||
| 172 | =item * | ||
| 173 | |||
| 174 | If the snapshot or the cluster snapshot in C<SnapshotIdentifier> is not | ||
| 175 | encrypted, then the restored DB cluster is not encrypted. | ||
| 176 | |||
| 177 | =back | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 Port => Int | ||
| 183 | |||
| 184 | The port number on which the new cluster accepts connections. | ||
| 185 | |||
| 186 | Constraints: Must be a value from C<1150> to C<65535>. | ||
| 187 | |||
| 188 | Default: The same port as the original cluster. | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head2 B<REQUIRED> SnapshotIdentifier => Str | ||
| 193 | |||
| 194 | The identifier for the snapshot or cluster snapshot to restore from. | ||
| 195 | |||
| 196 | You can use either the name or the Amazon Resource Name (ARN) to | ||
| 197 | specify a cluster snapshot. However, you can use only the ARN to | ||
| 198 | specify a snapshot. | ||
| 199 | |||
| 200 | Constraints: | ||
| 201 | |||
| 202 | =over | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | Must match the identifier of an existing snapshot. | ||
| 207 | |||
| 208 | =back | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>] | ||
| 214 | |||
| 215 | The tags to be assigned to the restored cluster. | ||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 220 | |||
| 221 | A list of virtual private cloud (VPC) security groups that the new | ||
| 222 | cluster will belong to. | ||
| 223 | |||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head1 SEE ALSO | ||
| 228 | |||
| 229 | This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterFromSnapshot in L<Paws::DocDB> | ||
| 230 | |||
| 231 | =head1 BUGS and CONTRIBUTIONS | ||
| 232 | |||
| 233 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 234 | |||
| 235 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 236 | |||
| 237 | =cut | ||
| 238 |