Package software.amazon.awssdk.services.neptune.model

Interface CreateDbInstanceRequest.Builder

    • Method Detail

      • dbName

        CreateDbInstanceRequest.Builder dbName​(String dbName)

        Not supported.

        Parameters:
        dbName - Not supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceIdentifier

        CreateDbInstanceRequest.Builder dbInstanceIdentifier​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • allocatedStorage

        CreateDbInstanceRequest.Builder allocatedStorage​(Integer allocatedStorage)

        Not supported by Neptune.

        Parameters:
        allocatedStorage - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbInstanceClass

        CreateDbInstanceRequest.Builder dbInstanceClass​(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 Amazon Regions.

        Parameters:
        dbInstanceClass - The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Regions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        CreateDbInstanceRequest.Builder engine​(String engine)

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

        Valid Values: neptune

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

        Valid Values: neptune

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        CreateDbInstanceRequest.Builder masterUsername​(String masterUsername)

        Not supported by Neptune.

        Parameters:
        masterUsername - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUserPassword

        CreateDbInstanceRequest.Builder masterUserPassword​(String masterUserPassword)

        Not supported by Neptune.

        Parameters:
        masterUserPassword - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        CreateDbInstanceRequest.Builder dbSecurityGroups​(Collection<String> dbSecurityGroups)

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

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

        Parameters:
        dbSecurityGroups - A list of DB security groups to associate with this DB instance.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSecurityGroups

        CreateDbInstanceRequest.Builder dbSecurityGroups​(String... dbSecurityGroups)

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

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

        Parameters:
        dbSecurityGroups - A list of DB security groups to associate with this DB instance.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        CreateDbInstanceRequest.Builder vpcSecurityGroupIds​(Collection<String> 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        CreateDbInstanceRequest.Builder vpcSecurityGroupIds​(String... 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        CreateDbInstanceRequest.Builder availabilityZone​(String availabilityZone)

        The EC2 Availability Zone that the DB instance is created in

        Default: A random, system-chosen Availability Zone in the endpoint's Amazon 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 Amazon Region as the current endpoint.

        Parameters:
        availabilityZone - The EC2 Availability Zone that the DB instance is created in

        Default: A random, system-chosen Availability Zone in the endpoint's Amazon 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 Amazon Region as the current endpoint.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroupName

        CreateDbInstanceRequest.Builder dbSubnetGroupName​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        CreateDbInstanceRequest.Builder preferredMaintenanceWindow​(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 Amazon Region, occurring on a random day of the week.

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

        Constraints: Minimum 30-minute window.

        Parameters:
        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 Amazon Region, occurring on a random day of the week.

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

        Constraints: Minimum 30-minute window.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbParameterGroupName

        CreateDbInstanceRequest.Builder dbParameterGroupName​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        CreateDbInstanceRequest.Builder backupRetentionPeriod​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredBackupWindow

        CreateDbInstanceRequest.Builder preferredBackupWindow​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        CreateDbInstanceRequest.Builder port​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • multiAZ

        CreateDbInstanceRequest.Builder multiAZ​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        CreateDbInstanceRequest.Builder engineVersion​(String engineVersion)

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

        Parameters:
        engineVersion - The version number of the database engine to use. Currently, setting this parameter has no effect.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMinorVersionUpgrade

        CreateDbInstanceRequest.Builder autoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

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

        Default: true

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

        Default: true

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • licenseModel

        CreateDbInstanceRequest.Builder licenseModel​(String licenseModel)

        License model information for this DB instance.

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

        Parameters:
        licenseModel - License model information for this DB instance.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • iops

        CreateDbInstanceRequest.Builder iops​(Integer iops)

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

        Parameters:
        iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupName

        CreateDbInstanceRequest.Builder optionGroupName​(String optionGroupName)

        (Not supported by Neptune)

        Parameters:
        optionGroupName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • characterSetName

        CreateDbInstanceRequest.Builder characterSetName​(String characterSetName)

        (Not supported by Neptune)

        Parameters:
        characterSetName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • publiclyAccessible

        @Deprecated
CreateDbInstanceRequest.Builder publiclyAccessible​(Boolean publiclyAccessible)
        Deprecated.

        This flag should no longer be used.

        Parameters:
        publiclyAccessible - This flag should no longer be used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbInstanceRequest.Builder tags​(Collection<Tag> tags)

        The tags to assign to the new instance.

        Parameters:
        tags - The tags to assign to the new instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbInstanceRequest.Builder tags​(Tag... tags)

        The tags to assign to the new instance.

        Parameters:
        tags - The tags to assign to the new instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbInstanceRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags to assign to the new instance.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • dbClusterIdentifier

        CreateDbInstanceRequest.Builder dbClusterIdentifier​(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

        Parameters:
        dbClusterIdentifier - The identifier of the DB cluster that the instance will belong to.

        For information on creating a DB cluster, see CreateDBCluster.

        Type: String

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        CreateDbInstanceRequest.Builder storageType​(String storageType)

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

        Not applicable. Storage is managed by the DB Cluster.

        Parameters:
        storageType - Specifies the storage type to be associated with the DB instance.

        Not applicable. Storage is managed by the DB Cluster.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tdeCredentialArn

        CreateDbInstanceRequest.Builder tdeCredentialArn​(String tdeCredentialArn)

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

        Parameters:
        tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tdeCredentialPassword

        CreateDbInstanceRequest.Builder tdeCredentialPassword​(String tdeCredentialPassword)

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

        Parameters:
        tdeCredentialPassword - The password for the given ARN from the key store in order to access the device.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageEncrypted

        CreateDbInstanceRequest.Builder storageEncrypted​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        CreateDbInstanceRequest.Builder kmsKeyId​(String kmsKeyId)

        The Amazon 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 Amazon 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. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

        Parameters:
        kmsKeyId - The Amazon 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 Amazon 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. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domain

        CreateDbInstanceRequest.Builder domain​(String domain)

        Specify the Active Directory Domain to create the instance in.

        Parameters:
        domain - Specify the Active Directory Domain to create the instance in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        CreateDbInstanceRequest.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

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

        Parameters:
        copyTagsToSnapshot - True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringInterval

        CreateDbInstanceRequest.Builder monitoringInterval​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • monitoringRoleArn

        CreateDbInstanceRequest.Builder monitoringRoleArn​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainIAMRoleName

        CreateDbInstanceRequest.Builder domainIAMRoleName​(String domainIAMRoleName)

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

        Parameters:
        domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • promotionTier

        CreateDbInstanceRequest.Builder promotionTier​(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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timezone

        CreateDbInstanceRequest.Builder timezone​(String timezone)

        The time zone of the DB instance.

        Parameters:
        timezone - The time zone of the DB instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableIAMDatabaseAuthentication

        CreateDbInstanceRequest.Builder enableIAMDatabaseAuthentication​(Boolean enableIAMDatabaseAuthentication)

        Not supported by Neptune (ignored).

        Parameters:
        enableIAMDatabaseAuthentication - Not supported by Neptune (ignored).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enablePerformanceInsights

        CreateDbInstanceRequest.Builder enablePerformanceInsights​(Boolean enablePerformanceInsights)

        (Not supported by Neptune)

        Parameters:
        enablePerformanceInsights - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • performanceInsightsKMSKeyId

        CreateDbInstanceRequest.Builder performanceInsightsKMSKeyId​(String performanceInsightsKMSKeyId)

        (Not supported by Neptune)

        Parameters:
        performanceInsightsKMSKeyId - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        CreateDbInstanceRequest.Builder enableCloudwatchLogsExports​(Collection<String> enableCloudwatchLogsExports)

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

        Parameters:
        enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        CreateDbInstanceRequest.Builder enableCloudwatchLogsExports​(String... enableCloudwatchLogsExports)

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

        Parameters:
        enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        CreateDbInstanceRequest.Builder deletionProtection​(Boolean deletionProtection)

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.