Skip to content

RDS  >  Operations  >  create_blue_green_deployment

create_blue_green_deployment

Operation

create_blue_green_deployment async

create_blue_green_deployment(request: CreateBlueGreenDeploymentInput | CreateBlueGreenDeploymentInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateBlueGreenDeploymentOutput
create_blue_green_deployment(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBlueGreenDeploymentInputDict]) -> CreateBlueGreenDeploymentOutput

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateBlueGreenDeploymentOutput

An instance of CreateBlueGreenDeploymentOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateBlueGreenDeploymentInput dataclass

Bases: _SerdeShape

Dataclass for CreateBlueGreenDeploymentInput structure.

Attributes
blue_green_deployment_name class-attribute instance-attribute
blue_green_deployment_name: str | None = ...

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 class-attribute instance-attribute
source: str | None = ...

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.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

Tags to assign to the blue/green deployment.

target_allocated_storage class-attribute instance-attribute
target_allocated_storage: int | None = ...

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.

target_db_cluster_parameter_group_name class-attribute instance-attribute
target_db_cluster_parameter_group_name: str | None = ...

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.

target_db_instance_class class-attribute instance-attribute
target_db_instance_class: str | None = ...

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.

target_db_parameter_group_name class-attribute instance-attribute
target_db_parameter_group_name: str | None = ...

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.

target_engine_version class-attribute instance-attribute
target_engine_version: str | None = ...

The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

target_iops class-attribute instance-attribute
target_iops: int | None = ...

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.

target_resource_configurations class-attribute instance-attribute
target_resource_configurations: list[TargetResourceConfiguration] | None = ...

Specifies resource-level configuration overrides for the green environment.

Each entry identifies a resource in the blue environment by its Amazon Resource Name (ARN). It defines the desired configuration for the corresponding resource in the green environment. Any resource that you don't include in this parameter retains the same configuration as its counterpart in the blue environment.

Use this parameter when one or more resources in the green environment require a different configuration than what they have in the blue environment.

Constraints:

  • You can't specify the same SourceArn in more than one entry.
target_storage_throughput class-attribute instance-attribute
target_storage_throughput: int | None = ...

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.

target_storage_type class-attribute instance-attribute
target_storage_type: str | None = ...

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.

upgrade_target_storage_config class-attribute instance-attribute
upgrade_target_storage_config: bool | None = ...

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.

Dictionaries

CreateBlueGreenDeploymentInputDict

Bases: TypedDict

Dictionary form of CreateBlueGreenDeploymentInput.

Attributes
blue_green_deployment_name instance-attribute
blue_green_deployment_name: Required[str]

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 instance-attribute
source: Required[str]

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.

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

Tags to assign to the blue/green deployment.

target_allocated_storage instance-attribute
target_allocated_storage: int | None

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.

target_db_cluster_parameter_group_name instance-attribute
target_db_cluster_parameter_group_name: str | None

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.

target_db_instance_class instance-attribute
target_db_instance_class: str | None

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.

target_db_parameter_group_name instance-attribute
target_db_parameter_group_name: str | None

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.

target_engine_version instance-attribute
target_engine_version: str | None

The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

target_iops instance-attribute
target_iops: int | None

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.

target_resource_configurations instance-attribute
target_resource_configurations: Sequence[TargetResourceConfiguration | TargetResourceConfigurationDict] | None

Specifies resource-level configuration overrides for the green environment.

Each entry identifies a resource in the blue environment by its Amazon Resource Name (ARN). It defines the desired configuration for the corresponding resource in the green environment. Any resource that you don't include in this parameter retains the same configuration as its counterpart in the blue environment.

Use this parameter when one or more resources in the green environment require a different configuration than what they have in the blue environment.

Constraints:

  • You can't specify the same SourceArn in more than one entry.
target_storage_throughput instance-attribute
target_storage_throughput: int | None

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.

target_storage_type instance-attribute
target_storage_type: str | None

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.

upgrade_target_storage_config instance-attribute
upgrade_target_storage_config: bool | None

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.

Output

CreateBlueGreenDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for CreateBlueGreenDeploymentOutput structure.

Attributes

blue_green_deployment class-attribute instance-attribute
blue_green_deployment: BlueGreenDeployment | None = ...

Details about a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.