Neptune Instances API - Amazon Neptune

Neptune Instances API

Structures:

Actions:

DBInstance (structure)

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances (action) action.

Fields

  • AllocatedStorage – Number (integer).

    Specifies the allocated storage size specified in gibibytes.

  • AutoMinorVersionUpgrade – Boolean.

    Indicates that minor version patches are applied automatically.

  • AvailabilityZone – UTF-8 string.

    Specifies the name of the Availability Zone the DB instance is located in.

  • BackupRetentionPeriod – Number (integer).

    Specifies the number of days for which automatic DB snapshots are retained.

  • CACertificateIdentifier – UTF-8 string.

    The identifier of the CA certificate for this DB instance.

  • CopyTagsToSnapshot – Boolean.

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  • DBClusterIdentifier – UTF-8 string.

    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 – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB instance.

  • DBInstanceClass – UTF-8 string.

    Contains the name of the compute and memory capacity class of the DB instance.

  • DBInstanceIdentifier – UTF-8 string.

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • DbInstancePort – Number (integer).

    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 – UTF-8 string.

    Specifies the current state of this database.

  • DbiResourceId – UTF-8 string.

    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 – UTF-8 string.

    The database name.

  • DBParameterGroups – An array of DBParameterGroupStatus DBParameterGroup objects.

    Provides the list of DB parameter groups applied to this DB instance.

  • DBSecurityGroups – An array of DBSecurityGroupMembership DBSecurityGroup objects.

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • DBSubnetGroup – A DBSubnetGroup object.

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • DeletionProtection – Boolean.

    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.

  • DomainMemberships – An array of DomainMembership DomainMembership objects.

    Not supported

  • EnabledCloudwatchLogsExports – An array of UTF-8 strings.

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

  • Endpoint – An Endpoint object.

    Specifies the connection endpoint.

  • Engine – UTF-8 string.

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

  • EngineVersion – UTF-8 string.

    Indicates the database engine version.

  • EnhancedMonitoringResourceArn – UTF-8 string.

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • IAMDatabaseAuthenticationEnabled – Boolean.

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

  • InstanceCreateTime – Timestamp.

    Provides the date and time the DB instance was created.

  • Iops – Number (integer).

    Specifies the Provisioned IOPS (I/O operations per second) value.

  • KmsKeyId – UTF-8 string.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • LatestRestorableTime – Timestamp.

    Specifies the latest time to which a database can be restored with point-in-time restore.

  • LicenseModel – UTF-8 string.

    License model information for this DB instance.

  • MasterUsername – UTF-8 string.

    Contains the master username for the DB instance.

  • MonitoringInterval – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • MonitoringRoleArn – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • MultiAZ – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment.

  • PendingModifiedValues – A PendingModifiedValues object.

    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 – UTF-8 string.

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

  • PreferredMaintenanceWindow – UTF-8 string.

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

  • PromotionTier – Number (integer).

    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 – Boolean.

    This flag should no longer be used.

  • ReadReplicaDBClusterIdentifiers – An array of ReadReplicaDBClusterIdentifier— UTF-8 strings.

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

  • ReadReplicaDBInstanceIdentifiers – An array of ReadReplicaDBInstanceIdentifier— UTF-8 strings.

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  • ReadReplicaSourceDBInstanceIdentifier – UTF-8 string.

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  • SecondaryAvailabilityZone – UTF-8 string.

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • StatusInfos – An array of DBInstanceStatusInfo DBInstanceStatusInfo objects.

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • StorageEncrypted – Boolean.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • StorageType – UTF-8 string.

    Specifies the storage type associated with DB instance.

  • TdeCredentialArn – UTF-8 string.

    The ARN from the key store with which the instance is associated for TDE encryption.

  • Timezone – UTF-8 string.

    Not supported.

  • VpcSecurityGroups – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

    Provides a list of VPC security group elements that the DB instance belongs to.

DBInstance is used as the response element for:

DBInstanceStatusInfo (structure)

Provides a list of status information for a DB instance.

Fields

  • Message – UTF-8 string.

    Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

  • Normal – Boolean.

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

  • Status – UTF-8 string.

    Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

  • StatusType – UTF-8 string.

    This value is currently "read replication."

OrderableDBInstanceOption (structure)

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions (action) action.

Fields

  • AvailabilityZones – An array of AvailabilityZone AvailabilityZone objects.

    A list of Availability Zones for a DB instance.

  • DBInstanceClass – UTF-8 string.

    The DB instance class for a DB instance.

  • Engine – UTF-8 string.

    The engine type of a DB instance.

  • EngineVersion – UTF-8 string.

    The engine version of a DB instance.

  • LicenseModel – UTF-8 string.

    The license model for a DB instance.

  • MaxIopsPerDbInstance – Number (integer).

    Maximum total provisioned IOPS for a DB instance.

  • MaxIopsPerGib – Number (double).

    Maximum provisioned IOPS per GiB for a DB instance.

  • MaxStorageSize – Number (integer).

    Maximum storage size for a DB instance.

  • MinIopsPerDbInstance – Number (integer).

    Minimum total provisioned IOPS for a DB instance.

  • MinIopsPerGib – Number (double).

    Minimum provisioned IOPS per GiB for a DB instance.

  • MinStorageSize – Number (integer).

    Minimum storage size for a DB instance.

  • MultiAZCapable – Boolean.

    Indicates whether a DB instance is Multi-AZ capable.

  • ReadReplicaCapable – Boolean.

    Indicates whether a DB instance can have a Read Replica.

  • StorageType – UTF-8 string.

    Indicates the storage type for a DB instance.

  • SupportsEnhancedMonitoring – Boolean.

    Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

  • SupportsIAMDatabaseAuthentication – Boolean.

    Indicates whether a DB instance supports IAM database authentication.

  • SupportsIops – Boolean.

    Indicates whether a DB instance supports provisioned IOPS.

  • SupportsStorageEncryption – Boolean.

    Indicates whether a DB instance supports encrypted storage.

  • Vpc – Boolean.

    Indicates whether a DB instance is in a VPC.

ValidDBInstanceModificationsMessage (structure)

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications (action) action. You can use this information when you call ModifyDBInstance (action).

Fields

  • Storage – An array of ValidStorageOptions— a structures.

    Valid storage options for your DB instance.

ValidDBInstanceModificationsMessage is used as the response element for:

CreateDBInstance (action)

        The AWS CLI name for this API is: create-db-instance,  and the Python name is: create_db_instance.

Creates a new DB instance.

Request

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

    Type: Integer

    Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

    Default: true

  • AvailabilityZone  (in the CLI: --availability-zone,  or in Python: availability_zone) – UTF-8 string.

    The EC2 Availability Zone that the DB instance is created in

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    The number of days for which automated backups are retained.

    Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster (action).

    Default: 1

    Constraints:

    • Must be a value from 0 to 35

    • Cannot be set to 0 if the DB instance is a source to Read Replicas

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    The identifier of the DB cluster that the instance will belong to.

    For information on creating a DB cluster, see CreateDBCluster (action).

    Type: String

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – Required: UTF-8 string.

    The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – Required: UTF-8 string.

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

  • DBName  (in the CLI: --db-name,  or in Python: db_name) – UTF-8 string.

    Not supported.

  • DBParameterGroupName  (in the CLI: --db-parameter-group-name,  or in Python: db_parameter_group_name) – UTF-8 string.

    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupName— UTF-8 strings.

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    A DB subnet group to associate with this DB instance.

    If there is no DB subnet group, then it is a non-VPC DB instance.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

    DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

  • Domain  (in the CLI: --domain,  or in Python: domain) – UTF-8 string.

    Specify the Active Directory Domain to create the instance in.

  • DomainIAMRoleName  (in the CLI: --domain-iam-role-name,  or in Python: domain_iam_role_name) – UTF-8 string.

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

  • EnableCloudwatchLogsExports  (in the CLI: --enable-cloudwatch-logs-exports,  or in Python: enable_cloudwatch_logs_exports) – An array of UTF-8 strings.

    The list of log types that need to be enabled for exporting to CloudWatch Logs.

  • EnableIAMDatabaseAuthentication  (in the CLI: --enable-iam-database-authentication,  or in Python: enable_iam_database_authentication) – Boolean.

    True to enable AWS Identity and Access Management (IAM) authentication for Neptune.

    Default: false

  • Engine  (in the CLI: --engine,  or in Python: engine) – Required: UTF-8 string.

    The name of the database engine to be used for this instance.

    Valid Values: neptune

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    The version number of the database engine to use. Currently, setting this parameter has no effect.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    The AWS KMS key identifier for an encrypted DB instance.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster (action).

    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    License model information for this DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

  • MasterUsername  (in the CLI: --master-username,  or in Python: master_username) – UTF-8 string.

    The name for the master user. Not used.

  • MasterUserPassword  (in the CLI: --master-user-password,  or in Python: master_user_password) – UTF-8 string.

    The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

    Not used.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    The port number on which the database accepts connections.

    Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster (action).

    Default: 8182

    Type: Integer

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    The daily time range during which automated backups are created.

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster (action).

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    Default: 1

    Valid Values: 0 - 15

  • PubliclyAccessible  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB instance is encrypted.

    Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster (action).

    Default: false

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Specifies the storage type to be associated with the DB instance.

    Not applicable. Storage is managed by the DB Cluster.

  • Tags  (in the CLI: --tags,  or in Python: tags) – An array of Tag Tag objects.

    The tags to assign to the new instance.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which to associate the instance for TDE encryption.

  • TdeCredentialPassword  (in the CLI: --tde-credential-password,  or in Python: tde_credential_password) – UTF-8 string.

    The password for the given ARN from the key store in order to access the device.

  • Timezone  (in the CLI: --timezone,  or in Python: timezone) – UTF-8 string.

    The time zone of the DB instance.

  • VpcSecurityGroupIds  (in the CLI: --vpc-security-group-ids,  or in Python: vpc_security_group_ids) – An array of VpcSecurityGroupId— UTF-8 strings.

    A list of EC2 VPC security groups to associate with this DB instance.

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster (action).

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

Response

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances (action) action.

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

    Specifies the allocated storage size specified in gibibytes.

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor version patches are applied automatically.

  • AvailabilityZone  (in the CLI: --availability-zone,  or in Python: availability_zone) – UTF-8 string.

    Specifies the name of the Availability Zone the DB instance is located in.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    Specifies the number of days for which automatic DB snapshots are retained.

  • CACertificateIdentifier  (in the CLI: --ca-certificate-identifier,  or in Python: ca_certificate_identifier) – UTF-8 string.

    The identifier of the CA certificate for this DB instance.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    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  (in the CLI: --db-instance-arn,  or in Python: db_instance_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB instance.

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    Contains the name of the compute and memory capacity class of the DB instance.

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – UTF-8 string.

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • DbInstancePort  (in the CLI: --db-instance-port,  or in Python: db_instance_port) – Number (integer).

    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  (in the CLI: --db-instance-status,  or in Python: db_instance_status) – UTF-8 string.

    Specifies the current state of this database.

  • DbiResourceId  (in the CLI: --dbi-resource-id,  or in Python: dbi_resource_id) – UTF-8 string.

    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  (in the CLI: --db-name,  or in Python: db_name) – UTF-8 string.

    The database name.

  • DBParameterGroups  (in the CLI: --db-parameter-groups,  or in Python: db_parameter_groups) – An array of DBParameterGroupStatus DBParameterGroup objects.

    Provides the list of DB parameter groups applied to this DB instance.

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupMembership DBSecurityGroup objects.

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – A DBSubnetGroup object.

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • DomainMemberships  (in the CLI: --domain-memberships,  or in Python: domain_memberships) – An array of DomainMembership DomainMembership objects.

    Not supported

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – An Endpoint object.

    Specifies the connection endpoint.

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • EnhancedMonitoringResourceArn  (in the CLI: --enhanced-monitoring-resource-arn,  or in Python: enhanced_monitoring_resource_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

  • InstanceCreateTime  (in the CLI: --instance-create-time,  or in Python: instance_create_time) – Timestamp.

    Provides the date and time the DB instance was created.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    Specifies the Provisioned IOPS (I/O operations per second) value.

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

    Specifies the latest time to which a database can be restored with point-in-time restore.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    License model information for this DB instance.

  • MasterUsername  (in the CLI: --master-username,  or in Python: master_username) – UTF-8 string.

    Contains the master username for the DB instance.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment.

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A PendingModifiedValues object.

    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  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    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  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • ReadReplicaDBClusterIdentifiers  (in the CLI: --read-replica-db-cluster-identifiers,  or in Python: read_replica_db_cluster_identifiers) – An array of ReadReplicaDBClusterIdentifier— UTF-8 strings.

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

  • ReadReplicaDBInstanceIdentifiers  (in the CLI: --read-replica-db-instance-identifiers,  or in Python: read_replica_db_instance_identifiers) – An array of ReadReplicaDBInstanceIdentifier— UTF-8 strings.

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  • ReadReplicaSourceDBInstanceIdentifier  (in the CLI: --read-replica-source-db-instance-identifier,  or in Python: read_replica_source_db_instance_identifier) – UTF-8 string.

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  • SecondaryAvailabilityZone  (in the CLI: --secondary-availability-zone,  or in Python: secondary_availability_zone) – UTF-8 string.

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • StatusInfos  (in the CLI: --status-infos,  or in Python: status_infos) – An array of DBInstanceStatusInfo DBInstanceStatusInfo objects.

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Specifies the storage type associated with DB instance.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which the instance is associated for TDE encryption.

  • Timezone  (in the CLI: --timezone,  or in Python: timezone) – UTF-8 string.

    Not supported.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

    Provides a list of VPC security group elements that the DB instance belongs to.

DeleteDBInstance (action)

        The AWS CLI name for this API is: delete-db-instance,  and the Python name is: delete_db_instance.

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

Request

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – Required: UTF-8 string.

    The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

    Constraints:

    • Must match the name of an existing DB instance.

  • FinalDBSnapshotIdentifier  (in the CLI: --final-db-snapshot-identifier,  or in Python: final_db_snapshot_identifier) – UTF-8 string.

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

    Note

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    • Cannot be specified when deleting a Read Replica.

  • SkipFinalSnapshot  (in the CLI: --skip-final-snapshot,  or in Python: skip_final_snapshot) – Boolean.

    Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

    Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

    Specify true when deleting a Read Replica.

    Note

    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

    Default: false

Response

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances (action) action.

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

    Specifies the allocated storage size specified in gibibytes.

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor version patches are applied automatically.

  • AvailabilityZone  (in the CLI: --availability-zone,  or in Python: availability_zone) – UTF-8 string.

    Specifies the name of the Availability Zone the DB instance is located in.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    Specifies the number of days for which automatic DB snapshots are retained.

  • CACertificateIdentifier  (in the CLI: --ca-certificate-identifier,  or in Python: ca_certificate_identifier) – UTF-8 string.

    The identifier of the CA certificate for this DB instance.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    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  (in the CLI: --db-instance-arn,  or in Python: db_instance_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB instance.

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    Contains the name of the compute and memory capacity class of the DB instance.

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – UTF-8 string.

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • DbInstancePort  (in the CLI: --db-instance-port,  or in Python: db_instance_port) – Number (integer).

    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  (in the CLI: --db-instance-status,  or in Python: db_instance_status) – UTF-8 string.

    Specifies the current state of this database.

  • DbiResourceId  (in the CLI: --dbi-resource-id,  or in Python: dbi_resource_id) – UTF-8 string.

    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  (in the CLI: --db-name,  or in Python: db_name) – UTF-8 string.

    The database name.

  • DBParameterGroups  (in the CLI: --db-parameter-groups,  or in Python: db_parameter_groups) – An array of DBParameterGroupStatus DBParameterGroup objects.

    Provides the list of DB parameter groups applied to this DB instance.

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupMembership DBSecurityGroup objects.

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – A DBSubnetGroup object.

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • DomainMemberships  (in the CLI: --domain-memberships,  or in Python: domain_memberships) – An array of DomainMembership DomainMembership objects.

    Not supported

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – An Endpoint object.

    Specifies the connection endpoint.

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • EnhancedMonitoringResourceArn  (in the CLI: --enhanced-monitoring-resource-arn,  or in Python: enhanced_monitoring_resource_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

  • InstanceCreateTime  (in the CLI: --instance-create-time,  or in Python: instance_create_time) – Timestamp.

    Provides the date and time the DB instance was created.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    Specifies the Provisioned IOPS (I/O operations per second) value.

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

    Specifies the latest time to which a database can be restored with point-in-time restore.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    License model information for this DB instance.

  • MasterUsername  (in the CLI: --master-username,  or in Python: master_username) – UTF-8 string.

    Contains the master username for the DB instance.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment.

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A PendingModifiedValues object.

    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  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    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  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • ReadReplicaDBClusterIdentifiers  (in the CLI: --read-replica-db-cluster-identifiers,  or in Python: read_replica_db_cluster_identifiers) – An array of ReadReplicaDBClusterIdentifier— UTF-8 strings.

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

  • ReadReplicaDBInstanceIdentifiers  (in the CLI: --read-replica-db-instance-identifiers,  or in Python: read_replica_db_instance_identifiers) – An array of ReadReplicaDBInstanceIdentifier— UTF-8 strings.

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  • ReadReplicaSourceDBInstanceIdentifier  (in the CLI: --read-replica-source-db-instance-identifier,  or in Python: read_replica_source_db_instance_identifier) – UTF-8 string.

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  • SecondaryAvailabilityZone  (in the CLI: --secondary-availability-zone,  or in Python: secondary_availability_zone) – UTF-8 string.

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • StatusInfos  (in the CLI: --status-infos,  or in Python: status_infos) – An array of DBInstanceStatusInfo DBInstanceStatusInfo objects.

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Specifies the storage type associated with DB instance.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which the instance is associated for TDE encryption.

  • Timezone  (in the CLI: --timezone,  or in Python: timezone) – UTF-8 string.

    Not supported.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

    Provides a list of VPC security group elements that the DB instance belongs to.

ModifyDBInstance (action)

        The AWS CLI name for this API is: modify-db-instance,  and the Python name is: modify_db_instance.

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications (action) before you call ModifyDBInstance (action).

Request

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

    The new amount of storage (in gibibytes) to allocate for the DB instance.

    Not applicable. Storage is managed by the DB Cluster.

  • AllowMajorVersionUpgrade  (in the CLI: --allow-major-version-upgrade,  or in Python: allow_major_version_upgrade) – Boolean.

    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

  • ApplyImmediately  (in the CLI: --apply-immediately,  or in Python: apply_immediately) – Boolean.

    Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

    If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance (action), or the next failure reboot.

    Default: false

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster (action).

    Default: Uses existing setting

  • CACertificateIdentifier  (in the CLI: --ca-certificate-identifier,  or in Python: ca_certificate_identifier) – UTF-8 string.

    Indicates the certificate that needs to be associated with the instance.

  • CloudwatchLogsExportConfiguration  (in the CLI: --cloudwatch-logs-export-configuration,  or in Python: cloudwatch_logs_export_configuration) – A CloudwatchLogsExportConfiguration object.

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

    If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – Required: UTF-8 string.

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

  • DBParameterGroupName  (in the CLI: --db-parameter-group-name,  or in Python: db_parameter_group_name) – UTF-8 string.

    The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

    Default: Uses existing setting

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

  • DBPortNumber  (in the CLI: --db-port-number,  or in Python: db_port_number) – Number (integer).

    The port number on which the database accepts connections.

    The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

    Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

    Default: 8182

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupName— UTF-8 strings.

    A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    • If supplied, must match existing DBSecurityGroups.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

    Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetGroup

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

  • Domain  (in the CLI: --domain,  or in Python: domain) – UTF-8 string.

    Not supported.

  • DomainIAMRoleName  (in the CLI: --domain-iam-role-name,  or in Python: domain_iam_role_name) – UTF-8 string.

    Not supported

  • EnableIAMDatabaseAuthentication  (in the CLI: --enable-iam-database-authentication,  or in Python: enable_iam_database_authentication) – Boolean.

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

    You can enable IAM database authentication for the following database engines

    Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster (action).

    Default: false

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction (action) API.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    The new Provisioned IOPS (I/O operations per second) value for the instance.

    Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Default: Uses existing setting

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    Not supported.

  • MasterUserPassword  (in the CLI: --master-user-password,  or in Python: master_user_password) – UTF-8 string.

    Not applicable.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

  • NewDBInstanceIdentifier  (in the CLI: --new-db-instance-identifier,  or in Python: new_db_instance_identifier) – UTF-8 string.

    The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    The daily time range during which automated backups are created if automated backups are enabled.

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster (action).

    Constraints:

    • Must be in the format hh24:mi-hh24:mi

    • Must be in Universal Time Coordinated (UTC)

    • Must not conflict with the preferred maintenance window

    • Must be at least 30 minutes

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    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.

    Default: 1

    Valid Values: 0 - 15

  • PubliclyAccessible  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Not supported.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which to associate the instance for TDE encryption.

  • TdeCredentialPassword  (in the CLI: --tde-credential-password,  or in Python: tde_credential_password) – UTF-8 string.

    The password for the given ARN from the key store in order to access the device.

  • VpcSecurityGroupIds  (in the CLI: --vpc-security-group-ids,  or in Python: vpc_security_group_ids) – An array of VpcSecurityGroupId— UTF-8 strings.

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster (action).

    Constraints:

    • If supplied, must match existing VpcSecurityGroupIds.

Response

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances (action) action.

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

    Specifies the allocated storage size specified in gibibytes.

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor version patches are applied automatically.

  • AvailabilityZone  (in the CLI: --availability-zone,  or in Python: availability_zone) – UTF-8 string.

    Specifies the name of the Availability Zone the DB instance is located in.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    Specifies the number of days for which automatic DB snapshots are retained.

  • CACertificateIdentifier  (in the CLI: --ca-certificate-identifier,  or in Python: ca_certificate_identifier) – UTF-8 string.

    The identifier of the CA certificate for this DB instance.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    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  (in the CLI: --db-instance-arn,  or in Python: db_instance_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB instance.

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    Contains the name of the compute and memory capacity class of the DB instance.

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – UTF-8 string.

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • DbInstancePort  (in the CLI: --db-instance-port,  or in Python: db_instance_port) – Number (integer).

    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  (in the CLI: --db-instance-status,  or in Python: db_instance_status) – UTF-8 string.

    Specifies the current state of this database.

  • DbiResourceId  (in the CLI: --dbi-resource-id,  or in Python: dbi_resource_id) – UTF-8 string.

    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  (in the CLI: --db-name,  or in Python: db_name) – UTF-8 string.

    The database name.

  • DBParameterGroups  (in the CLI: --db-parameter-groups,  or in Python: db_parameter_groups) – An array of DBParameterGroupStatus DBParameterGroup objects.

    Provides the list of DB parameter groups applied to this DB instance.

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupMembership DBSecurityGroup objects.

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – A DBSubnetGroup object.

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • DomainMemberships  (in the CLI: --domain-memberships,  or in Python: domain_memberships) – An array of DomainMembership DomainMembership objects.

    Not supported

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – An Endpoint object.

    Specifies the connection endpoint.

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • EnhancedMonitoringResourceArn  (in the CLI: --enhanced-monitoring-resource-arn,  or in Python: enhanced_monitoring_resource_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

  • InstanceCreateTime  (in the CLI: --instance-create-time,  or in Python: instance_create_time) – Timestamp.

    Provides the date and time the DB instance was created.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    Specifies the Provisioned IOPS (I/O operations per second) value.

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

    Specifies the latest time to which a database can be restored with point-in-time restore.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    License model information for this DB instance.

  • MasterUsername  (in the CLI: --master-username,  or in Python: master_username) – UTF-8 string.

    Contains the master username for the DB instance.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment.

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A PendingModifiedValues object.

    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  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    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  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • ReadReplicaDBClusterIdentifiers  (in the CLI: --read-replica-db-cluster-identifiers,  or in Python: read_replica_db_cluster_identifiers) – An array of ReadReplicaDBClusterIdentifier— UTF-8 strings.

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

  • ReadReplicaDBInstanceIdentifiers  (in the CLI: --read-replica-db-instance-identifiers,  or in Python: read_replica_db_instance_identifiers) – An array of ReadReplicaDBInstanceIdentifier— UTF-8 strings.

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  • ReadReplicaSourceDBInstanceIdentifier  (in the CLI: --read-replica-source-db-instance-identifier,  or in Python: read_replica_source_db_instance_identifier) – UTF-8 string.

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  • SecondaryAvailabilityZone  (in the CLI: --secondary-availability-zone,  or in Python: secondary_availability_zone) – UTF-8 string.

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • StatusInfos  (in the CLI: --status-infos,  or in Python: status_infos) – An array of DBInstanceStatusInfo DBInstanceStatusInfo objects.

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Specifies the storage type associated with DB instance.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which the instance is associated for TDE encryption.

  • Timezone  (in the CLI: --timezone,  or in Python: timezone) – UTF-8 string.

    Not supported.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

    Provides a list of VPC security group elements that the DB instance belongs to.

RebootDBInstance (action)

        The AWS CLI name for this API is: reboot-db-instance,  and the Python name is: reboot_db_instance.

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

Request

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – Required: UTF-8 string.

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

  • ForceFailover  (in the CLI: --force-failover,  or in Python: force_failover) – Boolean.

    When true, the reboot is conducted through a MultiAZ failover.

    Constraint: You can't specify true if the instance is not configured for MultiAZ.

Response

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances (action) action.

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

    Specifies the allocated storage size specified in gibibytes.

  • AutoMinorVersionUpgrade  (in the CLI: --auto-minor-version-upgrade,  or in Python: auto_minor_version_upgrade) – Boolean.

    Indicates that minor version patches are applied automatically.

  • AvailabilityZone  (in the CLI: --availability-zone,  or in Python: availability_zone) – UTF-8 string.

    Specifies the name of the Availability Zone the DB instance is located in.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

    Specifies the number of days for which automatic DB snapshots are retained.

  • CACertificateIdentifier  (in the CLI: --ca-certificate-identifier,  or in Python: ca_certificate_identifier) – UTF-8 string.

    The identifier of the CA certificate for this DB instance.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    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  (in the CLI: --db-instance-arn,  or in Python: db_instance_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) for the DB instance.

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    Contains the name of the compute and memory capacity class of the DB instance.

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – UTF-8 string.

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

  • DbInstancePort  (in the CLI: --db-instance-port,  or in Python: db_instance_port) – Number (integer).

    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  (in the CLI: --db-instance-status,  or in Python: db_instance_status) – UTF-8 string.

    Specifies the current state of this database.

  • DbiResourceId  (in the CLI: --dbi-resource-id,  or in Python: dbi_resource_id) – UTF-8 string.

    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  (in the CLI: --db-name,  or in Python: db_name) – UTF-8 string.

    The database name.

  • DBParameterGroups  (in the CLI: --db-parameter-groups,  or in Python: db_parameter_groups) – An array of DBParameterGroupStatus DBParameterGroup objects.

    Provides the list of DB parameter groups applied to this DB instance.

  • DBSecurityGroups  (in the CLI: --db-security-groups,  or in Python: db_security_groups) – An array of DBSecurityGroupMembership DBSecurityGroup objects.

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – A DBSubnetGroup object.

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • DomainMemberships  (in the CLI: --domain-memberships,  or in Python: domain_memberships) – An array of DomainMembership DomainMembership objects.

    Not supported

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – An Endpoint object.

    Specifies the connection endpoint.

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • EnhancedMonitoringResourceArn  (in the CLI: --enhanced-monitoring-resource-arn,  or in Python: enhanced_monitoring_resource_arn) – UTF-8 string.

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

    True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

  • InstanceCreateTime  (in the CLI: --instance-create-time,  or in Python: instance_create_time) – Timestamp.

    Provides the date and time the DB instance was created.

  • Iops  (in the CLI: --iops,  or in Python: iops) – Number (integer).

    Specifies the Provisioned IOPS (I/O operations per second) value.

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

    Specifies the latest time to which a database can be restored with point-in-time restore.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    License model information for this DB instance.

  • MasterUsername  (in the CLI: --master-username,  or in Python: master_username) – UTF-8 string.

    Contains the master username for the DB instance.

  • MonitoringInterval  (in the CLI: --monitoring-interval,  or in Python: monitoring_interval) – Number (integer).

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

  • MonitoringRoleArn  (in the CLI: --monitoring-role-arn,  or in Python: monitoring_role_arn) – UTF-8 string.

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

    Specifies if the DB instance is a Multi-AZ deployment.

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A PendingModifiedValues object.

    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  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • PromotionTier  (in the CLI: --promotion-tier,  or in Python: promotion_tier) – Number (integer).

    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  (in the CLI: --publicly-accessible,  or in Python: publicly_accessible) – Boolean.

    This flag should no longer be used.

  • ReadReplicaDBClusterIdentifiers  (in the CLI: --read-replica-db-cluster-identifiers,  or in Python: read_replica_db_cluster_identifiers) – An array of ReadReplicaDBClusterIdentifier— UTF-8 strings.

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

  • ReadReplicaDBInstanceIdentifiers  (in the CLI: --read-replica-db-instance-identifiers,  or in Python: read_replica_db_instance_identifiers) – An array of ReadReplicaDBInstanceIdentifier— UTF-8 strings.

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

  • ReadReplicaSourceDBInstanceIdentifier  (in the CLI: --read-replica-source-db-instance-identifier,  or in Python: read_replica_source_db_instance_identifier) – UTF-8 string.

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

  • SecondaryAvailabilityZone  (in the CLI: --secondary-availability-zone,  or in Python: secondary_availability_zone) – UTF-8 string.

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • StatusInfos  (in the CLI: --status-infos,  or in Python: status_infos) – An array of DBInstanceStatusInfo DBInstanceStatusInfo objects.

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Not supported: The encryption for DB instances is managed by the DB cluster.

  • StorageType  (in the CLI: --storage-type,  or in Python: storage_type) – UTF-8 string.

    Specifies the storage type associated with DB instance.

  • TdeCredentialArn  (in the CLI: --tde-credential-arn,  or in Python: tde_credential_arn) – UTF-8 string.

    The ARN from the key store with which the instance is associated for TDE encryption.

  • Timezone  (in the CLI: --timezone,  or in Python: timezone) – UTF-8 string.

    Not supported.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

    Provides a list of VPC security group elements that the DB instance belongs to.

DescribeDBInstances (action)

        The AWS CLI name for this API is: describe-db-instances,  and the Python name is: describe_db_instances.

Returns information about provisioned instances, and supports pagination.

Note

This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

Request

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – UTF-8 string.

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBInstance.

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    A filter that specifies one or more DB instances to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

    • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

    For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned, you could use the following command:

    aws neptune describe-db-instances \ --filters Name=engine,Values=neptune
  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Response

  • DBInstances  (in the CLI: --db-instances,  or in Python: db_instances) – An array of DBInstance DBInstance objects.

    A list of DBInstance (structure) instances.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

DescribeOrderableDBInstanceOptions (action)

        The AWS CLI name for this API is: describe-orderable-db-instance-options,  and the Python name is: describe_orderable_db_instance_options.

Returns a list of orderable DB instance options for the specified engine.

Request

  • DBInstanceClass  (in the CLI: --db-instance-class,  or in Python: db_instance_class) – UTF-8 string.

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

  • Engine  (in the CLI: --engine,  or in Python: engine) – Required: UTF-8 string.

    The name of the engine to retrieve DB instance options for.

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • LicenseModel  (in the CLI: --license-model,  or in Python: license_model) – UTF-8 string.

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Vpc  (in the CLI: --vpc,  or in Python: vpc) – Boolean.

    The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Response

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

  • OrderableDBInstanceOptions  (in the CLI: --orderable-db-instance-options,  or in Python: orderable_db_instance_options) – An array of OrderableDBInstanceOption OrderableDBInstanceOption objects.

    An OrderableDBInstanceOption (structure) structure containing information about orderable options for the DB instance.

DescribeValidDBInstanceModifications (action)

        The AWS CLI name for this API is: describe-valid-db-instance-modifications,  and the Python name is: describe_valid_db_instance_modifications.

You can call DescribeValidDBInstanceModifications (action) to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance (action).

Request

  • DBInstanceIdentifier  (in the CLI: --db-instance-identifier,  or in Python: db_instance_identifier) – Required: UTF-8 string.

    The customer identifier or the ARN of your DB instance.

Response

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications (action) action. You can use this information when you call ModifyDBInstance (action).

  • Storage  (in the CLI: --storage,  or in Python: storage) – An array of ValidStorageOptions— a structures.

    Valid storage options for your DB instance.