Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 . sms ]

put-app-validation-configuration

Description

Creates or updates a validation configuration for the specified application.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-app-validation-configuration
--app-id <value>
[--app-validation-configurations <value>]
[--server-group-validation-configurations <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The ID of the application.

--app-validation-configurations (list)

The configuration for application validation.

(structure)

Configuration for validating an application.

validationId -> (string)

The ID of the validation.

name -> (string)

The name of the configuration.

appValidationStrategy -> (string)

The validation strategy.

ssmValidationParameters -> (structure)

The validation parameters.

source -> (structure)

The location of the validation script.

s3Location -> (structure)

Location of an Amazon S3 object.

bucket -> (string)

The Amazon S3 bucket name.

key -> (string)

The Amazon S3 bucket key.

instanceId -> (string)

The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.

scriptType -> (string)

The type of validation script.

command -> (string)

The command to run the validation script

executionTimeoutSeconds -> (integer)

The timeout interval, in seconds.

outputS3BucketName -> (string)

The name of the S3 bucket for output.

JSON Syntax:

[
  {
    "validationId": "string",
    "name": "string",
    "appValidationStrategy": "SSM",
    "ssmValidationParameters": {
      "source": {
        "s3Location": {
          "bucket": "string",
          "key": "string"
        }
      },
      "instanceId": "string",
      "scriptType": "SHELL_SCRIPT"|"POWERSHELL_SCRIPT",
      "command": "string",
      "executionTimeoutSeconds": integer,
      "outputS3BucketName": "string"
    }
  }
  ...
]

--server-group-validation-configurations (list)

The configuration for instance validation.

(structure)

Configuration for validating an instance.

serverGroupId -> (string)

The ID of the server group.

serverValidationConfigurations -> (list)

The validation configuration.

(structure)

Configuration for validating an instance.

server -> (structure)

Represents a server.

serverId -> (string)

The ID of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

The VM server location.

vmManagerId -> (string)

The ID of the VM manager.

vmId -> (string)

The ID of the VM.

vmName -> (string)

The name of the VM.

vmManagerName -> (string)

The name of the VM manager.

vmManagerType -> (string)

The type of VM management product.

vmPath -> (string)

The VM folder path in the vCenter Server virtual machine inventory tree.

replicationJobId -> (string)

The ID of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

validationId -> (string)

The ID of the validation.

name -> (string)

The name of the configuration.

serverValidationStrategy -> (string)

The validation strategy.

userDataValidationParameters -> (structure)

The validation parameters.

source -> (structure)

The location of the validation script.

s3Location -> (structure)

Location of an Amazon S3 object.

bucket -> (string)

The Amazon S3 bucket name.

key -> (string)

The Amazon S3 bucket key.

scriptType -> (string)

The type of validation script.

JSON Syntax:

[
  {
    "serverGroupId": "string",
    "serverValidationConfigurations": [
      {
        "server": {
          "serverId": "string",
          "serverType": "VIRTUAL_MACHINE",
          "vmServer": {
            "vmServerAddress": {
              "vmManagerId": "string",
              "vmId": "string"
            },
            "vmName": "string",
            "vmManagerName": "string",
            "vmManagerType": "VSPHERE"|"SCVMM"|"HYPERV-MANAGER",
            "vmPath": "string"
          },
          "replicationJobId": "string",
          "replicationJobTerminated": true|false
        },
        "validationId": "string",
        "name": "string",
        "serverValidationStrategy": "USERDATA",
        "userDataValidationParameters": {
          "source": {
            "s3Location": {
              "bucket": "string",
              "key": "string"
            }
          },
          "scriptType": "SHELL_SCRIPT"|"POWERSHELL_SCRIPT"
        }
      }
      ...
    ]
  }
  ...
]

--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.

See 'aws help' for descriptions of global parameters.

Output

None