Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-sap ]

update-application-settings

Description

Updates the settings of an application registered with AWS Systems Manager for SAP.

See also: AWS API Documentation

Synopsis

  update-application-settings
--application-id <value>
[--credentials-to-add-or-update <value>]
[--credentials-to-remove <value>]
[--backint <value>]
[--database-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--application-id (string)

The ID of the application.

--credentials-to-add-or-update (list)

The credentials to be added or updated.

(structure)

The credentials of your SAP application.

DatabaseName -> (string)

The name of the SAP HANA database.

CredentialType -> (string)

The type of the application credentials.

SecretId -> (string)

The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

Shorthand Syntax:

DatabaseName=string,CredentialType=string,SecretId=string ...

JSON Syntax:

[
  {
    "DatabaseName": "string",
    "CredentialType": "ADMIN",
    "SecretId": "string"
  }
  ...
]

--credentials-to-remove (list)

The credentials to be removed.

(structure)

The credentials of your SAP application.

DatabaseName -> (string)

The name of the SAP HANA database.

CredentialType -> (string)

The type of the application credentials.

SecretId -> (string)

The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

Shorthand Syntax:

DatabaseName=string,CredentialType=string,SecretId=string ...

JSON Syntax:

[
  {
    "DatabaseName": "string",
    "CredentialType": "ADMIN",
    "SecretId": "string"
  }
  ...
]

--backint (structure)

Installation of AWS Backint Agent for SAP HANA.

BackintMode -> (string)

AWS service for your database backup.

EnsureNoBackupInProcess -> (boolean)

Shorthand Syntax:

BackintMode=string,EnsureNoBackupInProcess=boolean

JSON Syntax:

{
  "BackintMode": "AWSBackup",
  "EnsureNoBackupInProcess": true|false
}

--database-arn (string)

The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Message -> (string)

The update message.

OperationIds -> (list)

The IDs of the operations.

(string)