Class ModifyReplicationInstanceRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
-
- software.amazon.awssdk.services.databasemigration.model.ModifyReplicationInstanceRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyReplicationInstanceRequest.Builder,ModifyReplicationInstanceRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyReplicationInstanceRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<ModifyReplicationInstanceRequest.Builder,ModifyReplicationInstanceRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceModifyReplicationInstanceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerallocatedStorage()The amount of storage (in gigabytes) to be allocated for the replication instance.BooleanallowMajorVersionUpgrade()Indicates that major version upgrades are allowed.BooleanapplyImmediately()Indicates whether the changes should be applied immediately or during the next maintenance window.BooleanautoMinorVersionUpgrade()A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window.static ModifyReplicationInstanceRequest.Builderbuilder()StringengineVersion()The engine version number of the replication instance.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasVpcSecurityGroupIds()For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.KerberosAuthenticationSettingskerberosAuthenticationSettings()Specifies the settings required for kerberos authentication when modifying a replication instance.BooleanmultiAZ()Specifies whether the replication instance is a Multi-AZ deployment.StringnetworkType()The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing.StringpreferredMaintenanceWindow()The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.StringreplicationInstanceArn()The Amazon Resource Name (ARN) of the replication instance.StringreplicationInstanceClass()The compute and memory capacity of the replication instance as defined for the specified replication instance class.StringreplicationInstanceIdentifier()The replication instance identifier.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ModifyReplicationInstanceRequest.Builder>serializableBuilderClass()ModifyReplicationInstanceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>vpcSecurityGroupIds()Specifies the VPC security group to be used with the replication instance.-
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
-
replicationInstanceArn
public final String replicationInstanceArn()
The Amazon Resource Name (ARN) of the replication instance.
- Returns:
- The Amazon Resource Name (ARN) of the replication instance.
-
allocatedStorage
public final Integer allocatedStorage()
The amount of storage (in gigabytes) to be allocated for the replication instance.
- Returns:
- The amount of storage (in gigabytes) to be allocated for the replication instance.
-
applyImmediately
public final Boolean applyImmediately()
Indicates whether the changes should be applied immediately or during the next maintenance window.
- Returns:
- Indicates whether the changes should be applied immediately or during the next maintenance window.
-
replicationInstanceClass
public final String replicationInstanceClass()
The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to
"dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
- Returns:
- The compute and memory capacity of the replication instance as defined for the specified replication
instance class. For example to specify the instance class dms.c4.large, set this parameter to
"dms.c4.large".For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.
-
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 theisEmpty()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()
Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
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:
- Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.
-
preferredMaintenanceWindow
public final String preferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
- Returns:
- The weekly time range (in UTC) during which system maintenance can occur, which might result in an
outage. Changing this parameter does not result in an outage, except in the following situation, and the
change is asynchronously applied as soon as possible. If moving this window to the current time, there
must be at least 30 minutes between the current time and end of the window to ensure pending changes are
applied.
Default: Uses existing setting
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes
-
multiAZ
public final Boolean multiAZ()
Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the Multi-AZ parameter is set totrue.- Returns:
- Specifies whether the replication instance is a Multi-AZ deployment. You can't set the
AvailabilityZoneparameter if the Multi-AZ parameter is set totrue.
-
engineVersion
public final String engineVersion()
The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgradetotrue.- Returns:
- The engine version number of the replication instance.
When modifying a major engine version of an instance, also set
AllowMajorVersionUpgradetotrue.
-
allowMajorVersionUpgrade
public final Boolean allowMajorVersionUpgrade()
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.
This parameter must be set to
truewhen specifying a value for theEngineVersionparameter that is a different major version than the replication instance's current version.- Returns:
- Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage,
and the change is asynchronously applied as soon as possible.
This parameter must be set to
truewhen specifying a value for theEngineVersionparameter that is a different major version than the replication instance's current version.
-
autoMinorVersionUpgrade
public final Boolean autoMinorVersionUpgrade()
A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
-
This parameter is set to
trueduring the maintenance window. -
A newer minor version is available.
-
DMS has enabled automatic patching for the given engine version.
- Returns:
- A value that indicates that minor version upgrades are applied automatically to the replication instance
during the maintenance window. Changing this parameter doesn't result in an outage, except in the case
described following. The change is asynchronously applied as soon as possible.
An outage does result if these factors apply:
-
This parameter is set to
trueduring the maintenance window. -
A newer minor version is available.
-
DMS has enabled automatic patching for the given engine version.
-
-
-
replicationInstanceIdentifier
public final String replicationInstanceIdentifier()
The replication instance identifier. This parameter is stored as a lowercase string.
- Returns:
- The replication instance identifier. This parameter is stored as a lowercase string.
-
networkType
public final String networkType()
The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
- Returns:
- The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
-
kerberosAuthenticationSettings
public final KerberosAuthenticationSettings kerberosAuthenticationSettings()
Specifies the settings required for kerberos authentication when modifying a replication instance.
- Returns:
- Specifies the settings required for kerberos authentication when modifying a replication instance.
-
toBuilder
public ModifyReplicationInstanceRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyReplicationInstanceRequest.Builder,ModifyReplicationInstanceRequest>- Specified by:
toBuilderin classDatabaseMigrationRequest
-
builder
public static ModifyReplicationInstanceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyReplicationInstanceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-