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>

  • Method Details

    • 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 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()

      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 | io2

      This 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 | io2

      This 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 gp3 storage 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 gp3 storage type.

      This setting doesn't apply to Amazon Aurora blue/green deployments.

    • toBuilder

      public CreateBlueGreenDeploymentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateBlueGreenDeploymentRequest.Builder,CreateBlueGreenDeploymentRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBlueGreenDeploymentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBlueGreenDeploymentRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.