« blib/lib/Paws/DocDB/DBEngineVersionMessage.pm
↑ Summary
blib/lib/Paws/DocDB/DBInstanceMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DocDB::DBInstance; | ||
| 3 | use Moose; | ||
| 4 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 6 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 7 | has CACertificateIdentifier => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has DBInstanceArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 11 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 12 | has DBInstanceStatus => (is => 'ro', isa => 'Str'); | ||
| 13 | has DbiResourceId => (is => 'ro', isa => 'Str'); | ||
| 14 | has DBSubnetGroup => (is => 'ro', isa => 'Paws::DocDB::DBSubnetGroup'); | ||
| 15 | has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 16 | has Endpoint => (is => 'ro', isa => 'Paws::DocDB::Endpoint'); | ||
| 17 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 18 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 19 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | ||
| 20 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 21 | has LatestRestorableTime => (is => 'ro', isa => 'Str'); | ||
| 22 | has PendingModifiedValues => (is => 'ro', isa => 'Paws::DocDB::PendingModifiedValues'); | ||
| 23 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 24 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 25 | has PromotionTier => (is => 'ro', isa => 'Int'); | ||
| 26 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 27 | has StatusInfos => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::DBInstanceStatusInfo]', request_name => 'DBInstanceStatusInfo', traits => ['NameInRequest']); | ||
| 28 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 29 | has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']); | ||
| 30 | |||
| 31 | 1; | ||
| 32 | |||
| 33 | ### main pod documentation begin ### | ||
| 34 | |||
| 35 | =head1 NAME | ||
| 36 | |||
| 37 | Paws::DocDB::DBInstance | ||
| 38 | |||
| 39 | =head1 USAGE | ||
| 40 | |||
| 41 | This class represents one of two things: | ||
| 42 | |||
| 43 | =head3 Arguments in a call to a service | ||
| 44 | |||
| 45 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 46 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 47 | |||
| 48 | As an example, if Att1 is expected to be a Paws::DocDB::DBInstance object: | ||
| 49 | |||
| 50 | $service_obj->Method(Att1 => { AutoMinorVersionUpgrade => $value, ..., VpcSecurityGroups => $value }); | ||
| 51 | |||
| 52 | =head3 Results returned from an API call | ||
| 53 | |||
| 54 | Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBInstance object: | ||
| 55 | |||
| 56 | $result = $service_obj->Method(...); | ||
| 57 | $result->Att1->AutoMinorVersionUpgrade | ||
| 58 | |||
| 59 | =head1 DESCRIPTION | ||
| 60 | |||
| 61 | Detailed information about an instance. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 67 | |||
| 68 | Does not apply. This parameter does not apply to Amazon DocumentDB. | ||
| 69 | Amazon DocumentDB does not perform minor version upgrades regardless of | ||
| 70 | the value set. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AvailabilityZone => Str | ||
| 74 | |||
| 75 | Specifies the name of the Availability Zone that the instance is | ||
| 76 | located in. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 BackupRetentionPeriod => Int | ||
| 80 | |||
| 81 | Specifies the number of days for which automatic snapshots are | ||
| 82 | retained. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CACertificateIdentifier => Str | ||
| 86 | |||
| 87 | The identifier of the CA certificate for this DB instance. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 DBClusterIdentifier => Str | ||
| 91 | |||
| 92 | Contains the name of the cluster that the instance is a member of if | ||
| 93 | the instance is a member of a cluster. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 DBInstanceArn => Str | ||
| 97 | |||
| 98 | The Amazon Resource Name (ARN) for the instance. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 DBInstanceClass => Str | ||
| 102 | |||
| 103 | Contains the name of the compute and memory capacity class of the | ||
| 104 | instance. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 DBInstanceIdentifier => Str | ||
| 108 | |||
| 109 | Contains a user-provided database identifier. This identifier is the | ||
| 110 | unique key that identifies an instance. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 DBInstanceStatus => Str | ||
| 114 | |||
| 115 | Specifies the current state of this database. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 DbiResourceId => Str | ||
| 119 | |||
| 120 | The Region-unique, immutable identifier for the instance. This | ||
| 121 | identifier is found in CloudTrail log entries whenever the KMS key for | ||
| 122 | the instance is accessed. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 DBSubnetGroup => L<Paws::DocDB::DBSubnetGroup> | ||
| 126 | |||
| 127 | Specifies information on the subnet group that is associated with the | ||
| 128 | instance, including the name, description, and subnets in the subnet | ||
| 129 | group. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 133 | |||
| 134 | A list of log types that this instance is configured to export to | ||
| 135 | CloudWatch Logs. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 Endpoint => L<Paws::DocDB::Endpoint> | ||
| 139 | |||
| 140 | Specifies the connection endpoint. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 Engine => Str | ||
| 144 | |||
| 145 | Provides the name of the database engine to be used for this instance. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 EngineVersion => Str | ||
| 149 | |||
| 150 | Indicates the database engine version. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 InstanceCreateTime => Str | ||
| 154 | |||
| 155 | Provides the date and time that the instance was created. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 KmsKeyId => Str | ||
| 159 | |||
| 160 | If C<StorageEncrypted> is C<true>, the KMS key identifier for the | ||
| 161 | encrypted instance. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 LatestRestorableTime => Str | ||
| 165 | |||
| 166 | Specifies the latest time to which a database can be restored with | ||
| 167 | point-in-time restore. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 PendingModifiedValues => L<Paws::DocDB::PendingModifiedValues> | ||
| 171 | |||
| 172 | Specifies that changes to the instance are pending. This element is | ||
| 173 | included only when changes are pending. Specific changes are identified | ||
| 174 | by subelements. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 PreferredBackupWindow => Str | ||
| 178 | |||
| 179 | Specifies the daily time range during which automated backups are | ||
| 180 | created if automated backups are enabled, as determined by the | ||
| 181 | C<BackupRetentionPeriod>. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 PreferredMaintenanceWindow => Str | ||
| 185 | |||
| 186 | Specifies the weekly time range during which system maintenance can | ||
| 187 | occur, in Universal Coordinated Time (UTC). | ||
| 188 | |||
| 189 | |||
| 190 | =head2 PromotionTier => Int | ||
| 191 | |||
| 192 | A value that specifies the order in which an Amazon DocumentDB replica | ||
| 193 | is promoted to the primary instance after a failure of the existing | ||
| 194 | primary instance. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 PubliclyAccessible => Bool | ||
| 198 | |||
| 199 | Not supported. Amazon DocumentDB does not currently support public | ||
| 200 | endpoints. The value of C<PubliclyAccessible> is always C<false>. | ||
| 201 | |||
| 202 | |||
| 203 | =head2 StatusInfos => ArrayRef[L<Paws::DocDB::DBInstanceStatusInfo>] | ||
| 204 | |||
| 205 | The status of a read replica. If the instance is not a read replica, | ||
| 206 | this is blank. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 StorageEncrypted => Bool | ||
| 210 | |||
| 211 | Specifies whether or not the instance is encrypted. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 VpcSecurityGroups => ArrayRef[L<Paws::DocDB::VpcSecurityGroupMembership>] | ||
| 215 | |||
| 216 | Provides a list of VPC security group elements that the instance | ||
| 217 | belongs to. | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head1 SEE ALSO | ||
| 222 | |||
| 223 | This class forms part of L<Paws>, describing an object used in L<Paws::DocDB> | ||
| 224 | |||
| 225 | =head1 BUGS and CONTRIBUTIONS | ||
| 226 | |||
| 227 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 228 | |||
| 229 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 230 | |||
| 231 | =cut | ||
| 232 |