java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.docdbelastic.model.DocDbElasticRequest
    - - software.amazon.awssdk.services.docdbelastic.model.RestoreClusterFromSnapshotRequest

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

@Generated("software.amazon.awssdk:codegen")
public final class RestoreClusterFromSnapshotRequest
extends DocDbElasticRequest
implements ToCopyableBuilder<RestoreClusterFromSnapshotRequest.Builder,RestoreClusterFromSnapshotRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RestoreClusterFromSnapshotRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RestoreClusterFromSnapshotRequest.Builder`	`builder()`
`String`	`clusterName()`	The name of the elastic cluster.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubnetIds()`	For responses, this returns true if the service returned a value for the SubnetIds property.
`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 KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RestoreClusterFromSnapshotRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`shardCapacity()`	The capacity of each shard in the new restored elastic cluster.
`Integer`	`shardInstanceCount()`	The number of replica instances applying to all shards in the elastic cluster.
`String`	`snapshotArn()`	The ARN identifier of the elastic cluster snapshot.
`List<String>`	`subnetIds()`	The Amazon EC2 subnet IDs for the elastic cluster.
`Map<String,String>`	`tags()`	A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
`RestoreClusterFromSnapshotRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`vpcSecurityGroupIds()`	A list of EC2 VPC security groups to associate with the elastic cluster.

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
  - clusterName
```
public final String clusterName()
```
    The name of the elastic cluster.
    
    Returns:
    
    The name of the elastic cluster.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Returns:
    
    The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - shardCapacity
```
public final Integer shardCapacity()
```
    The capacity of each shard in the new restored elastic cluster.
    
    Returns:
    
    The capacity of each shard in the new restored elastic cluster.
  - shardInstanceCount
```
public final Integer shardInstanceCount()
```
    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
    
    Returns:
    
    The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
  - snapshotArn
```
public final String snapshotArn()
```
    The ARN identifier of the elastic cluster snapshot.
    
    Returns:
    
    The ARN identifier of the elastic cluster snapshot.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds 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.
  - subnetIds
```
public final List<String> subnetIds()
```
    The Amazon EC2 subnet IDs for the elastic 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 hasSubnetIds() method.
    
    Returns:
    
    The Amazon EC2 subnet IDs for the elastic cluster.
  - 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 Map<String,String> tags()
```
    A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
    
    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:
    
    A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
  - 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 EC2 VPC security groups to associate with the elastic 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 hasVpcSecurityGroupIds() method.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with the elastic cluster.
  - toBuilder
```
public RestoreClusterFromSnapshotRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreClusterFromSnapshotRequest.Builder,RestoreClusterFromSnapshotRequest>
    
    Specified by:
    
    toBuilder in class DocDbElasticRequest
  - builder
```
public static RestoreClusterFromSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreClusterFromSnapshotRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class RestoreClusterFromSnapshotRequest

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

clusterName

kmsKeyId

shardCapacity

shardInstanceCount

snapshotArn

hasSubnetIds

subnetIds

hasTags

tags

hasVpcSecurityGroupIds

vpcSecurityGroupIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField