NAME
Paws::RDS::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::RDS::DBInstance object:
$service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcSecurityGroups => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::DBInstance object:
$result = $service_obj->Method(...);
$result->Att1->AllocatedStorageDESCRIPTION
Contains the result of a successful invocation of the following actions:
CreateDBInstance
DeleteDBInstance
ModifyDBInstance
This data type is used as a response element in the DescribeDBInstances action.
ATTRIBUTES
AllocatedStorage => Int
Specifies the allocated storage size specified in gigabytes.AutoMinorVersionUpgrade => Bool
Indicates that minor version patches are applied automatically.AvailabilityZone => Str
Specifies the name of the Availability Zone the DB instance is located
in.BackupRetentionPeriod => Int
Specifies the number of days for which automatic DB snapshots are
retained.CACertificateIdentifier => Str
The identifier of the CA certificate for this DB instance.CharacterSetName => Str
If present, specifies the name of the character set that this instance
is associated with.CopyTagsToSnapshot => Bool
Specifies whether tags are copied from the DB instance to snapshots of
the DB instance.DBClusterIdentifier => Str
If the DB instance is a member of a DB cluster, contains the name of
the DB cluster that the DB instance is a member of.DBInstanceClass => Str
Contains the name of the compute and memory capacity class of the DB
instance.DBInstanceIdentifier => Str
Contains a user-supplied database identifier. This identifier is the
unique key that identifies a DB instance.DbInstancePort => Int
Specifies the port that the DB instance listens on. If the DB instance
is part of a DB cluster, this can be a different port than the DB
cluster port.DBInstanceStatus => Str
Specifies the current state of this database.DbiResourceId => Str
The region-unique, immutable identifier for the DB instance. This
identifier is found in AWS CloudTrail log entries whenever the KMS key
for the DB instance is accessed.DBName => Str
The meaning of this parameter differs according to the database engine
you use. For example, this value returns MySQL, MariaDB, or PostgreSQL
information when returning values from CreateDBInstanceReadReplica
since Read Replicas are only supported for these engines.MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
DBParameterGroups => ArrayRef[Paws::RDS::DBParameterGroupStatus]
Provides the list of DB parameter groups applied to this DB instance.DBSecurityGroups => ArrayRef[Paws::RDS::DBSecurityGroupMembership]
Provides List of DB security group elements containing only
C<DBSecurityGroup.Name> and C<DBSecurityGroup.Status> subelements.DBSubnetGroup => Paws::RDS::DBSubnetGroup
Specifies information on the subnet group associated with the DB
instance, including the name, description, and subnets in the subnet
group.DomainMemberships => ArrayRef[Paws::RDS::DomainMembership]
The Active Directory Domain membership records associated with the DB
instance.Endpoint => Paws::RDS::Endpoint
Specifies the connection endpoint.Engine => Str
Provides the name of the database engine to be used for this DB
instance.EngineVersion => Str
Indicates the database engine version.EnhancedMonitoringResourceArn => Str
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream
that receives the Enhanced Monitoring metrics data for the DB instance.InstanceCreateTime => Str
Provides the date and time the DB instance was created.Iops => Int
Specifies the Provisioned IOPS (I/O operations per second) value.KmsKeyId => Str
If C<StorageEncrypted> is true, the KMS key identifier for the
encrypted DB instance.LatestRestorableTime => Str
Specifies the latest time to which a database can be restored with
point-in-time restore.LicenseModel => Str
License model information for this DB instance.MasterUsername => Str
Contains the master username for the DB instance.MonitoringInterval => Int
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB instance.MonitoringRoleArn => Str
The ARN for the IAM role that permits RDS to send Enhanced Monitoring
metrics to CloudWatch Logs.MultiAZ => Bool
Specifies if the DB instance is a Multi-AZ deployment.OptionGroupMemberships => ArrayRef[Paws::RDS::OptionGroupMembership]
Provides the list of option group memberships for this DB instance.PendingModifiedValues => Paws::RDS::PendingModifiedValues
Specifies that changes to the DB instance are pending. This element is
only included 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
C<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 Aurora Replica is promoted
to the primary instance after a failure of the existing primary
instance. For more information, see Fault Tolerance for an Aurora DB
Cluster.PubliclyAccessible => Bool
Specifies the accessibility options for the DB instance. A value of
true specifies an Internet-facing instance with a publicly resolvable
DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a
private IP address.Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.
ReadReplicaDBInstanceIdentifiers => ArrayRef[Str]
Contains one or more identifiers of the Read Replicas associated with
this DB instance.ReadReplicaSourceDBInstanceIdentifier => Str
Contains the identifier of the source DB instance if this DB instance
is a Read Replica.SecondaryAvailabilityZone => Str
If present, specifies the name of the secondary Availability Zone for a
DB instance with multi-AZ support.StatusInfos => ArrayRef[Paws::RDS::DBInstanceStatusInfo]
The status of a Read Replica. If the instance is not a Read Replica,
this will be blank.StorageEncrypted => Bool
Specifies whether the DB instance is encrypted.StorageType => Str
Specifies the storage type associated with DB instance.TdeCredentialArn => Str
The ARN from the Key Store with which the instance is associated for
TDE encryption.VpcSecurityGroups => ArrayRef[Paws::RDS::VpcSecurityGroupMembership]
Provides List of VPC security group elements that the DB instance
belongs to.SEE ALSO
This class forms part of Paws, describing an object used in Paws::RDS
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