NAME
Paws::Neptune::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::Neptune::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::Neptune::DBInstance object:
$result = $service_obj->Method(...);
$result->Att1->AllocatedStorage
DESCRIPTION
Contains the details of an Amazon Neptune DB instance.
This data type is used as a response element in the DescribeDBInstances action.
ATTRIBUTES
AllocatedStorage => Int
Not supported by Neptune.
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
(Not supported by Neptune)
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.
DBInstanceArn => Str
The Amazon Resource Name (ARN) for 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.
DbiResourceId => Str
The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.
DBName => Str
The database name.
DBParameterGroups => ArrayRef[Paws::Neptune::DBParameterGroupStatus]
Provides the list of DB parameter groups applied to this DB instance.
DBSecurityGroups => ArrayRef[Paws::Neptune::DBSecurityGroupMembership]
Provides List of DB security group elements containing only DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
DBSubnetGroup => Paws::Neptune::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 whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
DomainMemberships => ArrayRef[Paws::Neptune::DomainMembership]
Not supported
EnabledCloudwatchLogsExports => ArrayRef[Str|Undef]
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Endpoint => Paws::Neptune::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.
IAMDatabaseAuthenticationEnabled => Bool
True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
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
Not supported: The encryption for DB instances is managed by the DB cluster.
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
Not supported by Neptune.
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 Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
MultiAZ => Bool
Specifies if the DB instance is a Multi-AZ deployment.
OptionGroupMemberships => ArrayRef[Paws::Neptune::OptionGroupMembership]
(Not supported by Neptune)
PendingModifiedValues => Paws::Neptune::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.
PerformanceInsightsEnabled => Bool
(Not supported by Neptune)
PerformanceInsightsKMSKeyId => Str
(Not supported by Neptune)
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 a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
PubliclyAccessible => Bool
This flag should no longer be used.
ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef]
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
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.
SecondaryAvailabilityZone => Str
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
StatusInfos => ArrayRef[Paws::Neptune::DBInstanceStatusInfo]
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
StorageEncrypted => Bool
Not supported: The encryption for DB instances is managed by the DB cluster.
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.
Timezone => Str
Not supported.
VpcSecurityGroups => ArrayRef[Paws::Neptune::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::Neptune
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