Skip to content

(aws-opensearchservice): add useLatestServiceSoftwareForBlueGreen to Domain construct #38664

Description

@Swathi-Karanth

Describe the feature

Amazon OpenSearch Service supports UseLatestServiceSoftwareForBlueGreen in the SoftwareUpdateOptions of AWS::OpenSearchService::Domain. This feature request adds that property to the L2 Domain construct so users can enable it directly, alongside the existing enableAutoSoftwareUpdate property.

Use Case

When enabled, the domain automatically uses the latest available service software during a blue/green deployment, rather than the currently pinned service software version. The property is already available in CloudFormation (AWS::OpenSearchService::DomainSoftwareUpdateOptions.UseLatestServiceSoftwareForBlueGreen), but is not exposed by the CDK L2 Domain construct. Today users must fall back to an escape hatch (addPropertyOverride) to set it.

Proposed Solution

Add an optional useLatestServiceSoftwareForBlueGreen boolean to DomainProps, wired through to the L1 SoftwareUpdateOptions.useLatestServiceSoftwareForBlueGreen. The softwareUpdateOptions block is rendered when either enableAutoSoftwareUpdate or useLatestServiceSoftwareForBlueGreen is specified. The property is optional and defaults to off, so existing behavior is unchanged.

Other Information

Implementation is in progress in PR #38499 (currently in Draft — build is blocked on the L1 property not yet being available in @aws-cdk/aws-service-spec; the CloudFormation schema is public but has not yet been ingested).

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

AWS CDK Library version (aws-cdk-lib)

2.266.0

AWS CDK CLI version

2.1131.0

Environment details (OS name and version, etc.)

macOS 26.5.2 (arm64), Node.js v20.20.2

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-cloudformationRelated to AWS CloudFormation@aws-cdk/aws-opensearchRelated to the @aws-cdk/aws-opensearchservice packagefeature-requestA feature should be added or improved.needs-triageThis issue or PR still needs to be triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions