Class: Aws::RDS::Types::CreateBlueGreenDeploymentRequest

Inherits:

Struct

Object
Struct
Aws::RDS::Types::CreateBlueGreenDeploymentRequest

show all

Defined in:: gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#blue_green_deployment_name ⇒ String
The name of the blue/green deployment.
#source ⇒ String
The Amazon Resource Name (ARN) of the source production database.
#tags ⇒ Array<Types::Tag>
Tags to assign to the blue/green deployment.
#target_allocated_storage ⇒ Integer
The amount of storage in gibibytes (GiB) to allocate for the green DB instance.
#target_db_cluster_parameter_group_name ⇒ String
The DB cluster parameter group associated with the Aurora DB cluster in the green environment.
#target_db_instance_class ⇒ String
Specify the DB instance class for the databases in the green environment.
#target_db_parameter_group_name ⇒ String
The DB parameter group associated with the DB instance in the green environment.
#target_engine_version ⇒ String
The engine version of the database in the green environment.
#target_iops ⇒ Integer
The amount of Provisioned IOPS (input/output operations per second) to allocate for the green DB instance.
#target_resource_configurations ⇒ Array<Types::TargetResourceConfiguration>
Specifies resource-level configuration overrides for the green environment.
#target_storage_throughput ⇒ Integer
The storage throughput value for the green DB instance.
#target_storage_type ⇒ String
The storage type to associate with the green DB instance.
#upgrade_target_storage_config ⇒ Boolean
Whether to upgrade the storage file system configuration on the green database.

Instance Attribute Details

#blue_green_deployment_name ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Tags to assign to the blue/green deployment.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_allocated_storage ⇒ `Integer`

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:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_cluster_parameter_group_name ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_instance_class ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_parameter_group_name ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_engine_version ⇒ `String`

The engine version of the database in the green environment.

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

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_iops ⇒ `Integer`

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:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_resource_configurations ⇒ `Array<Types::TargetResourceConfiguration>`

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.

Returns:

(Array<Types::TargetResourceConfiguration>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_storage_throughput ⇒ `Integer`

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:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#target_storage_type ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_target_storage_config ⇒ `Boolean`

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:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 2264

class CreateBlueGreenDeploymentRequest < Struct.new(
  :blue_green_deployment_name,
  :source,
  :target_engine_version,
  :target_db_parameter_group_name,
  :target_db_cluster_parameter_group_name,
  :tags,
  :target_db_instance_class,
  :upgrade_target_storage_config,
  :target_iops,
  :target_storage_type,
  :target_allocated_storage,
  :target_storage_throughput,
  :target_resource_configurations)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::CreateBlueGreenDeploymentRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#blue_green_deployment_name ⇒ String

#source ⇒ String

#tags ⇒ Array<Types::Tag>

#target_allocated_storage ⇒ Integer

#target_db_cluster_parameter_group_name ⇒ String

#target_db_instance_class ⇒ String

#target_db_parameter_group_name ⇒ String

#target_engine_version ⇒ String

#target_iops ⇒ Integer

#target_resource_configurations ⇒ Array<Types::TargetResourceConfiguration>

#target_storage_throughput ⇒ Integer

#target_storage_type ⇒ String

#upgrade_target_storage_config ⇒ Boolean

#blue_green_deployment_name ⇒ `String`

#source ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#target_allocated_storage ⇒ `Integer`

#target_db_cluster_parameter_group_name ⇒ `String`

#target_db_instance_class ⇒ `String`

#target_db_parameter_group_name ⇒ `String`

#target_engine_version ⇒ `String`

#target_iops ⇒ `Integer`

#target_resource_configurations ⇒ `Array<Types::TargetResourceConfiguration>`

#target_storage_throughput ⇒ `Integer`

#target_storage_type ⇒ `String`

#upgrade_target_storage_config ⇒ `Boolean`