RestoreDbClusterFromSnapshotRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.neptune.model.NeptuneRequest
    - - software.amazon.awssdk.services.neptune.model.RestoreDbClusterFromSnapshotRequest

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

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbClusterFromSnapshotRequest
extends NeptuneRequest
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 EC2 Availability Zones that instances in the restored DB cluster can be created in.
`static RestoreDbClusterFromSnapshotRequest.Builder`	`builder()`
`Boolean`	`copyTagsToSnapshot()` If set to `true`, tags are copied to any snapshot of the restored DB cluster that is created.
`String`	`databaseName()` Not supported.
`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 the new 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.
`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 Amazon 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`	`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()` For responses, this returns true if the service returned a value for the AvailabilityZones property.
`boolean`	`hasEnableCloudwatchLogsExports()` For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasVpcSecurityGroupIds()` For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
`String`	`kmsKeyId()` The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
`String`	`optionGroupName()` (Not supported by Neptune)
`Integer`	`port()` The port number on which the new DB cluster accepts connections.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RestoreDbClusterFromSnapshotRequest.Builder>`	`serializableBuilderClass()`
`ServerlessV2ScalingConfiguration`	`serverlessV2ScalingConfiguration()` Returns the value of the ServerlessV2ScalingConfiguration property for this object.
`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()
```
    For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - availabilityZones
```
public final List<String> availabilityZones()
```
    Provides the list of 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailabilityZones() method.
    
    Returns:
    
    Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
  - 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
    - Cannot 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
    
    Cannot 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.
    
    Returns:
    
    The version of the database engine to use for the new DB cluster.
  - port
```
public final 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.
    
    Returns:
    
    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.
  - 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 DBSubnetGroup.
    
    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 DBSubnetGroup.
    
    Example: mySubnetgroup
  - databaseName
```
public final String databaseName()
```
    Not supported.
    
    Returns:
    
    Not supported.
  - optionGroupName
```
public final String optionGroupName()
```
    (Not supported by Neptune)
    
    Returns:
    
    (Not supported by Neptune)
  - hasVpcSecurityGroupIds
```
public final boolean hasVpcSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.
    
    Returns:
    
    A list of VPC security groups that the new DB cluster will belong to.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags to be assigned to the restored DB cluster.
  - kmsKeyId
```
public final 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.
    Returns:
    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.
  - enableIAMDatabaseAuthentication
```
public final Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
  - hasEnableCloudwatchLogsExports
```
public final boolean hasEnableCloudwatchLogsExports()
```
    For responses, this returns true if the service returned a value for the EnableCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - enableCloudwatchLogsExports
```
public final List<String> enableCloudwatchLogsExports()
```
    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnableCloudwatchLogsExports() method.
    
    Returns:
    
    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
  - dbClusterParameterGroupName
```
public final 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.
    Returns:
    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.
  - 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()
```
    If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
    
    Returns:
    
    If set to true, tags are copied to any snapshot of the restored DB cluster that is created.
  - serverlessV2ScalingConfiguration
```
public final ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration()
```
    Returns the value of the ServerlessV2ScalingConfiguration property for this object.
    
    Returns:
    
    The value of the ServerlessV2ScalingConfiguration property for this object.
  - toBuilder
```
public RestoreDbClusterFromSnapshotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>
    
    Specified by:
    
    toBuilder in class NeptuneRequest
  - 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

hasEnableCloudwatchLogsExports

enableCloudwatchLogsExports

dbClusterParameterGroupName

deletionProtection

copyTagsToSnapshot

serverlessV2ScalingConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields