RestoreDbClusterFromSnapshotRequest (AWS Java SDK :: Services

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 Availability Zones (AZs) where instances in the restored DB cluster can be created.
`Long`	`backtrackWindow()` The target backtrack window, in seconds.
`static RestoreDbClusterFromSnapshotRequest.Builder`	`builder()`
`Boolean`	`copyTagsToSnapshot()` A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
`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()` A value that indicates whether the DB cluster has deletion protection enabled.
`String`	`domain()` Specify the Active Directory directory ID to restore the DB cluster in.
`String`	`domainIAMRoleName()` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`List<String>`	`enableCloudwatchLogsExports()` The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`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`, `parallelquery`, `global`, or `multimaster`.
`String`	`engineVersion()` The version of the database engine to use for the new DB cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAvailabilityZones()` Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnableCloudwatchLogsExports()` Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasVpcSecurityGroupIds()` Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - hasAvailabilityZones
```
public final boolean hasAvailabilityZones()
```
    Returns true if the AvailabilityZones property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAvailabilityZones() to see if a value was sent in this field.
    
    Returns:
    
    Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
  - dbClusterIdentifier
```
public final 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 final 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 final 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 final String engineVersion()
```
    The version of the database engine to use for the new DB cluster.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), 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"
    
    If you aren't using the default engine version, then you must specify the engine version.
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5
    
    Aurora PostgreSQL
    
    Example: 9.6.3, 10.7
    
    Returns:
    
    The version of the database engine to use for the new DB cluster.
    
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), 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"
    
    If you aren't using the default engine version, then you must specify the engine version.
    
    Aurora MySQL
    
    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5
    
    Aurora PostgreSQL
    
    Example: 9.6.3, 10.7
  - port
```
public final 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 final 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 final String databaseName()
```
    The database name for the restored DB cluster.
    
    Returns:
    
    The database name for the restored DB cluster.
  - optionGroupName
```
public final 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.
  - hasVpcSecurityGroupIds
```
public final boolean hasVpcSecurityGroupIds()
```
    Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - vpcSecurityGroupIds
```
public final 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.
    
    You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    A list of VPC security groups that the new DB cluster will belong to.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags to be assigned to the restored DB cluster.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 AWS KMS CMK 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.
    Returns:
    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 AWS KMS CMK 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.
  - enableIAMDatabaseAuthentication
```
public final Boolean enableIAMDatabaseAuthentication()
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
  - backtrackWindow
```
public final 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).
    Returns:
    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).
  - hasEnableCloudwatchLogsExports
```
public final boolean hasEnableCloudwatchLogsExports()
```
    Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - enableCloudwatchLogsExports
```
public final 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.
    
    You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
    
    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 final String engineMode()
```
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    For more information, see CreateDBCluster.
    
    Returns:
    
    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
    
    For more information, see CreateDBCluster.
  - scalingConfiguration
```
public final 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 final 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 final 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.
    
    Returns:
    
    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.
  - copyTagsToSnapshot
```
public final Boolean copyTagsToSnapshot()
```
    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
    
    Returns:
    
    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
  - domain
```
public final String domain()
```
    Specify 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.
    
    Returns:
    
    Specify 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.
  - domainIAMRoleName
```
public final String domainIAMRoleName()
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
  - toBuilder
```
public RestoreDbClusterFromSnapshotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static RestoreDbClusterFromSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbClusterFromSnapshotRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasAvailabilityZones

availabilityZones

dbClusterIdentifier

snapshotIdentifier

engine

engineVersion

port

dbSubnetGroupName

databaseName

optionGroupName

hasVpcSecurityGroupIds

vpcSecurityGroupIds

hasTags

tags

kmsKeyId

enableIAMDatabaseAuthentication

backtrackWindow

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

engineMode

scalingConfiguration

dbClusterParameterGroupName

deletionProtection

copyTagsToSnapshot

domain

domainIAMRoleName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields