NAME

Paws::SecurityHub::AwsRdsDbInstanceDetails

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::SecurityHub::AwsRdsDbInstanceDetails 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::SecurityHub::AwsRdsDbInstanceDetails object:

$result = $service_obj->Method(...);
$result->Att1->AllocatedStorage

DESCRIPTION

Contains the details of an Amazon RDS DB instance.

ATTRIBUTES

AllocatedStorage => Int

The amount of storage (in gigabytes) to initially allocate for the DB instance.

AssociatedRoles => ArrayRef[Paws::SecurityHub::AwsRdsDbInstanceAssociatedRole]

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

AutoMinorVersionUpgrade => Bool

Indicates whether minor version patches are applied automatically.

AvailabilityZone => Str

The Availability Zone where the DB instance will be created.

BackupRetentionPeriod => Int

The number of days for which to retain automated backups.

CACertificateIdentifier => Str

The identifier of the CA certificate for this DB instance.

CharacterSetName => Str

The name of the character set that this DB instance is associated with.

CopyTagsToSnapshot => Bool

Whether to copy resource tags 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

The current status of the DB instance.

DbiResourceId => Str

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key 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.

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::SecurityHub::AwsRdsDbParameterGroup]

A list of the DB parameter groups to assign to the DB instance.

DbSecurityGroups => ArrayRef[Str|Undef]

A list of the DB security groups to assign to the DB instance.

DbSubnetGroup => Paws::SecurityHub::AwsRdsDbSubnetGroup

Information about the subnet group that is associated with the DB instance.

DeletionProtection => Bool

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

DomainMemberships => ArrayRef[Paws::SecurityHub::AwsRdsDbDomainMembership]

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.

Endpoint => Paws::SecurityHub::AwsRdsDbInstanceEndpoint

Specifies the connection endpoint.

Engine => Str

Provides the name of the database engine to use for this DB instance.

EngineVersion => Str

Indicates the database engine version.

EnhancedMonitoringResourceArn => Str

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

IAMDatabaseAuthenticationEnabled => Bool

True if mapping of AWS 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

InstanceCreateTime => Str

Indicates when the DB instance was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Iops => Int

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

KmsKeyId => Str

If StorageEncrypted is true, the AWS 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.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format (https://tools.ietf.org/html/rfc3339#section-5.6). The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

LicenseModel => Str

License model information for this DB instance.

ListenerEndpoint => Paws::SecurityHub::AwsRdsDbInstanceEndpoint

MasterUsername => Str

The master user name of 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 Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

MultiAz => Bool

Whether the DB instance is a multiple Availability Zone deployment.

OptionGroupMemberships => ArrayRef[Paws::SecurityHub::AwsRdsDbOptionGroupMembership]

The list of option group memberships for this DB instance.

PendingModifiedValues => Paws::SecurityHub::AwsRdsDbPendingModifiedValues

Changes to the DB instance that are currently pending.

PerformanceInsightsEnabled => Bool

Indicates whether Performance Insights is enabled for the DB instance.

PerformanceInsightsKmsKeyId => Str

The identifier of the AWS KMS key used to encrypt the Performance Insights data.

PerformanceInsightsRetentionPeriod => Int

The number of days to retain Performance Insights data.

PreferredBackupWindow => Str

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

PreferredMaintenanceWindow => Str

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

ProcessorFeatures => ArrayRef[Paws::SecurityHub::AwsRdsDbProcessorFeature]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PromotionTier => Int

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

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.

ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef]

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

ReadReplicaDBInstanceIdentifiers => ArrayRef[Str|Undef]

List of identifiers of the read replicas associated with this DB instance.

ReadReplicaSourceDBInstanceIdentifier => Str

If this DB instance is a read replica, contains the identifier of the source DB instance.

SecondaryAvailabilityZone => Str

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

StatusInfos => ArrayRef[Paws::SecurityHub::AwsRdsDbStatusInfo]

The status of a read replica. If the instance isn't a read replica, this is empty.

StorageEncrypted => Bool

Specifies whether the DB instance is encrypted.

StorageType => Str

The storage type for the DB instance.

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.

VpcSecurityGroups => ArrayRef[Paws::SecurityHub::AwsRdsDbInstanceVpcSecurityGroup]

A list of VPC security groups that the DB instance belongs to.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::SecurityHub

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