Interface RestoreDbClusterFromSnapshotRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>, NeptuneRequest.Builder, SdkBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RestoreDbClusterFromSnapshotRequest
@Mutable @NotThreadSafe public static interface RestoreDbClusterFromSnapshotRequest.Builder extends NeptuneRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>

  • Method Details

    • availabilityZones

      RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(Collection<String> availabilityZones)

      Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

      Parameters:
      availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZones

      RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(String... availabilityZones)

      Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

      Parameters:
      availabilityZones - Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbClusterIdentifier

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

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

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

    • snapshotIdentifier

      RestoreDbClusterFromSnapshotRequest.Builder snapshotIdentifier(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.

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

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

    • engine

      RestoreDbClusterFromSnapshotRequest.Builder engine(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

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

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

    • engineVersion

      RestoreDbClusterFromSnapshotRequest.Builder engineVersion(String engineVersion)

      The version of the database engine to use for the new DB cluster.

      Parameters:
      engineVersion - The version of the database engine to use for the new DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • port

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

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

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

    • dbSubnetGroupName

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

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

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

    • databaseName

      RestoreDbClusterFromSnapshotRequest.Builder databaseName(String databaseName)

      Not supported.

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

    • optionGroupName

      RestoreDbClusterFromSnapshotRequest.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.

    • vpcSecurityGroupIds

      RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of VPC security groups that the new DB cluster will belong to.

      Parameters:
      vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of VPC security groups that the new DB cluster will belong to.

      Parameters:
      vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterFromSnapshotRequest.Builder tags(Collection<Tag> tags)

      The tags to be assigned to the restored DB cluster.

      Parameters:
      tags - The tags to be assigned to the restored DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterFromSnapshotRequest.Builder tags(Tag... tags)

      The tags to be assigned to the restored DB cluster.

      Parameters:
      tags - The tags to be assigned to the restored DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RestoreDbClusterFromSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to be assigned to the restored DB cluster.

      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<Tag>).

      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:

    • kmsKeyId

      RestoreDbClusterFromSnapshotRequest.Builder kmsKeyId(String kmsKeyId)

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

      Parameters:
      kmsKeyId - The Amazon 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 Amazon 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.

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

    • enableIAMDatabaseAuthentication

      RestoreDbClusterFromSnapshotRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

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

      Default: false

      Parameters:
      enableIAMDatabaseAuthentication - True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

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

    • enableCloudwatchLogsExports

      RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)

      The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableCloudwatchLogsExports

      RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)

      The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbClusterParameterGroupName

      RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName(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.

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

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

    • deletionProtection

      RestoreDbClusterFromSnapshotRequest.Builder deletionProtection(Boolean deletionProtection)

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

      Parameters:
      deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • copyTagsToSnapshot

      RestoreDbClusterFromSnapshotRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

      Parameters:
      copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverlessV2ScalingConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)

      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      Parameters:
      serverlessV2ScalingConfiguration - Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

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

    • serverlessV2ScalingConfiguration

      default RestoreDbClusterFromSnapshotRequest.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfiguration.Builder> serverlessV2ScalingConfiguration)

      Contains the scaling configuration of a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration).

      Parameters:
      serverlessV2ScalingConfiguration - a consumer that will call methods on ServerlessV2ScalingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageType

      RestoreDbClusterFromSnapshotRequest.Builder storageType(String storageType)

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

      Valid values: standard, iopt1

      Default: standard

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

      Valid values: standard, iopt1

      Default: standard

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

    • overrideConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.