UpdateClusterRequest (AWS Java SDK :: Services :: Doc DB Elastic 2.21.10 API)

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.UpdateClusterRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateClusterRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`adminUserPassword()` The password for the Elastic DocumentDB cluster administrator.
`Auth`	`authType()` The authentication type for the Elastic DocumentDB cluster.
`String`	`authTypeAsString()` The authentication type for the Elastic DocumentDB cluster.
`static UpdateClusterRequest.Builder`	`builder()`
`String`	`clientToken()` The client token for the Elastic DocumentDB cluster.
`String`	`clusterArn()` The arn of the Elastic DocumentDB 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`	`hasVpcSecurityGroupIds()` For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
`String`	`preferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateClusterRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`shardCapacity()` The capacity of each shard in the Elastic DocumentDB cluster.
`Integer`	`shardCount()` The number of shards to create in the Elastic DocumentDB cluster.
`List<String>`	`subnetIds()` The number of shards to create in the Elastic DocumentDB cluster.
`UpdateClusterRequest.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 new Elastic DocumentDB 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
  - adminUserPassword
```
public final String adminUserPassword()
```
    The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
    
    Returns:
    
    The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
    
    Constraints: Must contain from 8 to 100 characters.
  - authType
```
public final Auth authType()
```
    The authentication type for the Elastic DocumentDB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().
    
    Returns:
    
    The authentication type for the Elastic DocumentDB cluster.
    
    See Also:
    
    Auth
  - authTypeAsString
```
public final String authTypeAsString()
```
    The authentication type for the Elastic DocumentDB cluster.
    
    If the service returns an enum value that is not available in the current SDK version, authType will return Auth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authTypeAsString().
    
    Returns:
    
    The authentication type for the Elastic DocumentDB cluster.
    
    See Also:
    
    Auth
  - clientToken
```
public final String clientToken()
```
    The client token for the Elastic DocumentDB cluster.
    
    Returns:
    
    The client token for the Elastic DocumentDB cluster.
  - clusterArn
```
public final String clusterArn()
```
    The arn of the Elastic DocumentDB cluster.
    
    Returns:
    
    The arn of the Elastic DocumentDB cluster.
  - preferredMaintenanceWindow
```
public final String preferredMaintenanceWindow()
```
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
    
    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
    
    Constraints: Minimum 30-minute window.
    
    Returns:
    
    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    
    Format: ddd:hh24:mi-ddd:hh24:mi
    
    Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
    
    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
    
    Constraints: Minimum 30-minute window.
  - shardCapacity
```
public final Integer shardCapacity()
```
    The capacity of each shard in the Elastic DocumentDB cluster.
    
    Returns:
    
    The capacity of each shard in the Elastic DocumentDB cluster.
  - shardCount
```
public final Integer shardCount()
```
    The number of shards to create in the Elastic DocumentDB cluster.
    
    Returns:
    
    The number of shards to create in the Elastic DocumentDB cluster.
  - 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 number of shards to create in the Elastic DocumentDB 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 number of shards to create in the Elastic DocumentDB cluster.
  - 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 new Elastic DocumentDB 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 new Elastic DocumentDB cluster.
  - toBuilder
```
public UpdateClusterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
    
    Specified by:
    
    toBuilder in class DocDbElasticRequest
  - builder
```
public static UpdateClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateClusterRequest.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 UpdateClusterRequest

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

adminUserPassword

authType

authTypeAsString

clientToken

clusterArn

preferredMaintenanceWindow

shardCapacity

shardCount

hasSubnetIds

subnetIds

hasVpcSecurityGroupIds

vpcSecurityGroupIds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields