software.amazon.awssdk.services.docdb.model

Interface CreateDbInstanceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>, DocDbRequest.Builder, SdkBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDbInstanceRequest

public static interface CreateDbInstanceRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>

Method Summary

Modifier and Type	Method and Description
CreateDbInstanceRequest.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) This parameter does not apply to Amazon DocumentDB.
CreateDbInstanceRequest.Builder	availabilityZone(String availabilityZone) The Amazon EC2 Availability Zone that the instance is created in.
CreateDbInstanceRequest.Builder	copyTagsToSnapshot(Boolean copyTagsToSnapshot) A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
CreateDbInstanceRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The identifier of the cluster that the instance will belong to.
CreateDbInstanceRequest.Builder	dbInstanceClass(String dbInstanceClass) The compute and memory capacity of the instance; for example, db.r5.large.
CreateDbInstanceRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier) The instance identifier.
CreateDbInstanceRequest.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights) A value that indicates whether to enable Performance Insights for the DB Instance.
CreateDbInstanceRequest.Builder	engine(String engine) The name of the database engine to be used for this instance.
CreateDbInstanceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateDbInstanceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateDbInstanceRequest.Builder	performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId) The KMS key identifier for encryption of Performance Insights data.
CreateDbInstanceRequest.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
CreateDbInstanceRequest.Builder	promotionTier(Integer promotionTier) A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
CreateDbInstanceRequest.Builder	tags(Collection<Tag> tags) The tags to be assigned to the instance.
CreateDbInstanceRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags to be assigned to the instance.
CreateDbInstanceRequest.Builder	tags(Tag... tags) The tags to be assigned to the instance.

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

dbInstanceIdentifier

CreateDbInstanceRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

The instance identifier. This parameter 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

Parameters:

dbInstanceIdentifier - The instance identifier. This parameter 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

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 instance; for example, db.r5.large.

Parameters:

dbInstanceClass - The compute and memory capacity of the instance; for example, db.r5.large.

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 value: docdb

Parameters:

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

Valid value: docdb

Returns:

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

availabilityZone

CreateDbInstanceRequest.Builder availabilityZone(String availabilityZone)

The Amazon EC2 Availability Zone that the instance is created in.

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

Example: us-east-1d

Parameters:

availabilityZone - The Amazon EC2 Availability Zone that the instance is created in.

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

Example: us-east-1d

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 Web Services 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 Web Services 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.

autoMinorVersionUpgrade

CreateDbInstanceRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

Parameters:

autoMinorVersionUpgrade - This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Default: false

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 be assigned to the instance. You can assign up to 10 tags to an instance.

Parameters:

tags - The tags to be assigned to the instance. You can assign up to 10 tags to an 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 be assigned to the instance. You can assign up to 10 tags to an instance.

Parameters:

tags - The tags to be assigned to the instance. You can assign up to 10 tags to an 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 be assigned to the instance. You can assign up to 10 tags to an 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 cluster that the instance will belong to.

Parameters:

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

Returns:

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

copyTagsToSnapshot

CreateDbInstanceRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Parameters:

copyTagsToSnapshot - A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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 Amazon DocumentDB 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 Amazon DocumentDB 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.

enablePerformanceInsights

CreateDbInstanceRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

Parameters:

enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.

Returns:

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

performanceInsightsKMSKeyId

CreateDbInstanceRequest.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)

The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

Parameters:

performanceInsightsKMSKeyId - The KMS key identifier for encryption of Performance Insights data.

The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.

Returns:

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

overrideConfiguration

CreateDbInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateDbInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder