Class TargetResourceConfiguration

java.lang.Object
software.amazon.awssdk.services.rds.model.TargetResourceConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TargetResourceConfiguration.Builder,TargetResourceConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class TargetResourceConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TargetResourceConfiguration.Builder,TargetResourceConfiguration>

The configuration for a single resource in the green environment of a blue/green deployment.

Use SourceArn to identify a resource in the blue environment. Amazon RDS creates the corresponding resource in the green environment using this configuration.

This data type is a request parameter of the CreateBlueGreenDeployment operation.

See Also:

  • Method Details

    • sourceArn

      public final String sourceArn()

      The Amazon Resource Name (ARN) of the DB cluster or DB instance in the blue environment to which this configuration applies.

      Returns:
      The Amazon Resource Name (ARN) of the DB cluster or DB instance in the blue environment to which this configuration applies.

    • targetKmsKeyId

      public final String targetKmsKeyId()

      The Amazon Web Services KMS key identifier for encryption of the corresponding resource in the green environment.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      Specify this setting in either of the following cases:

      • You want the green resource to use a different KMS key than the blue resource.

      • The blue resource is unencrypted and you want to encrypt the green resource.

      For Aurora, encryption applies at the DB cluster level. Specify a DB cluster ARN in SourceArn. All DB instances in that cluster use the same KMS key.

      For RDS, encryption applies at the DB instance level. Specify a DB instance ARN in SourceArn. To encrypt read replicas, include a separate entry for each one. Each entry can specify a different KMS key.

      Returns:
      The Amazon Web Services KMS key identifier for encryption of the corresponding resource in the green environment.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

      Specify this setting in either of the following cases:

      • You want the green resource to use a different KMS key than the blue resource.

      • The blue resource is unencrypted and you want to encrypt the green resource.

      For Aurora, encryption applies at the DB cluster level. Specify a DB cluster ARN in SourceArn. All DB instances in that cluster use the same KMS key.

      For RDS, encryption applies at the DB instance level. Specify a DB instance ARN in SourceArn . To encrypt read replicas, include a separate entry for each one. Each entry can specify a different KMS key.

    • toBuilder

      public TargetResourceConfiguration.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<TargetResourceConfiguration.Builder,TargetResourceConfiguration>
      Returns:
      a builder for type T

    • builder

      public static TargetResourceConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TargetResourceConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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