RestoreDbClusterFromSnapshotRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.RestoreDbClusterFromSnapshotRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbClusterFromSnapshotRequest
extends RdsRequest
implements ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RestoreDbClusterFromSnapshotRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RestoreDbClusterFromSnapshotRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`availabilityZones()` Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
`Long`	`backtrackWindow()` The target backtrack window, in seconds.
`static RestoreDbClusterFromSnapshotRequest.Builder`	`builder()`
`String`	`databaseName()` The database name for the restored DB cluster.
`String`	`dbClusterIdentifier()` The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
`String`	`dbClusterParameterGroupName()` The name of the DB cluster parameter group to associate with this DB cluster.
`String`	`dbSubnetGroupName()` The name of the DB subnet group to use for the new DB cluster.
`Boolean`	`deletionProtection()` Indicates if the DB cluster should have deletion protection enabled.
`List<String>`	`enableCloudwatchLogsExports()` The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`String`	`engine()` The database engine to use for the new DB cluster.
`String`	`engineMode()` The DB engine mode of the DB cluster, either `provisioned`, `serverless`, or `parallelquery`.
`String`	`engineVersion()` The version of the database engine to use for the new DB cluster.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`kmsKeyId()` The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
`String`	`optionGroupName()` The name of the option group to use for the restored DB cluster.
`Integer`	`port()` The port number on which the new DB cluster accepts connections.
`ScalingConfiguration`	`scalingConfiguration()` For DB clusters in `serverless` DB engine mode, the scaling properties of the DB cluster.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RestoreDbClusterFromSnapshotRequest.Builder>`	`serializableBuilderClass()`
`String`	`snapshotIdentifier()` The identifier for the DB snapshot or DB cluster snapshot to restore from.
`List<Tag>`	`tags()` The tags to be assigned to the restored DB cluster.
`RestoreDbClusterFromSnapshotRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<String>`	`vpcSecurityGroupIds()` A list of VPC security groups that the new DB cluster will belong to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - availabilityZones
```
public List<String> availabilityZones()
```
    Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
  - dbClusterIdentifier
```
public 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
    Returns:
    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
  - snapshotIdentifier
```
public 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.
    Returns:
    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.
  - engine
```
public 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
    
    Returns:
    
    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
  - engineVersion
```
public String engineVersion()
```
    The version of the database engine to use for the new DB cluster.
    
    Returns:
    
    The version of the database engine to use for the new DB cluster.
  - port
```
public 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.
    
    Returns:
    
    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.
  - dbSubnetGroupName
```
public 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: mySubnetgroup
    
    Returns:
    
    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: mySubnetgroup
  - databaseName
```
public String databaseName()
```
    The database name for the restored DB cluster.
    
    Returns:
    
    The database name for the restored DB cluster.
  - optionGroupName
```
public String optionGroupName()
```
    The name of the option group to use for the restored DB cluster.
    
    Returns:
    
    The name of the option group to use for the restored DB cluster.
  - vpcSecurityGroupIds
```
public List<String> vpcSecurityGroupIds()
```
    A list of VPC security groups that the new DB cluster will belong to.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of VPC security groups that the new DB cluster will belong to.
  - tags
```
public List<Tag> tags()
```
    The tags to be assigned to the restored DB cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The tags to be assigned to the restored DB cluster.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    If you 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 is not encrypted, then the restored DB cluster is not encrypted.
    Returns:
    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    If you 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 is not encrypted, then the restored DB cluster is not encrypted.
  - enableIAMDatabaseAuthentication
```
public Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
  - backtrackWindow
```
public Long backtrackWindow()
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
  - enableCloudwatchLogsExports
```
public List<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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
  - engineMode
```
public String engineMode()
```
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
    
    Returns:
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - scalingConfiguration
```
public ScalingConfiguration scalingConfiguration()
```
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
    
    Returns:
    
    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
  - dbClusterParameterGroupName
```
public 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.
    Returns:
    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.
  - deletionProtection
```
public Boolean deletionProtection()
```
    Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
    
    Returns:
    
    Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
  - toBuilder
```
public RestoreDbClusterFromSnapshotRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RestoreDbClusterFromSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbClusterFromSnapshotRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class RestoreDbClusterFromSnapshotRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

availabilityZones

dbClusterIdentifier

snapshotIdentifier

engine

engineVersion

port

dbSubnetGroupName

databaseName

optionGroupName

vpcSecurityGroupIds

tags

kmsKeyId

enableIAMDatabaseAuthentication

backtrackWindow

enableCloudwatchLogsExports

engineMode

scalingConfiguration

dbClusterParameterGroupName

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields