ElasticsearchService / Client / upgrade_elasticsearch_domain

upgrade_elasticsearch_domain

ElasticsearchService.Client.upgrade_elasticsearch_domain(**kwargs)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_elasticsearch_domain(
    DomainName='string',
    TargetVersion='string',
    PerformCheckOnly=True|False,
    DeploymentStrategyOptions={
        'DeploymentStrategy': 'ClonedBlueGreen',
        'ClonedBlueGreenOptions': {
            'RetentionOptions': {
                'RetentionInHours': 123,
                'RetentionAction': 'RollbackToPrimaryCluster'|'DeletePrimaryCluster'
            }
        }
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • TargetVersion (string) –

    [REQUIRED]

    The version of Elasticsearch that you intend to upgrade the domain to.

  • PerformCheckOnly (boolean) – This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

  • DeploymentStrategyOptions (dict) –

    Overrides the deployment strategy for this upgrade. To run a cloned blue/green upgrade, set DeploymentStrategy to ClonedBlueGreen.

    • DeploymentStrategy (string) – [REQUIRED]

      The deployment strategy to use for this operation. The only valid value is ClonedBlueGreen, which creates a cloned cluster on the target version next to the primary cluster so that you can validate it and shift traffic to it before you cut over.

    • ClonedBlueGreenOptions (dict) –

      Options that apply when DeploymentStrategy is ClonedBlueGreen.

      • RetentionOptions (dict) –

        How long to keep the cluster that you cut over from after cutover completes. When you start the upgrade, only RetentionInHours is accepted.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: RetentionInHours, RetentionAction.

        • RetentionInHours (integer) –

          The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

        • RetentionAction (string) –

          Ends the retention period now. Valid only after cutover completes.

Return type:

dict

Returns:

Response Syntax

{
    'DomainName': 'string',
    'TargetVersion': 'string',
    'PerformCheckOnly': True|False,
    'DeploymentStrategyOptions': {
        'DeploymentStrategy': 'ClonedBlueGreen',
        'ClonedBlueGreenOptions': {
            'RetentionOptions': {
                'RetentionInHours': 123,
                'RetentionAction': 'RollbackToPrimaryCluster'|'DeletePrimaryCluster'
            }
        }
    },
    'ChangeProgressDetails': {
        'ChangeId': 'string',
        'Message': 'string',
        'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled',
        'StartTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'InitiatedBy': 'CUSTOMER'|'SERVICE'
    }
}

Response Structure

  • (dict) –

    Container for response returned by UpgradeElasticsearchDomain operation.

    • DomainName (string) –

      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • TargetVersion (string) –

      The version of Elasticsearch that you intend to upgrade the domain to.

    • PerformCheckOnly (boolean) –

      This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

    • DeploymentStrategyOptions (dict) –

      The deployment strategy override used for the upgrade.

      • DeploymentStrategy (string) –

        The deployment strategy to use for this operation. The only valid value is ClonedBlueGreen, which creates a cloned cluster on the target version next to the primary cluster so that you can validate it and shift traffic to it before you cut over.

      • ClonedBlueGreenOptions (dict) –

        Options that apply when DeploymentStrategy is ClonedBlueGreen.

        • RetentionOptions (dict) –

          How long to keep the cluster that you cut over from after cutover completes. When you start the upgrade, only RetentionInHours is accepted.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: RetentionInHours, RetentionAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • RetentionInHours (integer) –

            The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

          • RetentionAction (string) –

            Ends the retention period now. Valid only after cutover completes.

    • ChangeProgressDetails (dict) –

      Specifies change details of the domain configuration change.

      • ChangeId (string) –

        The unique change identifier associated with a specific domain configuration change.

      • Message (string) –

        Contains an optional message associated with the domain configuration change.

      • ConfigChangeStatus (string) –

        The current status of the configuration change.

      • StartTime (datetime) –

        The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

      • LastUpdatedTime (datetime) –

        The last time that the configuration change was updated.

      • InitiatedBy (string) –

        The IAM principal who initiated the configuration change.

Exceptions