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 => { ActivityStreamEngineNativeAuditFieldsIncluded => $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->ActivityStreamEngineNativeAuditFieldsIncludedDESCRIPTION
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the DescribeDBInstances action.
ATTRIBUTES
ActivityStreamEngineNativeAuditFieldsIncluded => Bool
Indicates whether engine-native audit fields are included in the database activity stream.
ActivityStreamKinesisStreamName => Str
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamKmsKeyId => Str
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
ActivityStreamMode => Str
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamStatus => Str
The status of the database activity stream.
AllocatedStorage => Int
Specifies the allocated storage size specified in gibibytes.
AssociatedRoles => ArrayRef[Paws::RDS::DBInstanceRole]
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
AutoMinorVersionUpgrade => Bool
A value that indicates that minor version patches are applied automatically.
AvailabilityZone => Str
Specifies the name of the Availability Zone the DB instance is located in.
AwsBackupRecoveryPointArn => Str
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
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.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
CustomerOwnedIpEnabled => Bool
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) in the Amazon Web Services Outposts User Guide.
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.
DBInstanceArn => Str
The Amazon Resource Name (ARN) for the DB instance.
DBInstanceAutomatedBackupsReplications => ArrayRef[Paws::RDS::DBInstanceAutomatedBackupsReplication]
The list of replicated automated backups associated with the DB instance.
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.
For information about DB instance statuses, see Viewing DB instance status (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status) in the Amazon RDS User Guide.
DbiResourceId => Str
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.
DBName => Str
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
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]
A list of DB security group elements containing DBSecurityGroup.Name and 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.
DeletionProtection => Bool
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
DomainMemberships => ArrayRef[Paws::RDS::DomainMembership]
The Active Directory Domain membership records associated with the DB instance.
EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in the Amazon RDS User Guide.
Endpoint => Paws::RDS::Endpoint
Specifies the connection endpoint.
Engine => Str
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.
IAMDatabaseAuthenticationEnabled => Bool
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.
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 StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
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.
ListenerEndpoint => Paws::RDS::Endpoint
Specifies the listener connection endpoint for SQL Server Always On.
MasterUsername => Str
Contains the master username for the DB instance.
MaxAllocatedStorage => Int
The upper limit to which Amazon RDS can automatically scale the storage of 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 Amazon CloudWatch Logs.
MultiAZ => Bool
Specifies if the DB instance is a Multi-AZ deployment.
NcharCharacterSetName => Str
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
OptionGroupMemberships => ArrayRef[Paws::RDS::OptionGroupMembership]
Provides the list of option group memberships for this DB instance.
PendingModifiedValues => Paws::RDS::PendingModifiedValues
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PerformanceInsightsEnabled => Bool
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId => Str
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
PerformanceInsightsRetentionPeriod => Int
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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).
ProcessorFeatures => ArrayRef[Paws::RDS::ProcessorFeature]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
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 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the Amazon Aurora User Guide.
PubliclyAccessible => Bool
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef]
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
ReadReplicaDBInstanceIdentifiers => ArrayRef[Str|Undef]
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.
ReplicaMode => Str
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
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 isn't a read replica, this is blank.
StorageEncrypted => Bool
Specifies whether the DB instance is encrypted.
StorageType => Str
Specifies the storage type associated with DB instance.
TagList => ArrayRef[Paws::RDS::Tag]
TdeCredentialArn => Str
The ARN from the key store with which the instance is associated for TDE encryption.
Timezone => Str
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
VpcSecurityGroups => ArrayRef[Paws::RDS::VpcSecurityGroupMembership]
Provides a 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