Interface RestoreDbClusterFromSnapshotRequest.Builder

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

  • Method Details

    • availabilityZones

      RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(Collection<String> availabilityZones)

      Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

      Valid for: Aurora DB clusters only

      Parameters:
      availabilityZones - Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

      Valid for: Aurora DB clusters only

      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 Availability Zones (AZs) where instances in the restored DB cluster can be created.

      Valid for: Aurora DB clusters only

      Parameters:
      availabilityZones - Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

      Valid for: Aurora DB clusters only

      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

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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

      • Can't end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.

      To list all of the available engine versions for Aurora MySQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for Aurora PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for MySQL, use the following command:

      aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

      Aurora MySQL

      See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

      Aurora PostgreSQL

      See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

      MySQL

      See Amazon RDS for MySQL in the Amazon RDS User Guide.

      PostgreSQL

      See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      engineVersion - The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.

      To list all of the available engine versions for Aurora MySQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for Aurora PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for MySQL, use the following command:

      aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

      To list all of the available engine versions for RDS for PostgreSQL, use the following command:

      aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

      Aurora MySQL

      See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide.

      Aurora PostgreSQL

      See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

      MySQL

      See Amazon RDS for MySQL in the Amazon RDS User Guide.

      PostgreSQL

      See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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: This value must be 1150-65535

      Default: The same port as the original DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      port - The port number on which the new DB cluster accepts connections.

      Constraints: This value must be 1150-65535

      Default: The same port as the original DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 DB subnet group.

      Example: mydbsubnetgroup

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 DB subnet group.

      Example: mydbsubnetgroup

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • databaseName

      RestoreDbClusterFromSnapshotRequest.Builder databaseName(String databaseName)

      The database name for the restored DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      databaseName - The database name for the restored DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • optionGroupName

      RestoreDbClusterFromSnapshotRequest.Builder optionGroupName(String optionGroupName)

      The name of the option group to use for the restored DB cluster.

      DB clusters are associated with a default option group that can't be modified.

      Parameters:
      optionGroupName - The name of the option group to use for the restored DB cluster.

      DB clusters are associated with a default option group that can't be modified.

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      vpcSecurityGroupIds - A list of VPC security groups that the new DB cluster will belong to.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      tags - The tags to be assigned to the restored DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      tags - The tags to be assigned to the restored DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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 Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      When you don't specify a value for the KmsKeyId parameter, then the following occurs:

      • 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 isn't encrypted, then the restored DB cluster isn't encrypted.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      When you don't specify a value for the KmsKeyId parameter, then the following occurs:

      • 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 isn't encrypted, then the restored DB cluster isn't encrypted.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • enableIAMDatabaseAuthentication

      RestoreDbClusterFromSnapshotRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)

      Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      enableIAMDatabaseAuthentication - Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • backtrackWindow

      RestoreDbClusterFromSnapshotRequest.Builder backtrackWindow(Long backtrackWindow)

      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora DB clusters only

      Parameters:
      backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora DB clusters only

      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. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, slowquery, and iam-db-auth-error.

      RDS for PostgreSQL

      Possible values are postgresql, upgrade, and iam-db-auth-error.

      Aurora MySQL

      Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

      Aurora PostgreSQL

      Possible value are instance, postgresql, and iam-db-auth-error.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, slowquery, and iam-db-auth-error.

      RDS for PostgreSQL

      Possible values are postgresql, upgrade, and iam-db-auth-error.

      Aurora MySQL

      Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

      Aurora PostgreSQL

      Possible value are instance, postgresql, and iam-db-auth-error.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      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. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, slowquery, and iam-db-auth-error.

      RDS for PostgreSQL

      Possible values are postgresql, upgrade, and iam-db-auth-error.

      Aurora MySQL

      Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

      Aurora PostgreSQL

      Possible value are instance, postgresql, and iam-db-auth-error.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

      RDS for MySQL

      Possible values are error, general, slowquery, and iam-db-auth-error.

      RDS for PostgreSQL

      Possible values are postgresql, upgrade, and iam-db-auth-error.

      Aurora MySQL

      Possible values are audit, error, general, instance, slowquery, and iam-db-auth-error.

      Aurora PostgreSQL

      Possible value are instance, postgresql, and iam-db-auth-error.

      For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

      For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • engineMode

      RestoreDbClusterFromSnapshotRequest.Builder engineMode(String engineMode)

      The DB engine mode of the DB cluster, either provisioned or serverless.

      For more information, see CreateDBCluster.

      Valid for: Aurora DB clusters only

      Parameters:
      engineMode - The DB engine mode of the DB cluster, either provisioned or serverless.

      For more information, see CreateDBCluster.

      Valid for: Aurora DB clusters only

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

    • scalingConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

      Parameters:
      scalingConfiguration - For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

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

    • scalingConfiguration

      default RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)

      For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

      Valid for: Aurora DB clusters only

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

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

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

    • dbClusterParameterGroupName

      RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)

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

      Constraints:

      • If supplied, must match the name of an existing default DB cluster parameter group.

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

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

      Constraints:

      • If supplied, must match the name of an existing default DB cluster parameter group.

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

      • First character must be a letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • deletionProtection

      RestoreDbClusterFromSnapshotRequest.Builder deletionProtection(Boolean deletionProtection)

      Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      deletionProtection - Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • copyTagsToSnapshot

      RestoreDbClusterFromSnapshotRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)

      Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      copyTagsToSnapshot - Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • domain

      RestoreDbClusterFromSnapshotRequest.Builder domain(String domain)

      The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters only

      Parameters:
      domain - The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

      For more information, see Kerberos Authentication in the Amazon RDS User Guide.

      Valid for: Aurora DB clusters only

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

    • domainIAMRoleName

      RestoreDbClusterFromSnapshotRequest.Builder domainIAMRoleName(String domainIAMRoleName)

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

      Valid for: Aurora DB clusters only

      Parameters:
      domainIAMRoleName - The name of the IAM role to be used when making API calls to the Directory Service.

      Valid for: Aurora DB clusters only

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

    • dbClusterInstanceClass

      RestoreDbClusterFromSnapshotRequest.Builder dbClusterInstanceClass(String dbClusterInstanceClass)

      The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Valid for: Multi-AZ DB clusters only

      Parameters:
      dbClusterInstanceClass - The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

      For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

      Valid for: Multi-AZ DB clusters only

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

    • storageType

      RestoreDbClusterFromSnapshotRequest.Builder storageType(String storageType)

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

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

      Valid Values: aurora, aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • iops

      RestoreDbClusterFromSnapshotRequest.Builder iops(Integer iops)

      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

      For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • publiclyAccessible

      RestoreDbClusterFromSnapshotRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      Parameters:
      publiclyAccessible - Specifies whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

      When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

    • serverlessV2ScalingConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder serverlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object.
      Parameters:
      serverlessV2ScalingConfiguration - The new value for the ServerlessV2ScalingConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serverlessV2ScalingConfiguration

      default RestoreDbClusterFromSnapshotRequest.Builder serverlessV2ScalingConfiguration(Consumer<ServerlessV2ScalingConfiguration.Builder> serverlessV2ScalingConfiguration)
      Sets the value of the ServerlessV2ScalingConfiguration property for this object. 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:

    • networkType

      RestoreDbClusterFromSnapshotRequest.Builder networkType(String networkType)

      The network type of the DB cluster.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

      Parameters:
      networkType - The network type of the DB cluster.

      Valid Values:

      • IPV4

      • DUAL

      The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).

      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

    • rdsCustomClusterConfiguration

      RestoreDbClusterFromSnapshotRequest.Builder rdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)

      Reserved for future use.

      Parameters:
      rdsCustomClusterConfiguration - Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rdsCustomClusterConfiguration

      default RestoreDbClusterFromSnapshotRequest.Builder rdsCustomClusterConfiguration(Consumer<RdsCustomClusterConfiguration.Builder> rdsCustomClusterConfiguration)

      Reserved for future use.

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

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

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

    • monitoringInterval

      RestoreDbClusterFromSnapshotRequest.Builder monitoringInterval(Integer monitoringInterval)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

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

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

      Default: 0

      Parameters:
      monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

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

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

      Default: 0

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

    • monitoringRoleArn

      RestoreDbClusterFromSnapshotRequest.Builder monitoringRoleArn(String monitoringRoleArn)

      The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.

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

      Parameters:
      monitoringRoleArn - The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.

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

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

    • enablePerformanceInsights

      RestoreDbClusterFromSnapshotRequest.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

      Specifies whether to turn on Performance Insights for the DB cluster.

      Parameters:
      enablePerformanceInsights - Specifies whether to turn on Performance Insights for the DB cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performanceInsightsKMSKeyId

      RestoreDbClusterFromSnapshotRequest.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)

      The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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

      If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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 Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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

      If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS 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.

    • performanceInsightsRetentionPeriod

      RestoreDbClusterFromSnapshotRequest.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)

      The number of days to retain Performance Insights data.

      Valid Values:

      • 7

      • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

      • 731

      Default: 7 days

      If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

      Parameters:
      performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data.

      Valid Values:

      • 7

      • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)

      • 731

      Default: 7 days

      If you specify a retention period that isn't valid, such as 94, Amazon RDS issues an error.

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

    • engineLifecycleSupport

      RestoreDbClusterFromSnapshotRequest.Builder engineLifecycleSupport(String engineLifecycleSupport)

      The life cycle type for this DB cluster.

      By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

      You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

      Default: open-source-rds-extended-support

      Parameters:
      engineLifecycleSupport - The life cycle type for this DB cluster.

      By default, this value is set to open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

      You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

      Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

      Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled

      Default: open-source-rds-extended-support

      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.