Skip to content

TargetResourceConfiguration

Source code in docs_src/capo_rds/types/target_resource_configuration.py 
15
16
17
18
19
class TargetResourceConfiguration(TypedDict, closed=True):
    source_arn: "capo_rds.types.db_and_cluster_arn.DBAndClusterArn"
    """<p>The Amazon Resource Name (ARN) of the DB cluster or DB instance in the blue environment to which this configuration applies.</p>"""
    target_kms_key_id: NotRequired["capo_rds.types.kms_key_id_or_arn.KmsKeyIdOrArn"]
    """<p>The Amazon Web Services KMS key identifier for encryption of the corresponding resource in the green environment.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p> <p>Specify this setting in either of the following cases:</p> <ul> <li> <p>You want the green resource to use a different KMS key than the blue resource.</p> </li> <li> <p>The blue resource is unencrypted and you want to encrypt the green resource.</p> </li> </ul> <p>For Aurora, encryption applies at the DB cluster level. Specify a DB cluster ARN in <code>SourceArn</code>. All DB instances in that cluster use the same KMS key.</p> <p>For RDS, encryption applies at the DB instance level. Specify a DB instance ARN in <code>SourceArn</code>. To encrypt read replicas, include a separate entry for each one. Each entry can specify a different KMS key.</p>"""

source_arn instance-attribute 

source_arn: DBAndClusterArn

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

target_kms_key_id instance-attribute 

target_kms_key_id: NotRequired[KmsKeyIdOrArn]

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.