Skip to content

Describe Blue Green Deployments

rds_describe_blue_green_deployments R Documentation

Describes one or more blue/green deployments

Description

Describes one or more blue/green deployments.

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.

Usage

rds_describe_blue_green_deployments(BlueGreenDeploymentIdentifier,
  Filters, Marker, MaxRecords)

Arguments

BlueGreenDeploymentIdentifier

The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.

Constraints:

  • Must match an existing blue/green deployment identifier.

Filters

A filter that specifies one or more blue/green deployments to describe.

Valid Values:

  • blue-green-deployment-identifier - Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.

  • blue-green-deployment-name - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.

  • source - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.

  • target - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.

Marker

An optional pagination token provided by a previous describe_blue_green_deployments request. If you specify this parameter, the response only includes records beyond the marker, up to the value specified by MaxRecords.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints:

  • Must be a minimum of 20.

  • Can't exceed 100.

Value

A list with the following syntax: 

list(
  BlueGreenDeployments = list(
    list(
      BlueGreenDeploymentIdentifier = "string",
      BlueGreenDeploymentName = "string",
      Source = "string",
      Target = "string",
      SwitchoverDetails = list(
        list(
          SourceMember = "string",
          TargetMember = "string",
          Status = "string"
        )
      ),
      Tasks = list(
        list(
          Name = "string",
          Status = "string"
        )
      ),
      Status = "string",
      StatusDetails = "string",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      DeleteTime = as.POSIXct(
        "2015-01-01"
      ),
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_blue_green_deployments(
  BlueGreenDeploymentIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)