String subscriptionName
The name of the event notification subscription you want to add a source identifier to.
String sourceIdentifier
The identifier of the event source to be added.
Constraints:
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
String resourceName
The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
List<E> tags
The tags to be assigned to the Amazon Neptune resource.
String resourceIdentifier
The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
String applyAction
The pending maintenance action to apply to this resource.
Valid values: system-update, db-upgrade
String optInType
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type
immediate can't be undone.
Valid values:
immediate - Apply the maintenance action immediately.
next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
undo-opt-in - Cancel any existing next-maintenance opt-in requests.
String name
The name of the availability zone.
String sourceDBClusterParameterGroupIdentifier
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB cluster parameter group.
If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter
group identifier, for example my-db-cluster-param-group, or a valid ARN.
If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter
group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
String targetDBClusterParameterGroupIdentifier
The identifier for the copied DB cluster parameter group.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-cluster-param-group1
String targetDBClusterParameterGroupDescription
A description for the copied DB cluster parameter group.
List<E> tags
The tags to be assigned to the copied DB cluster parameter group.
String sourceDBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
You can't copy from one AWS Region to another.
Constraints:
Must specify a valid system snapshot in the "available" state.
Specify a valid DB snapshot identifier.
Example: my-cluster-snapshot1
String targetDBClusterSnapshotIdentifier
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.
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: my-cluster-snapshot2
String kmsKeyId
The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter,
Amazon Neptune encrypts the target DB cluster snapshot using the specified KMS encryption key.
If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for
KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for
KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source
DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a
value for KmsKeyId.
KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
String preSignedUrl
Not currently supported.
Boolean copyTags
True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.
List<E> tags
The tags to assign to the new DB cluster snapshot copy.
String sourceDBParameterGroupIdentifier
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
Constraints:
Must specify a valid DB parameter group.
Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
String targetDBParameterGroupIdentifier
The identifier for the copied DB parameter group.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-db-parameter-group
String targetDBParameterGroupDescription
A description for the copied DB parameter group.
List<E> tags
The tags to be assigned to the copied DB parameter group.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must match the name of an existing DBClusterParameterGroup.
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
String description
The description for the DB cluster parameter group.
List<E> tags
The tags to be assigned to the new DB cluster parameter group.
List<E> availabilityZones
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
Integer backupRetentionPeriod
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
String characterSetName
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
String databaseName
The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
String dBClusterIdentifier
The DB cluster 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: my-cluster1
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
String dBSubnetGroupName
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
String engine
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
String engineVersion
The version number of the database engine to use.
Example: 1.0.1
Integer port
The port number on which the instances in the DB cluster accept connections.
Default: 8182
String masterUsername
The name of the master user for the DB cluster.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
String masterUserPassword
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
A value that indicates that the DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range 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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
String replicationSourceIdentifier
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
List<E> tags
The tags to assign to the new DB cluster.
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.
String kmsKeyId
The AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the
encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not
specified, 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.
If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId
to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that
AWS Region.
String preSignedUrl
This parameter is not currently supported.
Boolean enableIAMDatabaseAuthentication
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
List<E> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot. 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: my-cluster1-snapshot1
String dBClusterIdentifier
The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
Example: my-cluster1
List<E> tags
The tags to be assigned to the DB cluster snapshot.
String dBName
Not supported.
String dBInstanceIdentifier
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
Integer allocatedStorage
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.
String dBInstanceClass
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.
String engine
The name of the database engine to be used for this instance.
Valid Values: neptune
String masterUsername
The name for the master user. Not used.
String masterUserPassword
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Not used.
List<E> dBSecurityGroups
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
List<E> vpcSecurityGroupIds
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.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
String availabilityZone
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.
String dBSubnetGroupName
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.
String preferredMaintenanceWindow
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.
String dBParameterGroupName
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
Integer backupRetentionPeriod
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.
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
String preferredBackupWindow
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.
Integer port
The port number on which the database accepts connections.
Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 8182
Type: Integer
Boolean multiAZ
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.
String engineVersion
The version number of the database engine to use.
Boolean autoMinorVersionUpgrade
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
String licenseModel
License model information for this DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
String optionGroupName
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
String characterSetName
Indicates that the DB instance should be associated with the specified CharacterSet.
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
Boolean publiclyAccessible
This flag should no longer be used.
List<E> tags
The tags to assign to the new instance.
String dBClusterIdentifier
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
String storageType
Specifies the storage type to be associated with the DB instance.
Not applicable. Storage is managed by the DB Cluster.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
Boolean storageEncrypted
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.
Default: false
String kmsKeyId
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.
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.
String domain
Specify the Active Directory Domain to create the instance in.
Boolean copyTagsToSnapshot
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
Integer monitoringInterval
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
String monitoringRoleArn
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.
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Integer promotionTier
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
String timezone
The time zone of the DB instance.
Boolean enableIAMDatabaseAuthentication
True to enable AWS Identity and Access Management (IAM) authentication for Neptune.
Default: false
Boolean enablePerformanceInsights
True to enable Performance Insights for the DB instance, and otherwise false.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
List<E> enableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to CloudWatch Logs.
String dBParameterGroupName
The name of the DB parameter group.
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
This value is stored as a lowercase string.
String dBParameterGroupFamily
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
String description
The description for the DB parameter group.
List<E> tags
The tags to be assigned to the new DB parameter group.
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
List<E> subnetIds
The EC2 Subnet IDs for the DB subnet group.
List<E> tags
The tags to be assigned to the new DB subnet group.
String subscriptionName
The name of the subscription.
Constraints: The name must be less than 255 characters.
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
String sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group |
db-security-group | db-snapshot | db-cluster-snapshot
List<E> eventCategories
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
List<E> sourceIds
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If SourceIds are supplied, SourceType must also be provided.
If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
If the source type is a DB security group, a DBSecurityGroupName must be supplied.
If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
Boolean enabled
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
List<E> tags
The tags to be applied to the new event subscription.
Integer allocatedStorage
AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead
automatically adjusts as needed.
List<E> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
String characterSetName
If present, specifies the name of the character set that this cluster is associated with.
String databaseName
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
String dBClusterParameterGroup
Specifies the name of the DB cluster parameter group for the DB cluster.
String dBSubnetGroup
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
String status
Specifies the current state of this DB cluster.
String percentProgress
Specifies the progress of the operation as a percentage.
Date earliestRestorableTime
Specifies the earliest time to which a database can be restored with point-in-time restore.
String endpoint
Specifies the connection endpoint for the primary instance of the DB cluster.
String readerEndpoint
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.
If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.
Boolean multiAZ
Specifies whether the DB cluster has instances in multiple Availability Zones.
String engine
Provides the name of the database engine to be used for this DB cluster.
String engineVersion
Indicates the database engine version.
Date latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
Integer port
Specifies the port that the database engine is listening on.
String masterUsername
Contains the master username for the DB cluster.
List<E> dBClusterOptionGroupMemberships
Provides the list of option group memberships for this DB cluster.
String preferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
String replicationSourceIdentifier
Not supported by Neptune.
List<E> readReplicaIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
List<E> dBClusterMembers
Provides the list of instances that make up the DB cluster.
List<E> vpcSecurityGroups
Provides a list of VPC security groups that the DB cluster belongs to.
String hostedZoneId
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
String dbClusterResourceId
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
String dBClusterArn
The Amazon Resource Name (ARN) for the DB cluster.
List<E> associatedRoles
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
String cloneGroupId
Identifies the clone group to which the DB cluster is associated.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
List<E> enabledCloudwatchLogsExports
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
String dBInstanceIdentifier
Specifies the instance identifier for this member of the DB cluster.
Boolean isClusterWriter
Value that is true if the cluster member is the primary instance for the DB cluster and
false otherwise.
String dBClusterParameterGroupStatus
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
Integer promotionTier
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.
String dBClusterParameterGroupName
Provides the name of the DB cluster parameter group.
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
String description
Provides the customer-specified description for this DB cluster parameter group.
String dBClusterParameterGroupArn
The Amazon Resource Name (ARN) for the DB cluster parameter group.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
String status
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS
services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume
the IAM role in order to access other AWS services on your behalf.
List<E> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
String dBClusterSnapshotIdentifier
Specifies the identifier for the DB cluster snapshot.
String dBClusterIdentifier
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
String engine
Specifies the name of the database engine.
Integer allocatedStorage
Specifies the allocated storage size in gibibytes (GiB).
String status
Specifies the status of this DB cluster snapshot.
Integer port
Specifies the port that the DB cluster was listening on at the time of the snapshot.
String vpcId
Provides the VPC ID associated with the DB cluster snapshot.
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
String masterUsername
Provides the master username for the DB cluster snapshot.
String engineVersion
Provides the version of the database engine for this DB cluster snapshot.
String licenseModel
Provides the license model information for this DB cluster snapshot.
String snapshotType
Provides the type of the DB cluster snapshot.
Integer percentProgress
Specifies the percentage of the estimated data that has been transferred.
Boolean storageEncrypted
Specifies whether the DB cluster snapshot is encrypted.
String kmsKeyId
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
String dBClusterSnapshotArn
The Amazon Resource Name (ARN) for the DB cluster snapshot.
String sourceDBClusterSnapshotArn
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
Boolean iAMDatabaseAuthenticationEnabled
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
String attributeName
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of AWS accounts that have permission to copy or
restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API
action.
List<E> attributeValues
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore, then this element returns a list of IDs
of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of
all is in the list, then the manual DB cluster snapshot is public and available for any AWS account
to copy or restore.
String engine
The name of the database engine.
String engineVersion
The version number of the database engine.
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.
String dBEngineDescription
The description of the database engine.
String dBEngineVersionDescription
The description of the database engine version.
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if the CharacterSetName
parameter of the CreateDBInstance API is not specified.
List<E> supportedCharacterSets
A list of the character sets supported by this engine for the CharacterSetName parameter of the
CreateDBInstance action.
List<E> validUpgradeTarget
A list of engine versions that this database engine version can be upgraded to.
List<E> supportedTimezones
A list of the time zones supported by this engine for the Timezone parameter of the
CreateDBInstance action.
List<E> exportableLogTypes
The types of logs that the database engine has available for export to CloudWatch Logs.
Boolean supportsLogExportsToCloudwatchLogs
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
Boolean supportsReadReplica
Indicates whether the database engine version supports read replicas.
String dBInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
String dBInstanceClass
Contains the name of the compute and memory capacity class of the DB instance.
String engine
Provides the name of the database engine to be used for this DB instance.
String dBInstanceStatus
Specifies the current state of this database.
String masterUsername
Contains the master username for the DB instance.
String dBName
The database name.
Endpoint endpoint
Specifies the connection endpoint.
Integer allocatedStorage
Specifies the allocated storage size specified in gibibytes.
Date instanceCreateTime
Provides the date and time the DB instance was created.
String preferredBackupWindow
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod.
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are retained.
List<E> dBSecurityGroups
Provides List of DB security group elements containing only DBSecurityGroup.Name and
DBSecurityGroup.Status subelements.
List<E> vpcSecurityGroups
Provides a list of VPC security group elements that the DB instance belongs to.
List<E> dBParameterGroups
Provides the list of DB parameter groups applied to this DB instance.
String availabilityZone
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup dBSubnetGroup
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues 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.
Date latestRestorableTime
Specifies the latest time to which a database can be restored with point-in-time restore.
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
Boolean autoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.
String readReplicaSourceDBInstanceIdentifier
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
List<E> readReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with this DB instance.
List<E> readReplicaDBClusterIdentifiers
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
String licenseModel
License model information for this DB instance.
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value.
List<E> optionGroupMemberships
Provides the list of option group memberships for this DB instance.
String characterSetName
If present, specifies the name of the character set that this instance is associated with.
String secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Boolean publiclyAccessible
This flag should no longer be used.
List<E> statusInfos
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
String storageType
Specifies the storage type associated with DB instance.
String tdeCredentialArn
The ARN from the key store with which the instance is associated for TDE encryption.
Integer dbInstancePort
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.
String dBClusterIdentifier
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.
Boolean storageEncrypted
Not supported: The encryption for DB instances is managed by the DB cluster.
String kmsKeyId
Not supported: The encryption for DB instances is managed by the DB cluster.
String dbiResourceId
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.
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.
List<E> domainMemberships
Not supported
Boolean copyTagsToSnapshot
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
String enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
String monitoringRoleArn
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
Integer promotionTier
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.
String dBInstanceArn
The Amazon Resource Name (ARN) for the DB instance.
String timezone
Not supported.
Boolean iAMDatabaseAuthenticationEnabled
True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
Boolean performanceInsightsEnabled
True if Performance Insights is enabled for the DB instance, and otherwise false.
String performanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
List<E> enabledCloudwatchLogsExports
A list of log types that this DB instance is configured to export to CloudWatch Logs.
String statusType
This value is currently "read replication."
Boolean normal
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
String status
Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
String message
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.
String dBParameterGroupName
Provides the name of the DB parameter group.
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB parameter group is compatible with.
String description
Provides the customer-specified description for this DB parameter group.
String dBParameterGroupArn
The Amazon Resource Name (ARN) for the DB parameter group.
String dBSubnetGroupName
The name of the DB subnet group.
String dBSubnetGroupDescription
Provides the description of the DB subnet group.
String vpcId
Provides the VpcId of the DB subnet group.
String subnetGroupStatus
Provides the status of the DB subnet group.
List<E> subnets
Contains a list of Subnet elements.
String dBSubnetGroupArn
The Amazon Resource Name (ARN) for the DB subnet group.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
Constraints:
Must be the name of an existing DB cluster parameter group.
You can't delete a default DB cluster parameter group.
Cannot be associated with any DB clusters.
String dBClusterIdentifier
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
Boolean skipFinalSnapshot
Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true
is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is
created before the DB cluster is deleted.
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is
false.
Default: false
String finalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is
set to false.
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an
error.
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
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
String dBInstanceIdentifier
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.
Boolean skipFinalSnapshot
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.
The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
Default: false
String finalDBSnapshotIdentifier
The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
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.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must be the name of an existing DB parameter group
You can't delete a default DB parameter group
Cannot be associated with any DB instances
String dBSubnetGroupName
The name of the database subnet group to delete.
You can't delete the default subnet group.
Constraints:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
String subscriptionName
The name of the event notification subscription you want to delete.
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If
this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String marker
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If
this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
List<E> dBClusterParameterGroups
A list of DB cluster parameter groups.
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
String source
A value that indicates to return only parameters for a specific source. Parameter sources can be
engine, service, or customer.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
List<E> parameters
Provides a list of parameters for the DB cluster parameter group.
String marker
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is
specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords .
String dBClusterSnapshotIdentifier
The identifier for the DB cluster snapshot to describe the attributes for.
String dBClusterIdentifier
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in
conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
String dBClusterSnapshotIdentifier
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
String snapshotType
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for
my AWS account.
manual - Return all DB cluster snapshots that have been taken by my AWS account.
shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
public - Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are
returned. You can include shared DB cluster snapshots with these results by setting the
IncludeShared parameter to true. You can include public DB cluster snapshots with these
results by setting the IncludePublic parameter to true.
The IncludeShared and IncludePublic parameters don't apply for
SnapshotType values of manual or automated. The IncludePublic
parameter doesn't apply when SnapshotType is set to shared. The
IncludeShared parameter doesn't apply when SnapshotType is set to public.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
Boolean includeShared
True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, and otherwise false. The default is false.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
Boolean includePublic
True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and
otherwise false. The default is false. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
String marker
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
List<E> dBClusterSnapshots
Provides a list of DB cluster snapshots for the user.
String dBClusterIdentifier
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match an existing DBClusterIdentifier.
List<E> filters
A filter that specifies one or more DB clusters 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 clusters identified by these ARNs.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is
specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String engine
The database engine to return.
String engineVersion
The database engine version to return.
Example: 5.1.49
String dBParameterGroupFamily
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
List<E> filters
Not currently supported.
Integer maxRecords
The maximum number of records to include in the response. If more than the MaxRecords value is
available, a pagination token called a marker is included in the response so that the following results can be
retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
String marker
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.
Boolean defaultOnly
Indicates that only the default version of the specified engine or engine and major version combination is returned.
Boolean listSupportedCharacterSets
If this parameter is specified and the requested engine supports the CharacterSetName parameter for
CreateDBInstance, the response includes a list of supported character sets for each engine version.
Boolean listSupportedTimezones
If this parameter is specified and the requested engine supports the TimeZone parameter for
CreateDBInstance, the response includes a list of supported time zones for each engine version.
String dBInstanceIdentifier
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.
List<E> filters
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.
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
results list will only include information about the DB instances identified by these ARNs.
Integer maxRecords
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.
String marker
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.
String marker
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 .
List<E> dBInstances
A list of DBInstance instances.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBParameterGroups request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String marker
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.
List<E> dBParameterGroups
A list of DBParameterGroup instances.
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
String source
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBParameters request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String dBSubnetGroupName
The name of the DB subnet group to return details for.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is
specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String marker
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.
List<E> dBSubnetGroups
A list of DBSubnetGroup instances.
String dBParameterGroupFamily
The name of the DB cluster parameter group family to return engine parameter information for.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request.
If this parameter is specified, the response includes only records beyond the marker, up to the value specified
by MaxRecords.
String dBParameterGroupFamily
The name of the DB parameter group family.
List<E> filters
Not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords.
String sourceIdentifier
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.
String sourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Date startTime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Date endTime
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Integer duration
The number of minutes to retrieve events for.
Default: 60
List<E> eventCategories
A list of event categories that trigger notifications for a event notification subscription.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by MaxRecords.
String subscriptionName
The name of the event notification subscription you want to describe.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
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 .
String marker
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.
List<E> eventSubscriptionsList
A list of EventSubscriptions data types.
String engine
The name of the engine to retrieve DB instance options for.
String engineVersion
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
String licenseModel
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
Boolean vpc
The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
List<E> filters
This parameter is not currently supported.
Integer maxRecords
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.
String marker
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 .
List<E> orderableDBInstanceOptions
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
String marker
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 .
String resourceIdentifier
The ARN of a resource to return pending maintenance actions for.
List<E> filters
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include pending maintenance actions for the DB clusters identified by these ARNs.
db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only
include pending maintenance actions for the DB instances identified by these ARNs.
String marker
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
this parameter is specified, the response includes only records beyond the marker, up to a number of records
specified by MaxRecords.
Integer maxRecords
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.
List<E> pendingMaintenanceActions
A list of the pending maintenance actions for the resource.
String marker
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
this parameter is specified, the response includes only records beyond the marker, up to a number of records
specified by MaxRecords.
String dBInstanceIdentifier
The customer identifier or the ARN of your DB instance.
String domain
The identifier of the Active Directory Domain.
String status
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
String fQDN
The fully qualified domain name of the Active Directory Domain.
String iAMRoleName
The name of the IAM role to be used when making API calls to the Directory Service.
String dBParameterGroupFamily
Specifies the name of the DB parameter group family that the engine default parameters apply to.
String marker
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the
response includes only records beyond the marker, up to the value specified by MaxRecords .
List<E> parameters
Contains a list of engine default parameters.
String sourceIdentifier
Provides the identifier for the source of the event.
String sourceType
Specifies the source type for this event.
String message
Provides the text of this event.
List<E> eventCategories
Specifies the category for the event.
Date date
Specifies the date and time of the event.
String sourceArn
The Amazon Resource Name (ARN) for the event.
String customerAwsId
The AWS customer account associated with the event notification subscription.
String custSubscriptionId
The event notification subscription Id.
String snsTopicArn
The topic ARN of the event notification subscription.
String status
The status of the event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
String subscriptionCreationTime
The time the event notification subscription was created.
String sourceType
The source type for the event notification subscription.
List<E> sourceIdsList
A list of source IDs for the event notification subscription.
List<E> eventCategoriesList
A list of event categories for the event notification subscription.
Boolean enabled
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
String eventSubscriptionArn
The Amazon Resource Name (ARN) for the event subscription.
String dBClusterIdentifier
A DB cluster identifier to force a failover for. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
String targetDBInstanceIdentifier
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Read Replica in the DB cluster. For example,
mydbcluster-replica1.
String resourceName
The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
List<E> filters
This parameter is not currently supported.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
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
This value is stored as a lowercase string.
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
String newDBClusterIdentifier
The new DB cluster identifier for the DB cluster when renaming a DB cluster. 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: my-cluster2
Boolean applyImmediately
A value that 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
cluster. If this parameter is set to false, changes to the DB cluster are applied during the next
maintenance window.
The ApplyImmediately parameter only affects the NewDBClusterIdentifier and
MasterUserPassword values. If you set the ApplyImmediately parameter value to false,
then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
during the next maintenance window. All other changes are applied immediately, regardless of the value of the
ApplyImmediately parameter.
Default: false
Integer backupRetentionPeriod
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
String dBClusterParameterGroupName
The name of the DB cluster parameter group to use for the DB cluster.
List<E> vpcSecurityGroupIds
A list of VPC security groups that the DB cluster will belong to.
Integer port
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String masterUserPassword
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
String optionGroupName
A value that indicates that the DB cluster should be associated with the specified option group. Changing this
parameter doesn't result in an outage except in the following case, and the change is applied during the next
maintenance window unless the ApplyImmediately parameter is set to true for this
request. If the parameter change results in an option group that enables OEM, this change can cause a brief
(sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
String preferredMaintenanceWindow
The weekly time range 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.
Boolean enableIAMDatabaseAuthentication
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
String engineVersion
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.
For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
String dBClusterSnapshotIdentifier
The identifier for the DB cluster snapshot to modify the attributes for.
String attributeName
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to
restore.
List<E> valuesToAdd
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or
more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account.
Do not add the all value for any manual DB cluster snapshots that contain private information that
you don't want available to all AWS accounts.
List<E> valuesToRemove
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to
include one or more AWS account identifiers, or all to remove authorization for any AWS account to
copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is
explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Integer allocatedStorage
The new amount of storage (in gibibytes) to allocate for the DB instance.
Not applicable. Storage is managed by the DB Cluster.
String dBInstanceClass
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
String dBSubnetGroupName
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
List<E> dBSecurityGroups
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.
List<E> vpcSecurityGroupIds
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.
Constraints:
If supplied, must match existing VpcSecurityGroupIds.
Boolean applyImmediately
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, or the next failure reboot.
Default: false
String masterUserPassword
Not applicable.
String dBParameterGroupName
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.
Integer backupRetentionPeriod
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
String preferredBackupWindow
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.
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
String preferredMaintenanceWindow
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
Boolean multiAZ
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.
String engineVersion
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the
change is applied during the next maintenance window unless the ApplyImmediately parameter is set to
true for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
Boolean allowMajorVersionUpgrade
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.
Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
Boolean autoMinorVersionUpgrade
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.
String licenseModel
Not supported.
Integer iops
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
String optionGroupName
Indicates that the DB instance should be associated with the specified option group. Changing this parameter
doesn't result in an outage except in the following case and the change is applied during the next maintenance
window unless the ApplyImmediately parameter is set to true for this request. If the
parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period
during which new connections are rejected but existing connections are not interrupted.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
String newDBInstanceIdentifier
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
String storageType
Not supported.
String tdeCredentialArn
The ARN from the key store with which to associate the instance for TDE encryption.
String tdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
String cACertificateIdentifier
Indicates the certificate that needs to be associated with the instance.
String domain
Not supported.
Boolean copyTagsToSnapshot
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
Integer monitoringInterval
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
Integer dBPortNumber
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
Boolean publiclyAccessible
This flag should no longer be used.
String monitoringRoleArn
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.
String domainIAMRoleName
Not supported
Integer promotionTier
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
Boolean enableIAMDatabaseAuthentication
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.
Default: false
Boolean enablePerformanceInsights
Not supported.
String performanceInsightsKMSKeyId
Not supported.
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
List<E> parameters
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
String dBParameterGroupName
Provides the name of the DB parameter group.
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
String dBSubnetGroupDescription
The description for the DB subnet group.
List<E> subnetIds
The EC2 subnet IDs for the DB subnet group.
String subscriptionName
The name of the event notification subscription.
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
String sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
List<E> eventCategories
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
Boolean enabled
A Boolean value; set to true to activate the subscription.
String optionGroupName
The name of the option group that the instance belongs to.
String status
The status of the DB instance's option group membership. Valid values are: in-sync,
pending-apply, pending-removal, pending-maintenance-apply,
pending-maintenance-removal, applying, removing, and failed.
String engine
The engine type of a DB instance.
String engineVersion
The engine version of a DB instance.
String dBInstanceClass
The DB instance class for a DB instance.
String licenseModel
The license model for a DB instance.
List<E> availabilityZones
A list of Availability Zones for a DB instance.
Boolean multiAZCapable
Indicates whether a DB instance is Multi-AZ capable.
Boolean readReplicaCapable
Indicates whether a DB instance can have a Read Replica.
Boolean vpc
Indicates whether a DB instance is in a VPC.
Boolean supportsStorageEncryption
Indicates whether a DB instance supports encrypted storage.
String storageType
Indicates the storage type for a DB instance.
Boolean supportsIops
Indicates whether a DB instance supports provisioned IOPS.
Boolean supportsEnhancedMonitoring
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
Boolean supportsIAMDatabaseAuthentication
Indicates whether a DB instance supports IAM database authentication.
Boolean supportsPerformanceInsights
True if a DB instance supports Performance Insights, otherwise false.
Integer minStorageSize
Minimum storage size for a DB instance.
Integer maxStorageSize
Maximum storage size for a DB instance.
Integer minIopsPerDbInstance
Minimum total provisioned IOPS for a DB instance.
Integer maxIopsPerDbInstance
Maximum total provisioned IOPS for a DB instance.
Double minIopsPerGib
Minimum provisioned IOPS per GiB for a DB instance.
Double maxIopsPerGib
Maximum provisioned IOPS per GiB for a DB instance.
String parameterName
Specifies the name of the parameter.
String parameterValue
Specifies the value of the parameter.
String description
Provides a description of the parameter.
String source
Indicates the source of the parameter value.
String applyType
Specifies the engine specific parameters type.
String dataType
Specifies the valid data type for the parameter.
String allowedValues
Specifies the valid range of values for the parameter.
Boolean isModifiable
Indicates whether (true) or not (false) the parameter can be modified. Some parameters
have security or operational implications that prevent them from being changed.
String minimumEngineVersion
The earliest engine version to which the parameter can apply.
String applyMethod
Indicates when to apply parameter updates.
List<E> logTypesToEnable
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
List<E> logTypesToDisable
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
String action
The type of pending maintenance action that is available for the resource.
Date autoAppliedAfterDate
The date of the maintenance window when the action is applied. The maintenance action is applied to the resource
during its first maintenance window after this date. If this date is specified, any next-maintenance
opt-in requests are ignored.
Date forcedApplyDate
The date when the maintenance action is automatically applied. The maintenance action is applied to the resource
on this date regardless of the maintenance window for the resource. If this date is specified, any
immediate opt-in requests are ignored.
String optInStatus
Indicates the type of opt-in request that has been received for the resource.
Date currentApplyDate
The effective date when the pending maintenance action is applied to the resource. This date takes into account
opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate
, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and
nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
String description
A description providing more detail about the maintenance action.
String dBInstanceClass
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being
applied.
Integer allocatedStorage
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently
being applied.
String masterUserPassword
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Integer port
Specifies the pending port for the DB instance.
Integer backupRetentionPeriod
Specifies the pending number of days for which automated backups are retained.
Boolean multiAZ
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
String engineVersion
Indicates the database engine version.
String licenseModel
The license model for the DB instance.
Valid values: license-included | bring-your-own-license |
general-public-license
Integer iops
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being
applied.
String storageType
Specifies the storage type to be associated with the DB instance.
String cACertificateIdentifier
Specifies the identifier of the CA certificate for the DB instance.
String dBSubnetGroupName
The new DB subnet group for the DB instance.
PendingCloudwatchLogsExports pendingCloudwatchLogsExports
Specifies the CloudWatch logs to be exported.
String dBClusterIdentifier
Not supported.
Integer from
The minimum value in the range.
Integer to
The maximum value in the range.
Integer step
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
Boolean forceFailover
When true, the reboot is conducted through a MultiAZ failover.
Constraint: You can't specify true if the instance is not configured for MultiAZ.
String subscriptionName
The name of the event notification subscription you want to remove a source identifier from.
String sourceIdentifier
The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
String resourceName
The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
List<E> tagKeys
The tag key (name) of the tag to be removed.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to reset.
Boolean resetAllParameters
A value that is set to true to reset all parameters in the DB cluster parameter group to their
default values, and false otherwise. You can't use this parameter if there is a list of parameter
names specified for the Parameters parameter.
List<E> parameters
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this
parameter if the ResetAllParameters parameter is set to true.
String dBClusterParameterGroupName
The name of the DB cluster parameter group.
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
This value is stored as a lowercase string.
String dBParameterGroupName
The name of the DB parameter group.
Constraints:
Must match the name of an existing DBParameterGroup.
Boolean resetAllParameters
Specifies whether (true) or not (false) to reset all parameters in the DB parameter
group to default values.
Default: true
List<E> parameters
To reset the entire DB parameter group, specify the DBParameterGroup name and
ResetAllParameters parameters. To reset specific parameters, provide a list of the following:
ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single
request.
Valid Values (for Apply method): pending-reboot
String dBParameterGroupName
Provides the name of the DB parameter group.
List<E> availabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
String dBClusterIdentifier
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
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: my-snapshot-id
String snapshotIdentifier
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
String engine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
String engineVersion
The version of the database engine to use for the new DB cluster.
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
String databaseName
Not supported.
String optionGroupName
The name of the option group to use for the restored DB cluster.
List<E> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
List<E> tags
The tags to be assigned to the restored DB cluster.
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the KmsKeyId parameter, then the following will occur:
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored
DB cluster is not encrypted.
Boolean enableIAMDatabaseAuthentication
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
List<E> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
String dBClusterIdentifier
The name of the new DB cluster to be created.
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
String restoreType
The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
source DB cluster.
String sourceDBClusterIdentifier
The identifier of the source DB cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
Date restoreToTime
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter is not provided
Cannot be specified if UseLatestRestorableTime parameter is true
Cannot be specified if RestoreType parameter is copy-on-write
Example: 2015-03-07T23:45:00Z
Boolean useLatestRestorableTime
A value that is set to true to restore the DB cluster to the latest restorable backup time, and
false otherwise.
Default: false
Constraints: Cannot be specified if RestoreToTime parameter is provided.
Integer port
The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
String dBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
String optionGroupName
The name of the option group for the new DB cluster.
List<E> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster belongs to.
List<E> tags
The tags to be applied to the restored DB cluster.
String kmsKeyId
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS
key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the
KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following will occur:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is
rejected.
Boolean enableIAMDatabaseAuthentication
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
List<E> enableCloudwatchLogsExports
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
String subnetIdentifier
Specifies the identifier of the subnet.
AvailabilityZone subnetAvailabilityZone
Specifies the EC2 Availability Zone that the subnet is in.
String subnetStatus
Specifies the status of the subnet.
String key
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String value
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
String timezoneName
The name of the time zone.
String engine
The name of the upgrade target database engine.
String engineVersion
The version number of the upgrade target database engine.
String description
The version of the database engine that a DB instance can be upgraded to.
Boolean autoUpgrade
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
Boolean isMajorVersionUpgrade
A value that indicates whether a database engine is upgraded to a major version.
String storageType
The valid storage types for your DB instance. For example, gp2, io1.
List<E> storageSize
The valid range of storage in gibibytes. For example, 100 to 16384.
List<E> provisionedIops
The valid range of provisioned IOPS. For example, 1000-20000.
List<E> iopsToStorageRatio
The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
Copyright © 2019. All rights reserved.