NAME
Paws::DocDB::DBInstance
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::DocDB::DBInstance object:
$service_obj->Method(Att1 => { AutoMinorVersionUpgrade => $value, ..., VpcSecurityGroups => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBInstance object:
$result = $service_obj->Method(...);
$result->Att1->AutoMinorVersionUpgradeDESCRIPTION
Detailed information about an instance.
ATTRIBUTES
AutoMinorVersionUpgrade => Bool
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
AvailabilityZone => Str
Specifies the name of the Availability Zone that the instance is located in.
BackupRetentionPeriod => Int
Specifies the number of days for which automatic snapshots are retained.
CACertificateIdentifier => Str
The identifier of the CA certificate for this DB instance.
DBClusterIdentifier => Str
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
DBInstanceArn => Str
The Amazon Resource Name (ARN) for the instance.
DBInstanceClass => Str
Contains the name of the compute and memory capacity class of the instance.
DBInstanceIdentifier => Str
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceStatus => Str
Specifies the current state of this database.
DbiResourceId => Str
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
DBSubnetGroup => Paws::DocDB::DBSubnetGroup
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]
A list of log types that this instance is configured to export to CloudWatch Logs.
Endpoint => Paws::DocDB::Endpoint
Specifies the connection endpoint.
Engine => Str
Provides the name of the database engine to be used for this instance.
EngineVersion => Str
Indicates the database engine version.
InstanceCreateTime => Str
Provides the date and time that the instance was created.
KmsKeyId => Str
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
LatestRestorableTime => Str
Specifies the latest time to which a database can be restored with point-in-time restore.
PendingModifiedValues => Paws::DocDB::PendingModifiedValues
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
PreferredBackupWindow => Str
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow => Str
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PromotionTier => Int
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
PubliclyAccessible => Bool
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos => ArrayRef[Paws::DocDB::DBInstanceStatusInfo]
The status of a read replica. If the instance is not a read replica, this is blank.
StorageEncrypted => Bool
Specifies whether or not the instance is encrypted.
VpcSecurityGroups => ArrayRef[Paws::DocDB::VpcSecurityGroupMembership]
Provides a list of VPC security group elements that the instance belongs to.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::DocDB
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues