Class CreateBlueGreenDeploymentRequest
- 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.CreateBlueGreenDeploymentRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateBlueGreenDeploymentRequest.Builder,CreateBlueGreenDeploymentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateBlueGreenDeploymentRequest extends RdsRequest implements ToCopyableBuilder<CreateBlueGreenDeploymentRequest.Builder,CreateBlueGreenDeploymentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateBlueGreenDeploymentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringblueGreenDeploymentName()The name of the blue/green deployment.static CreateBlueGreenDeploymentRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateBlueGreenDeploymentRequest.Builder>serializableBuilderClass()Stringsource()The Amazon Resource Name (ARN) of the source production database.List<Tag>tags()Tags to assign to the blue/green deployment.IntegertargetAllocatedStorage()The amount of storage in gibibytes (GiB) to allocate for the green DB instance.StringtargetDBClusterParameterGroupName()The DB cluster parameter group associated with the Aurora DB cluster in the green environment.StringtargetDBInstanceClass()Specify the DB instance class for the databases in the green environment.StringtargetDBParameterGroupName()The DB parameter group associated with the DB instance in the green environment.StringtargetEngineVersion()The engine version of the database in the green environment.IntegertargetIops()The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance.IntegertargetStorageThroughput()The storage throughput value for the green DB instance.StringtargetStorageType()The storage type to associate with the green DB instance.CreateBlueGreenDeploymentRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanupgradeTargetStorageConfig()Whether to upgrade the storage file system configuration on the green database.-
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
-
blueGreenDeploymentName
public final String blueGreenDeploymentName()
The name of the blue/green deployment.
Constraints:
-
Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
- Returns:
- The name of the blue/green deployment.
Constraints:
-
Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.
-
-
-
source
public final String source()
The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
- Returns:
- The Amazon Resource Name (ARN) of the source production database.
Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.
-
targetEngineVersion
public final String targetEngineVersion()
The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
- Returns:
- The engine version of the database in the green environment.
Specify the engine version to upgrade to in the green environment.
-
targetDBParameterGroupName
public final String targetDBParameterGroupName()
The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
- Returns:
- The DB parameter group associated with the DB instance in the green environment.
To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.
-
targetDBClusterParameterGroupName
public final String targetDBClusterParameterGroupName()
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.
- Returns:
- The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB 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 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.
-
tags
public final List<Tag> tags()
Tags to assign to the blue/green deployment.
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:
- Tags to assign to the blue/green deployment.
-
targetDBInstanceClass
public final String targetDBInstanceClass()
Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
- Returns:
- Specify the DB instance class for the databases in the green environment.
This parameter only applies to RDS DB instances, because DB instances within an Aurora DB cluster can have multiple different instance classes. If you're creating a blue/green deployment from an Aurora DB cluster, don't specify this parameter. After the green environment is created, you can individually modify the instance classes of the DB instances within the green DB cluster.
-
upgradeTargetStorageConfig
public final Boolean upgradeTargetStorageConfig()
Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
- Returns:
- Whether to upgrade the storage file system configuration on the green database. This option migrates the green DB instance from the older 32-bit file system to the preferred configuration. For more information, see Upgrading the storage file system for a DB instance.
-
targetIops
public final Integer targetIops()
The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora blue/green deployments.
- Returns:
- The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB
instance. For information about valid IOPS values, see Amazon RDS DB instance
storage in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora blue/green deployments.
-
targetStorageType
public final String targetStorageType()
The storage type to associate with the green DB instance.
Valid Values:
gp2 | gp3 | io1 | io2This setting doesn't apply to Amazon Aurora blue/green deployments.
- Returns:
- The storage type to associate with the green DB instance.
Valid Values:
gp2 | gp3 | io1 | io2This setting doesn't apply to Amazon Aurora blue/green deployments.
-
targetAllocatedStorage
public final Integer targetAllocatedStorage()
The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to increase or decrease the allocated storage on the green DB instance.
This setting doesn't apply to Amazon Aurora blue/green deployments.
- Returns:
- The amount of storage in gibibytes (GiB) to allocate for the green DB instance. You can choose to
increase or decrease the allocated storage on the green DB instance.
This setting doesn't apply to Amazon Aurora blue/green deployments.
-
targetStorageThroughput
public final Integer targetStorageThroughput()
The storage throughput value for the green DB instance.
This setting applies only to the
gp3storage type.This setting doesn't apply to Amazon Aurora blue/green deployments.
- Returns:
- The storage throughput value for the green DB instance.
This setting applies only to the
gp3storage type.This setting doesn't apply to Amazon Aurora blue/green deployments.
-
toBuilder
public CreateBlueGreenDeploymentRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateBlueGreenDeploymentRequest.Builder,CreateBlueGreenDeploymentRequest>- Specified by:
toBuilderin classRdsRequest
-
builder
public static CreateBlueGreenDeploymentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateBlueGreenDeploymentRequest.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
-
-