aws-cdk-lib.aws_opensearchservice.CfnDomain.ServiceSoftwareOptionsProperty

interface ServiceSoftwareOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchService.CfnDomain.ServiceSoftwareOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchservice#CfnDomain_ServiceSoftwareOptionsProperty
Javasoftware.amazon.awscdk.services.opensearchservice.CfnDomain.ServiceSoftwareOptionsProperty
Pythonaws_cdk.aws_opensearchservice.CfnDomain.ServiceSoftwareOptionsProperty
TypeScript aws-cdk-lib » aws_opensearchservice » CfnDomain » ServiceSoftwareOptionsProperty

The current status of the service software for an Amazon OpenSearch Service domain.

For more information, see Service software updates in Amazon OpenSearch Service .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';
const serviceSoftwareOptionsProperty: opensearchservice.CfnDomain.ServiceSoftwareOptionsProperty = {
  automatedUpdateDate: 'automatedUpdateDate',
  cancellable: false,
  currentVersion: 'currentVersion',
  description: 'description',
  newVersion: 'newVersion',
  optionalDeployment: false,
  updateAvailable: false,
  updateStatus: 'updateStatus',
};

Properties

NameTypeDescription
automatedUpdateDate?stringThe timestamp, in Epoch time, until which you can manually request a service software update.
cancellable?boolean | IResolvableTrue if you're able to cancel your service software version update.
currentVersion?stringThe current service software version present on the domain.
description?stringA description of the service software update status.
newVersion?stringThe new service software version, if one is available.
optionalDeployment?boolean | IResolvableTrue if a service software is never automatically updated.
updateAvailable?boolean | IResolvableTrue if you're able to update your service software version.
updateStatus?stringThe status of your service software update.

automatedUpdateDate?

Type: string (optional)

The timestamp, in Epoch time, until which you can manually request a service software update.

After this date, we automatically update your service software.


cancellable?

Type: boolean | IResolvable (optional)

True if you're able to cancel your service software version update.

False if you can't cancel your service software update.


currentVersion?

Type: string (optional)

The current service software version present on the domain.


description?

Type: string (optional)

A description of the service software update status.


newVersion?

Type: string (optional)

The new service software version, if one is available.


optionalDeployment?

Type: boolean | IResolvable (optional)

True if a service software is never automatically updated.

False if a service software is automatically updated after the automated update date.


updateAvailable?

Type: boolean | IResolvable (optional)

True if you're able to update your service software version.

False if you can't update your service software version.


updateStatus?

Type: string (optional)

The status of your service software update.