Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.ServiceSoftwareOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.ServiceSoftwareOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.ServiceSoftwareOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.opensearchservice.*;
 ServiceSoftwareOptionsProperty serviceSoftwareOptionsProperty = ServiceSoftwareOptionsProperty.builder()
         .automatedUpdateDate("automatedUpdateDate")
         .cancellable(false)
         .currentVersion("currentVersion")
         .description("description")
         .newVersion("newVersion")
         .optionalDeployment(false)
         .updateAvailable(false)
         .updateStatus("updateStatus")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.ServiceSoftwareOptionsProperty.Builder	A builder for CfnDomain.ServiceSoftwareOptionsProperty
static final class	CfnDomain.ServiceSoftwareOptionsProperty.Jsii$Proxy	An implementation for CfnDomain.ServiceSoftwareOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.ServiceSoftwareOptionsProperty.Builder	builder()
default String	getAutomatedUpdateDate()	The timestamp, in Epoch time, until which you can manually request a service software update.
default Object	getCancellable()	True if you're able to cancel your service software version update.
default String	getCurrentVersion()	The current service software version present on the domain.
default String	getDescription()	A description of the service software update status.
default String	getNewVersion()	The new service software version, if one is available.
default Object	getOptionalDeployment()	True if a service software is never automatically updated.
default Object	getUpdateAvailable()	True if you're able to update your service software version.
default String	getUpdateStatus()	The status of your service software update.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutomatedUpdateDate

@Stability(Stable)
@Nullable
default String getAutomatedUpdateDate()

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

After this date, we automatically update your service software.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-automatedupdatedate

getCancellable

@Stability(Stable)
@Nullable
default Object getCancellable()

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

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-cancellable

getCurrentVersion

@Stability(Stable)
@Nullable
default String getCurrentVersion()

The current service software version present on the domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-currentversion

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the service software update status.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-description

getNewVersion

@Stability(Stable)
@Nullable
default String getNewVersion()

The new service software version, if one is available.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-newversion

getOptionalDeployment

@Stability(Stable)
@Nullable
default Object getOptionalDeployment()

True if a service software is never automatically updated.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-optionaldeployment

getUpdateAvailable

@Stability(Stable)
@Nullable
default Object getUpdateAvailable()

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

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updateavailable

getUpdateStatus

@Stability(Stable)
@Nullable
default String getUpdateStatus()

The status of your service software update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-servicesoftwareoptions.html#cfn-opensearchservice-domain-servicesoftwareoptions-updatestatus

builder

@Stability(Stable)
static CfnDomain.ServiceSoftwareOptionsProperty.Builder builder()

Returns:

a CfnDomain.ServiceSoftwareOptionsProperty.Builder of CfnDomain.ServiceSoftwareOptionsProperty